Skip to main content
GET
List Balances

Authorizations

Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Query Parameters

cursor
string | null

Opaque pagination cursor from a previous /v1/balances response. Cursors are valid only for the same query filters.

limit
integer
default:100

Maximum number of items to return.

Required range: 1 <= x <= 500
dateGte
string<date> | null

Return balances with date greater than or equal to this date.

dateLt
string<date> | null

Return balances with date earlier than this date.

updatedAtGte
string<date-time> | null

Return balances whose updatedAt is greater than or equal to this timestamp. When supplied, results are ordered by updatedAt asc, accountId asc, date asc.

accountId
string<uuid> | null

Filter by account identifier.

connectionId
string<uuid> | null

Filter by parent connection identifier.

entityId
string<uuid> | null

Filter by entity identifier.

Response

Successful Response

data
AccountBalance · object[]
required
pagination
Pagination · object
required
meta
Meta · object
required