Skip to navigation

List accounts

Lists the organisation’s venue accounts, discovered through its credentials. view=approved shows the enforced classification; the default includes pending proposals. Ordered by accountId, ascending.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

viewenumOptionalDefaults to latest

latest (the default) shows a row’s pending proposal where one exists; approved shows what the platform enforces. Resources without proposals serve the same rows for both.

Allowed values:
limitintegerOptional>=1

Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.

cursorstringOptional<=2048 characters

nextCursor or prevCursor from a previous page, sent with the same filters. One that does not decode, or that came from another query, is refused 400 INVALID_CURSOR: drop it and fetch the first page.

includeenumOptional

total adds the exact number of rows matching the filters.

Allowed values:

Response

A page of the rows inside the principal’s org, in the operation’s order — all of them unless limit is sent; the position it was read at rides the body and the headers.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

itemslist of objects
asOfSeqTsNsstring or nullOptionalformat: "^[0-9]+$"

The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.

nextCursorstring or nullOptional

Pass as cursor for the next page. Null on the last page.

prevCursorstring or nullOptional

Pass as cursor for the previous page. Null on the first page.

totalinteger or nullOptional

Exact count matching the filter. Null unless include=total.

unscaledbooleanOptionalDeprecated

Never present since 0.3.3: every money value on this API states its own scale on the wire, so no item is ever served raw — the coarse collection form of RowExtras.unscaled, retired with it. Kept, deprecated, so a client generated from 0.3.2 still compiles.

Errors

400
List Accounts Request Bad Request Error
401
List Accounts Request Unauthorized Error
403
List Accounts Request Forbidden Error
503
List Accounts Request Service Unavailable Error