Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Account

Get account

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

get/api/v2/accounts/{email}

Path parameters

emailstring required
Example:jon@doe.com

The email of the account to get

Response

The requested Account

emailstring email required

Email address of the account

timestamp_createdstring date-time required

Timestamp when the account was created

timestamp_updatedstring date-time required

Timestamp when the account was last updated

first_namestring required

First name associated with the account

last_namestring required

Last name associated with the account

added_bystring uuid nullable

User ID who added the account

daily_limitnumber nullable

Daily email sending limit

daily_limit_maxnumber nullable

Maximum daily email sending limit for AirMail accounts

warmup_limit_maxnumber nullable

Maximum daily warmup sending limit for AirMail accounts

modified_bystring uuid nullable

User ID who last modified the account

tracking_domain_namestring nullable

Tracking domain

tracking_domain_statusstring nullable

Tracking domain status

status1 | 2 | 3 | -1 | -2 | -3

Current status of the account

enable_slow_rampboolean nullable

Whether to enable slow ramp up for sending limits

inbox_placement_test_limitnumber nullable

The limit for inbox placement tests

organizationstring uuid required

Organization ID that owns this account

warmup_status0 | 1 | -1 | -2 | -3 required

Current warmup status of the account

timestamp_warmup_startstring date-time nullable

Timestamp when warmup was started

provider_code1 | 2 | 3 | 4 | 8 required

Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work.

setup_pendingboolean required

Whether account setup is pending

is_managed_accountboolean required

Whether this is a managed account

stat_warmup_scorenumber nullable

Warmup score for the account

sending_gapnumber

The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns)

signaturestring nullable

Email signature for the account

reply_tostring email nullable

Custom reply-to email address for the account

autofix_failedboolean nullable

Whether automatic reconnection attempts have failed. null = in progress, true = failed, false = succeeded.

Example response

{
  "email": "user@example.com",
  "timestamp_created": "2026-07-24T15:45:24.434Z",
  "timestamp_updated": "2026-07-24T15:45:24.434Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": {
      "open_rate": 0.95,
      "important_rate": 0.8,
      "read_emulation": true,
      "spam_save_rate": 0.02,
      "weekday_only": true
    },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "019f94cd-83d2-70cb-85f9-63647d70239b",
  "daily_limit": 100,
  "daily_limit_max": 100,
  "warmup_limit_max": 100,
  "modified_by": "019f94cd-83d2-70cb-85f9-63659978e4d2",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "inbox_placement_test_limit": 10,
  "organization": "019f94cd-83d2-70cb-85f9-63668b327b01",
  "warmup_status": 1,
  "status_message": {
    "code": "EENVELOPE",
    "command": "DATA",
    "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai",
    "e_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded",
    "responseCode": 550
  },
  "timestamp_warmup_start": "2026-07-24T15:45:24.434Z",
  "provider_code": 2,
  "stat_warmup_score": 85,
  "sending_gap": 10,
  "signature": "Best regards, John Doe",
  "reply_to": "reply@example.com"
}