Skip to main content
GET
List accounts

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

expand
string | null

A comma-separated list of additional fields to expand. Supported values: connector (the connector display data), connector_profile (the connector profile id and label), last_request, and actions (the connector action catalog, each flagged with whether it is enabled for this account's connector profile). These are omitted (returned as null) unless requested, as resolving them is more expensive.

Example:

"connector,connector_profile,last_request,actions"

page
number | null

The 1-based page number to fetch. Omit both page and page_size to fetch all accounts at once.

Required range: x >= 1
page_size
number | null
default:25

The number of accounts to return per page.

Required range: 1 <= x <= 100
account_id
string[] | null

Filter to accounts with any of these account ids. Comma-separated or repeated (e.g. ?account_id=a,b).

connector_key
string[] | null

Filter to accounts with any of these connector keys (comma-separated or repeated).

status
enum<string>[]

Filter to accounts with any of these statuses (comma-separated or repeated).

Available options:
active,
inactive,
suspended,
archived,
expired,
error,
unmapped_value,
null
owner_id
string[] | null

Filter to accounts with any of these owner ids (comma-separated or repeated).

capability
enum<string>

Filter to accounts you can perform this action on, rather than merely read. Single value — "must be able to do X" is one requirement, not a choice. Has no effect on requests without per-user account context (e.g. API keys).

Available options:
read,
execute-actions,
update,
delete,
relink,
manage-members,
unmapped_value,
null

Response

The accounts were retrieved.

page
number
required

The current page number.

page_size
number
required

The number of accounts per page.

total
number
required

The total number of accounts matching the request.

data
object[]
required

The accounts on this page.