1. Mailboxes
  • Welcome to the Cold Mail Reseller API
  • Get Started
    • Overview
    • Authentication
    • Quick Start
  • Core Concepts
    • Users
    • Domains
    • DNS Management
    • Mailboxes
    • Subscriptions
    • Pre-Warmup
    • Domain Renewal
    • 1+ Year Subscriptions
    • Mailbox Warmup
    • Platform Exports
    • OAuth Exports
    • Sandbox API
  • 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 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
      • Set Warmup Status
      • Disable Warmup
    • 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
        • Add Platform Credential
        • Export Mailboxes to Platform
        • 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
      • Domain Events
      • Mailbox Events
      • Subscription Events
      • Prewarmup Events
      • Mailbox Warmup Events
  • Schemas
    • Error
    • Success
    • MessageResponse
    • User
    • Domain
    • ErrorResponse
    • Mailbox
    • Subscription
    • DnsRecord
    • Error Response
    • Pagination Meta
    • Action Error Response
    • PrewarmupOrderResult
    • OrderCreationResult
  1. Mailboxes

Get Mailboxes by User

GET
/mailboxes/single
Returns a paginated list of mailboxes for a specific user, with optional search and provider filtering.
The response includes full user details alongside the mailbox list.

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 details fetched successfully
Bodyapplication/json

🟠400Bad Request
🟠404Not Found
🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/single?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM&search=alice&serviceProvider=undefined&page=1&limit=20' \
--header 'cmr-x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "status": 200,
    "message": "Mailbox details fetched successfully",
    "data": {
        "user": {
            "id": "H8M9JV2S9HMPYFQW393AZHQVD4XM",
            "partnerId": "b3f1c2d4-1234-4a5b-8c9d-0e1f2a3b4c5d",
            "rcId": 10234,
            "firstName": "Alice",
            "lastName": "Johnson",
            "email": "alice@company.com",
            "password": "$2b$10$...",
            "isVerified": true,
            "stripeCustomerId": "cus_ABC123",
            "freeDomains": 0,
            "initialSetupPending": false,
            "initialSetupState": "DOMAIN_PURCHASE",
            "apiKey": "e2f1a2b3-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
            "apiKeyEnabled": false,
            "dnsManagerCredentialsId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
            "source": "WEB_COMPONENT",
            "avatarUrl": "https://cdn.example.com/avatar.jpg",
            "forwardingIp": "203.0.113.10",
            "otp": "482913",
            "otpExpiresAt": "2025-12-31T00:00:00.000Z",
            "createdAt": "2025-01-15T10:00:00.000Z",
            "updatedAt": "2025-06-01T10:00:00.000Z",
            "deletedAt": null
        },
        "mailboxes": [
            {
                "id": "GP6M2J2DHXM3F2J40S8AP316R2QR",
                "firstName": "Alice",
                "lastName": "Johnson",
                "profilePicture": "https://cdn.example.com/avatar.jpg",
                "username": "alice",
                "email": "alice@acmecorp.com",
                "domain": "acmecorp.com",
                "password": "********",
                "isAdmin": false,
                "appPassword": "********",
                "authenticatorSecret": "JBSWY3DPEHPK3PXP",
                "serviceProvider": "GOOGLE",
                "expireOn": "2025-12-31"
            }
        ],
        "pagination": {
            "totalSearchedCount": 42,
            "currentPage": 1,
            "nextPage": 2,
            "totalPages": 3
        }
    }
}
Modified at 2026-08-06 06:20:56
Previous
List Mailboxes
Next
Get Mailbox
Built with