List Mailboxes

GET

/mailboxes

Returns a paginated list of all mailboxes across all users under your partner account.

Each entry in data.users contains the user's contact details and their list of mailboxes. Each mailbox includes id (the mailbox identifier used across other endpoints, e.g. GET /mailboxes/mailbox?mailboxId=), domainId (the UUID of the domain the mailbox belongs to), and status (the mailbox's current lifecycle state).

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Responses

🟢200Success

application/json

Mailboxes fetched successfully

Bodyapplication/json

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes?page=1&limit=20' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Mailboxes fetched successfully",
    "data": {
        "users": [
            {
                "firstName": "Alice",
                "lastName": "Johnson",
                "email": "alice@company.com",
                "mailboxes": [
                    {
                        "id": "NHY5YJ17HFM793JY7QWY0M32Q3KX",
                        "domainId": "a3d8f083-2671-49c4-92d1-1ed6dc823a7a",
                        "status": "ACTIVE",
                        "firstName": "Alice",
                        "lastName": "Johnson",
                        "username": "alice",
                        "domain": "acmecorp.com",
                        "password": "********",
                        "appPassword": "********",
                        "serviceProvider": "GOOGLE",
                        "expireOn": "2025-12-31"
                    }
                ]
            }
        ],
        "pagination": {
            "totalSearchedCount": 42,
            "currentPage": 1,
            "nextPage": 2,
            "totalPages": 3
        }
    }
}

Modified at 2026-09-25 09:30:25

Delete DNS Record

Get Mailboxes by User