GuidesRecipesAPI ReferenceChangelog
API Reference

Get counterparties list

get
https://bank.sandbox.cybrid.app/api/counterparties

Retrieves a listing of counterparties. Records are sorted by creation date in descending order.

Required scope: counterparties:read Optional scope: counterparties:pii:read.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0

The page index to retrieve.

integer
1 to 100

The number of entities per page to return.

string

Comma separated types to list counterparties for.

string

Comma separated bank_guids to list counterparties for.

string

Comma separated customer_guids to list counterparties for.

string

Comma separated counterparty_guids to list counterparties for.

string

Comma separated labels to list counterparties for.

boolean

Include PII in the response (requires counterparties:pii:read scope).

Responses

Updated 5 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago