Skip to main content
GET
Retrieve an account

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

id
string<uuid>
required

Account ID

Query Parameters

include_disabled
boolean

Allow retrieving a disabled account. Defaults to false.

Response

account retrieved

id
string<uuid>
required
name
string
required
balance
string
required
balance_cents
integer
required

Signed balance in minor currency units

cash_balance
string
required
cash_balance_cents
integer
required

Signed cash balance in minor currency units

currency
string
required
classification
string
required
account_type
string | null
required
status
enum<string>
required
Available options:
active,
draft,
disabled,
pending_deletion
created_at
string<date-time>
required
updated_at
string<date-time>
required
subtype
string | null
institution_name
string | null
institution_domain
string | null