1. Users
  • 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
      • Get User
        GET
      • Create User
        POST
      • Update User
        PUT
      • Delete User
        DELETE
    • 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 Mailboxes by User
      • Get Mailbox
      • Get Admin Mailbox Details
      • Update Mailbox Details
      • Delete Mailbox
    • 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. Users

Get User

GET
/users
Returns the profile and billing details for the authenticated user.
This endpoint resolves the user from the API key — it returns the partner-level user details including address, billing records, and language preference.

Request

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

Responses

🟢200Success
application/json
User details fetched successfully
Bodyapplication/json

🟠401Unauthorized
🟠400Bad Request
🟠404Not Found
🟠401Unauthorized - Workspace Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://customers.coldmailreseller.com/api/v1/integration/users?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "status": 200,
    "message": "User details fetched successfully",
    "data": {
        "id": "H8M9JV2S9HMPYFQW393AZHQVD4XM",
        "firstName": "Alice",
        "lastName": "Johnson",
        "email": "alice@company.com",
        "initialSetupState": "DOMAIN_PURCHASE",
        "avatarUrl": null,
        "source": "WEB_COMPONENT",
        "serviceProvider": "GOOGLE",
        "serviceProviderEnabled": "GOOGLE",
        "partnerMailboxPrice": 1.5,
        "billingRecords": {
            "firstName": "Alice",
            "lastName": "Johnson",
            "company": "Acme Corp",
            "addressLineOne": "123 Main Street",
            "addressLineTwo": null,
            "addressLineThree": null,
            "city": "New York",
            "state": "New York",
            "country": "US",
            "postalCode": "10001",
            "phoneCc": "1",
            "phone": "2125551234",
            "languagePreference": "en",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    }
}
Modified at 2026-08-06 06:20:56
Previous
List Users
Next
Create User
Built with