Skip to main content
GET
List account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

The number of items to return

Required range: 1 <= x <= 100
Example:

10

starting_after
string

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

Example:

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

Example:

"gmail.com"

status
enum<number>
Available options:
1,
2,
3,
-1,
-2,
-3
Example:

1

provider_code
enum<number>
Available options:
1,
2,
3,
4,
8
Example:

2

tag_ids
string

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.

Example:

"019f985c-9224-7a09-a7b4-db79754c00ee, 019f985c-9224-7a09-a7b4-db7aa71678ef"

tag_ids_all
string

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.

Example:

"019f985c-9224-7a09-a7b4-db7b8e018d79, 019f985c-9224-7a09-a7b4-db7ccbc62483"

include_tags
boolean

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

Example:

true

filter
enum<string>

The filter to apply to the accounts.

Available options:
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"

sort_by
enum<string>

Column to sort results by.

Available options:
timestamp_created,
email,
stat_warmup_score,
status
Example:

"stat_warmup_score"

sort_order
enum<string>

Sort direction. Defaults to desc when sort_by is provided.

Available options:
asc,
desc
Example:

"desc"

skip
integer

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

Required range: x >= 0
Example:

0

Response

The list of Account

items
Account · object[]
required

The list of Account

next_starting_after
string

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:

"019f985c-9224-7a09-a7b4-db7ee2bc4a46"