Sign in
Counterparty

List Counterparties

List Counterparties. customerId is an optional filter - omit it to list all counterparties in the project (still tenant-scoped by project).

get/counterparties

Query parameters

limitinteger
startingAfterstring
endingBeforestring
customerIdstring

Filter to a single customer (cst_ prefix).

Response

The request has succeeded.

objectstring

Resource type discriminator.

hasMoreboolean

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

nextCursorstring

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.

previousCursorstring

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.

Changes

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