1. Mailboxes
  • Welcome to the Cold Mail Reseller API
  • Get Started
    • Overview
    • Authentication
    • Quick Start
  • Core Concepts
    • Users
    • Domains
    • DNS Management
    • Subscriptions
    • Pre-Warmup
    • Domain Renewal
    • Mailbox Warmup
    • OAuth Exports
    • Platform Exports
    • Mailboxes
    • Sandbox API
    • 1+ Year Subscriptions
  • API Reference
    • Users
      • List Users
      • Get User
      • Create User
      • Update User
      • Delete User
    • Geo
      • List Countries
      • List States
    • Domains
      • Domain Renewal
        • Get Domain Renewal Prices
        • Renew Domains
        • Toggle Domain Auto-Renew
      • Get Domain
      • List Available Aged Domains
      • Order Aged Domains
      • Get Domains by User
      • Check Domain Availability
      • Check Single Domain Availability
      • Check Workspace Existence
      • Set Domain Forwarding
      • Set Email Forwarding
      • Delete Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Update DNS Record
      • Update Nameservers
      • Delete DNS Record
    • Mailboxes
      • List Mailboxes
        GET
      • Get Mailboxes by User
        GET
      • Get Mailbox
        GET
      • Get Admin Mailbox Details
        GET
      • Update Mailbox Details
        PATCH
      • Delete Mailbox
        DELETE
    • Mailbox Warmup
      • Add Warmup to Mailbox
      • Toggle Warmup
      • Update Warmup Settings
      • Delete Warmup Subscription
    • Orders
      • Get Order Status
      • Get Order Details
      • Create Order
      • Create Order (JSON)
      • Create Mailbox Order (JSON)
      • Process Order
    • Subscriptions
      • 1+ Year Subscription
        • Recreate Subscription
      • Get Subscriptions
      • Renew Subscriptions
      • Cancel Subscription
      • Toggle Auto-Renewal
    • Exports
      • Platform Exports
        • Get Platform Credentials
        • Get Platform Workspaces
        • Add Platform Credential
        • Export Mailboxes to Platform
        • Update Platform Credential
        • Remove Platform Credential
      • OAuth Exports
        • Perform OAuth
        • Add Client ID to Domains
    • Pre-Warmup
      • Sandbox
        • Get Sandbox Pre-warmup Domains
        • Order Sandbox Pre-warmup
        • Reset Sandbox Pre-warmup
      • Get Pre-warmup Domains
      • Order Pre-warmup
    • Placement Test
      • Create Placement Order
      • Get Placement Reports
  • Resources
    • Errors
    • Rate Limits
    • Pagination
    • Sandbox
    • MCP
  • Webhooks
    • Overview
    • Events
      • DNS Events
      • Subscription Events
      • Prewarmup Events
      • Mailbox Warmup Events
      • Mailbox Events
      • Domain Events
  • Schemas
    • Error
    • Success
    • MessageResponse
    • User
    • Domain
    • ErrorResponse
    • Mailbox
    • Subscription
    • DnsRecord
    • Error Response
    • Pagination Meta
    • Action Error Response
    • PrewarmupOrderResult
    • OrderCreationResult
  1. Mailboxes

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.
warmupEmailSentCount, landedOnSpamCount, landedOnInboxCount, and healthScore are present inside warmupDetails only when the mailbox has a linked warmup account.

Warmup not enrolled#

{
  "warmupDetails": null
}

Warmup enrolled#

{
  "warmupDetails": {
    "isWarmup": true,
    "warmupStatus": "ACTIVE",
    "warmupLimit": 20,
    "minimumWarmupLimit": 2,
    "increasePerDay": 2,
    "warmupReplyRate": 35,
    "warmupOpenRate": 100,
    "warmupSpamProtectionRate": 100,
    "warmupMarkAsImportantRate": 100,
    "warmupOnWeekdays": true,
    "warmupDisableSlow": false,
    "warmupReadEmulation": true,
    "moveWarmupEmails": true,
    "warmupDestinationFolder": "Business Conversations",
    "warmupIndustry": "Customer Relationship Management",
    "warmupFilterTag": "Smart-Hare",
    "minimumDelayBetweenWarmupEmails": null,
    "maximumDelayBetweenWarmupEmails": null,
    "maxThreadCount": 2,
    "warmupEmailSentCount": 6,
    "landedOnSpamCount": 0,
    "landedOnInboxCount": 5,
    "healthScore": "83.33"
  }
}
Possible warmupStatus values: ACTIVE, PAUSED, STOPPED.

Request

Authorization
API Key
Add parameter in header
cmr-x-api-key
Example:
cmr-x-api-key: ********************
or
Query Params

Responses

🟢200Success
application/json
Mailbox fetched successfully
Bodyapplication/json

🟠422Unprocessable Entity
🟠403Forbidden
🟠404Not Found
🟠401Unauthorized
Request 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 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-09-10 05:36:40
Previous
Get Mailboxes by User
Next
Get Admin Mailbox Details
Built with