Skip to main content
GET
Get list of existing accounts

Authorizations

x-api-key
string
header
required

Response

List of users

id
string

The account ID (uuid).

Example:

"57ed834f-f6f6-47d4-ab23-5674d7866b32"

username
string

The account username.

Example:

"johndoe@reseller.com"

password
string

The account password.

Example:

"secret"

status
string

The account status (credentials enabled/disabled).

Example:

"enabled"

limit_reached
boolean

The account limit reached status.

Example:

false

started_at
integer

The time in unix seconds at which the account was started.

Example:

1708526022

updated_at
integer

The time in unix seconds at which the account was updated.

Example:

1708528022

limit
integer

The allocated traffic in bytes.

Example:

1000000

used_bytes
integer

Cumulative (lifetime) traffic used by the account, in bytes. This is the figure the account allowance is enforced against, so compare it directly with limit (see also limit_reached). Updated periodically from aggregated usage data, so it is near-real-time rather than instantaneous.

Because this field is returned for every subaccount by GET /accounts, a single call to that endpoint gives you usage for all of your subaccounts at once. Prefer it over calling GET /accounts/{id}/usage once per subaccount.

Example:

524288000

domains_blocklist
string[]

List of domains blocked for this account.

Example:
sync_with_parent
boolean

If true, synchronize the new account's domains blocklist with the parent account. The sub-account can still have its own blocklist entries, which are merged with the parent's.

Example:

false

proxy_access
boolean

Whether the account currently has proxy access. Reflects the actual proxy status from the network layer, which may differ from account status if access was not revoked by user (e.g. usage limit reached).

Example:

true