List Accounts

GET

/accounts

curl --request GET \
  --url 'https://example.com/accounts?include_balances=false&include_virtual=false&include_hidden=false&include_closed=false'

Parameters

Query Parameters

include_balances

Include Balances

boolean

include_virtual

Include Virtual

boolean

include_hidden

Include Hidden

boolean

include_closed

Include Closed

boolean

Responses

200

Successful Response

Media typeapplication/json

Response List Accounts Accounts Get

Array<object>

AccountOut

object

balance

Any of:

string

string

null

null

balance_as_of

Any of:

string

string format: date

null

null

balance_method

Any of:

string

string

null

null

closed_at

required

Any of:

string

string format: date-time

null

null

connection_id

required

Any of:

string

string format: uuid

null

null

created_at

required

Created At

string format: date-time

currency

required

Currency

string

description

required

Any of:

string

string

null

null

drift_basis_override

Any of:

string

string

Allowed values: pending_inclusive posted_only

null

null

external_id

required

Any of:

string

string

null

null

feed_invert

Feed Invert

boolean

feed_start

Any of:

string

string format: date

null

null

hidden_at

required

Any of:

string

string format: date-time

null

null

holdings_source

Holdings Source

string

default: feed

Allowed values: feed manual

id

required

Id

string format: uuid

is_virtual

required

Is Virtual

boolean

min_balance

required

Any of:

string

string

null

null

name

required

Name

string

parent_id

required

Any of:

string

string format: uuid

null

null

path

required

Path

string

postings_balance

Any of:

string

string

null

null

reconciled_through

Any of:

string

string format: date

null

null

reconciliation

Any of:

ReconciliationOut

ReconciliationOut

A recorded reconciliation (issue #268), re-checked against the ledger when it is read — so a backdated import, edit or replay that moved the balance on as_of shows up here as a nonzero difference instead of leaving the reconciled-through marker silently wrong.

statement_balance is the figure as the statement shows it (positive = money held; for a credit card, the amount owed). Every other amount is in ledger sign (a card is negative when owed).

object

adjustment

required

Adjustment

string

adjustment_tx_id

required

Any of:

string

string format: uuid

null

null

as_of

required

As Of

string format: date

basis

required

Basis

string

Allowed values: posted pending_inclusive

created_at

required

Created At

string format: date-time

difference

required

Difference

string

id

required

Id

string format: uuid

in_balance

required

In Balance

boolean

ledger_balance

required

Ledger Balance

string

statement_balance

required

Statement Balance

string

target_balance

required

Target Balance

string

null

null

type

required

Type

string

Example

[
  {
    "drift_basis_override": "pending_inclusive",
    "feed_invert": false,
    "holdings_source": "feed",
    "reconciliation": {
      "basis": "posted"
    }
  }
]

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}