Skip to main content
GET
List all accounts

Authorizations

Authorization
string
header
required

Scopes

accounts:read:any

Query Parameters

limit
integer
default:100

The maximum number of results to return.

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

200

offset
integer
default:0

The number of items to skip before returning results.

Required range: x >= 0
Example:

100

primaryEmailAddress
string<email>
Example:

"test@example.com"

include
enum<string>

Optional embeds to include when returning accounts

Available options:
market
Example:

"market"

favourites
enum<string>

People only (signed in to the app or with a person API key); product API keys sending it get 400 (staff cannot call this route). first lists the person's favourite accounts ahead of the rest; only returns just their favourites. Search still applies. Omit for account-id order.

Available options:
first,
only
Example:

"first"

Response

OK

count
integer
required

The total amount of records matching the querying when "limit" is ignored.

Example:

67

rows
object[]
required
limit
integer
default:100

The maximum number of results to return.

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

200

offset
integer
default:0

The number of items to skip before returning results.

Required range: x >= 0
Example:

100