Skip to main content
GET
List ledger accounts
Archived ledger accounts are excluded unless you set include_archived=true. This also applies when you filter by ID.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

ledger_account_types
string[]

Comma-separated account types. Allowed: Asset, Liability, Equity, Income, Expense.

is_postable
boolean

true for postable child accounts only, false for parent grouping accounts only.

include_archived
boolean

Include archived ledger accounts. Defaults to false.

is_clearing_account
boolean

Filter to clearing accounts (true) or non-clearing accounts (false).

sort_by
enum<string>

Field to sort by. Defaults to sequence (chart-of-accounts order).

Available options:
sequence,
name
sort_direction
enum<string>

Sort direction.

Available options:
asc,
desc
include_count
boolean

Include the total number of matching records. If the count cannot be calculated, the request fails.

ledger_account_ids
string[]

Filter to specific lac_-prefixed ledger account IDs. Up to 100 IDs.

parent_ledger_account_ids
string[]

Filter to children of the given lac_-prefixed parent account IDs. Up to 100 IDs.

limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

Case-insensitive search in labels and descriptions.

Response

The matching records.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

total_count
integer

Total matching records across all pages. Present when include_count=true.

Required range: x >= 0