API Reference

List counterparties

get
https://sandbox.cakecapital.com/api/v1/send/counterparties/

This API retrieves a list of counterparties with pagination support.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

This API can be called on behalf of a sub-account by passing in the optional x-subaccount-id in the request header

Query Params
int32
Defaults to 1

The page number to retrieve

int32
Defaults to 20

The number of items per page

int32
Defaults to 0

The offset for pagination or the number of records to skip

string

The status of the counterparty. Possible values ACTIVE, PENDING or DELETED

Headers
string

The subaccount-id of a corporate can be passed here to make the API call on behalf of them

Response

Updated 9 months ago

Did this page help you?
Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 9 months ago

Did this page help you?