GET
cURL

Authorizations

Authorization
string
header
required

JWT bearer token. App-user tokens are issued by POST /auth/token (the partner backend calls it as its platform service account); admin and dashboard tokens are issued via OIDC login.

Query Parameters

holder
string | null
holder_kind
null | enum<string>

Discriminator for [Holder] variants. Used at the wire boundary for split-field admin query params (?holder_kind=user&holder_id=...). Not stored as a DB column — the DB has only the URN-encoded holder column.

Available options:
user,
sponsor,
platform
status
null | enum<string>

Account lifecycle status.

Available options:
ACTIVE,
INACTIVE,
PENDING
account_type
null | enum<string>

Type of financial or health account.

Available options:
SAVINGS,
HSA,
EDUCATION,
SPONSOR
sort
null | object

Sort specification for list endpoints. Read the field names as "sort on <column> by <direction>".

time_range
null | object

A half-open time range, with a mandatory start and an optional end. Designed to be embedded in list/filter query params via #[serde(flatten)].

Deserialize runs [TimeRange::validate] as part of deserialization, so callers never receive a [TimeRange] that violates start_time <= end_time.

limit
integer<int32> | null
offset
integer<int32> | null

Response

List of accounts

data
object[]
required
limit
integer<int32>
required
offset
integer<int32>
required
total
integer<int64>
required