Skip to main content
GET
List External Accounts

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Query Parameters

limit
integer<int32>

Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.

startingAfter
string
endingBefore
string
customerId
string

Filter to a single customer (cst_ prefix).

counterpartyId
string

Counterparty ID (ctp_ prefix).

Response

200 - application/json

The request has succeeded.

Paginated list of ExternalAccount resources.

object
string

Resource type discriminator.

limit
integer<int32>

The effective page size applied to this response, after clamping an out-of-range or unset requested limit into the supported bound.

hasMore
boolean

True when more rows exist beyond this page in the direction of travel (forward by default, backward when endingBefore was supplied).

nextCursor
string

Opaque cursor pointing at the last item in this page. Present when data is non-empty. Pass as startingAfter to fetch the next page; hasMore=false signals no more pages forward.

previousCursor
string

Opaque cursor pointing at the first item in this page. Present when data is non-empty. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.

data
object[]

The page of results.