Skip to main content
GET
List accounts

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id
string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Query Parameters

filter[name]
string

Case-insensitive substring filter on account name.

Example:

"Snappy"

fields
enum<string>[]

Comma-separated field projection. Valid values: id, name, createdAt, updatedAt, companyId, full.

Minimum array length: 1

The fields that can be returned for the account. Valid values are: id, name, createdAt, updatedAt, companyId, full.

Available options:
id,
name,
createdAt,
updatedAt,
companyId,
full
Example:
page[number]
integer
default:1

1-indexed page number.

Required range: x >= 1
Example:

1

page[size]
integer
default:100

Number of accounts per page (max 1000, default 100).

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

100

Response

Page of accounts plus pagination links.

Paginated accounts response.

data
object[]
required

Accounts for the requested page.

Top-level JSON:API-style pagination links for paginated list responses. first, next, and prev are all required and all nullable. prev is null on cursor-paginated endpoints (backward navigation not supported).

Last modified on June 17, 2026