Get all counterparts

GET
/counterparts

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Query parameters

ibanstringOptional
The IBAN of the counterpart's bank account.
sort_codestringOptional
The bank's sort code.
account_numberstringOptional
The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits.
tax_idstringOptional
The tax ID of the counterpart.
vat_idstringOptional
The VAT ID of the counterpart.
id__instringOptional
A list of counterpart IDs to search through.
order"asc" or "desc"Optional
Order by
Allowed values: ascdesc
limitintegerOptional
Max is 100
pagination_tokenstringOptional
A token, obtained from previous page. Prior over other filters
sort"counterpart_name"Optional
Allowed sort fields
type"individual" or "organization"Optional
Allowed values: individualorganization
counterpart_namestringOptional
counterpart_name__iexactstringOptional
counterpart_name__containsstringOptional
counterpart_name__icontainsstringOptional
is_vendorbooleanOptional
is_customerbooleanOptional
emailstringOptional
email__containsstringOptional
email__icontainsstringOptional
created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional
address.countrystringOptional
address.citystringOptional
address.postal_codestringOptional
address.statestringOptional
address.line1stringOptional
address.line2stringOptional
tag_ids__instringOptional

Response

This endpoint returns an object.
datalist of objects

A Counterpart object contains information about an organization (juridical person) or individual (natural person) that provides goods and services to or buys them from an SME.

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors