Get Mailbox

GET

/mailboxes/mailbox

Returns full details for a single mailbox, including warmup enrollment status.

warmupDetails is null when the mailbox is not enrolled in warmup.

Warmup not enrolled

{ "warmupDetails": null }

Warmup enrolled

{
  "warmupDetails": {
    "isWarmup": true,
    "warmupStatus": "ACTIVE"
  }
}

Possible warmupStatus values: ACTIVE, PAUSED, STOPPED.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Responses

🟢200Success

application/json

Mailbox fetched successfully

Bodyapplication/json

🟠422Unprocessable Entity

🟠403Forbidden

🟠404Not Found

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/mailbox?mailboxId=GP6M2J2DHXM3F2J40S8AP316R2QR' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Mailbox fetched successfully",
    "data": {
        "id": "GP6M2J2DHXM3F2J40S8AP316R2QR",
        "firstName": "Alice",
        "lastName": "Johnson",
        "profilePicture": "https://cdn.example.com/avatar.jpg",
        "email": "alice@acmecorp.com",
        "username": "alice",
        "domain": "acmecorp.com",
        "password": "********",
        "isAdmin": false,
        "appPassword": "********",
        "authenticatorSecret": "JBSWY3DPEHPK3PXP",
        "expireOn": "2025-12-31",
        "warmupDetails": null
    }
}

Modified at 2026-08-06 06:20:56

Get Mailboxes by User

Get Admin Mailbox Details

Get Mailbox

Warmup not enrolled#

Warmup enrolled#

Request

Responses

Warmup not enrolled

Warmup enrolled