Retrieve Mailboxes

GET

/v1/mailboxes

Fetch all mailboxes owned by the authenticated user. Pass ?email=john@b2bforcelabs.com to look up a single mailbox directly by its email address. Supports pagination and optional username filtering.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/mailboxes?email=undefined&contains=undefined&page=undefined&limit=undefined' \
--header 'x-api-key: <api-key>'

Responses

🟢200

application/json

Success - Mailboxes retrieved successfully

Bodyapplication/json

Example

{
    "status": 200,
    "message": "Mailboxes fetched successfully",
    "data": {
        "userId": "cmg9jatbj0000jv04cejuz12b",
        "email": "baigt0449@gmail.com",
        "totalMailboxes": 6,
        "totalSearchedCount": 6,
        "currentPage": 1,
        "nextPage": 2,
        "totalPages": 3,
        "mailboxes": [
            {
                "id": "cmg9l78m8000bla04a6onx0ih",
                "username": "Mary",
                "fullName": "Mary",
                "status": "PENDING",
                "createdAt": "2025-10-02T15:45:32.768Z"
            }
        ]
    }
}

🟠401

🔴500

Get Domain Purchase Payment Link

Assign New Mailbox to Domain