Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Account

List account

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

get/api/v2/accounts

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:2026-01-01T00:00:00.000Z&jon@doe.com

Pagination cursor from next_starting_after, in timestamp_created&email format. Legacy ISO date-time cursor is still supported.

searchstring
Example:gmail.com
status1 | 2 | 3 | -1 | -2 | -3
Example:1
provider_code1 | 2 | 3 | 4 | 8
Example:2
tag_idsstring
Example:019f94cd-ad92-717d-9823-e31ec1254475, 019f94cd-ad92-717d-9823-e31f5253b981

Filter accounts by tag ids. Returns accounts that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma.

tag_ids_allstring
Example:019f94cd-ad92-717d-9823-e320d65d05b7, 019f94cd-ad92-717d-9823-e321d413f9ce

Filter accounts by tag ids with AND logic. Returns only accounts that have all of the specified tags assigned. You can specify multiple tag ids by separating them with a comma.

include_tagsboolean
Example:true

Include tags in the response. If true, the response will include the tags assigned to each account.

filter'ACC_FILTER_PAUSED' | 'ACC_FILTER_ERROR' | 'ACC_FILTER_NO_CTD' | 'ACC_FILTER_PW_ACCOUNTS' | 'ACC_FILTER_DFY' | 'ACC_FILTER_DFY_SETUP_PENDING' | 'ACC_FILTER_W_ACTIVE' | 'ACC_FILTER_W_PAUSED' | 'ACC_FILTER_W_ERROR'
Example:ACC_FILTER_PAUSED

The filter to apply to the accounts.

sort_by'timestamp_created' | 'email' | 'stat_warmup_score' | 'status'
Example:stat_warmup_score

Column to sort results by.

sort_order'asc' | 'desc'
Example:desc

Sort direction. Defaults to desc when sort_by is provided.

skipinteger

Number of items to skip for offset-based pagination. Used with sort_by when cursor pagination is not available.

Response

The list of Account

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "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",
      "tags": [
        {
          "id": "019f94cd-ad92-717d-9823-e32236aa4c1a",
          "label": "Important tag"
        }
      ]
    }
  ],
  "next_starting_after": "019f94cd-ad92-717d-9823-e323197dd07e"
}
All 171 operations