Accounts

List portfolio accounts

Returns one continuation-paginated Chart of Accounts page using the requested metadata sort and account number as the deterministic cursor identity and tie-breaker. Asset sorting uses the visible asset symbol or currency symbol when the account has no asset. Set includeBalances=true to replay the requested account-number keyset against current state with draft-inclusive balances. Metadata-only and enriched requests are independent current-state reads, so account changes can alter rows or pagination between requests. Omit it for the faster metadata-only response.

get/v1/portfolios/{portfolioSlug}/accounts

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}/accounts
  • Auth: API key in header x-api-key

Path parameters

portfolioSlugstring required

Workspace-scoped portfolio slug

Query parameters

pageSizeinteger

Requested number of resources to return. Oversized values are clamped to the route limit.

pageTokenstring

Opaque token returned by the previous list response.

sort'accountNumber' | '-accountNumber' | 'name' | '-name' | 'subType' | '-subType' | 'asset' | '-asset'

Metadata sort with an optional - prefix for descending order. Asset sorting uses the visible asset symbol or currency symbol when the account has no asset.

searchstring

Case-insensitive account number or name search.

accountNumbersstring[]

Account numbers to include.

accountTypesstring[]

Top-level account types to include.

originsstring[]

Exact persisted origin values.

subTypesstring[]

Persisted account subtypes to include.

normalBalanceTypesstring[]

Normal-balance entry types to include.

walletsstring[]

Current wallet identities to include as repeated or CSV chainId:address values.

includeNoWalletboolean

Select only accounts without a current wallet when wallets is omitted, or include them alongside selected wallets.

assetIdsstring[]

Public account asset identifiers to include.

currencyAssetIdsstring[]

Public account currency identifiers to include.

isActiveboolean

Whether to include only active or only archived accounts.

paymentLabel'withLabel' | 'withoutLabel'

Payment-label presence state to include.

hierarchy'parent' | 'leaf'

Whether to include parent or leaf accounts.

includeBalancesboolean

Whether returned logical page rows include current balances.

Response

Continuation-paginated account metadata, optionally enriched with current balances.

Changes

No recorded changes to this operation across all 1 revision of this API.