Skip to main content
GET
Get an account

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Path Parameters

id
string<uuid>
required

Query Parameters

as_of
string<date>

Compute balances as of the end of this day. Defaults to today in UTC. A future date is rejected, because a balance is only ever historical.

expand
enum<string>[]

Relations to return as full objects instead of ids. Comma-separated.

Without it every relation is an id. Naming one here replaces the id with the object it points at. Expansion goes one level deep; an unsupported name is rejected.

Supported here: bank.

Available options:
bank

Response

The account.

object
string
required
Allowed value: "account"
id
string<uuid>
required
name
string
required
Example:

"ING Curent"

currency
string
required

ISO 4217 alphabetic currency code.

Pattern: ^[A-Z]{3}$
Example:

"RON"

group
string | null
required

Free-text grouping assigned in ThinkOut.

Example:

"Operational"

source
enum<string>
required

delegated accounts are bank accounts another workspace has delegated to this one.

Available options:
manual,
bank,
delegated
balance
string
required

Decimal amount as a string. Signed on transactions, forecasts and report figures, where negative means an outflow. The sign is authoritative: direction is derived from it and the two can never disagree.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"-1250.00"

balance_as_of
string<date>
required

The day whose end-of-day balance is reported. Computed at request time.

opening_balance
string
required

Decimal amount as a string. Signed on transactions, forecasts and report figures, where negative means an outflow. The sign is authoritative: direction is derived from it and the two can never disagree.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"-1250.00"

opening_date
string<date>
required

The date the opening balance applies to. Transactions before it are not expected.

bank
required

A bank connection id, the full connection when named in expand, or null for a manual account.

external_account_id
string | null
required

The account identifier at the provider, useful for reconciliation. null for manual accounts.

original_name
string | null
required

The account name as the bank reports it, before any rename in ThinkOut. null for manual accounts.

created_at
string<date-time>
required
updated_at
string<date-time>
required