Skip to main content
GET
List Counterparties

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

version
string
required
Allowed value: "v1"

Query Parameters

fullname
string | null
relationship_type
enum<string> | null
Available options:
CUSTOMER,
FRIEND,
DONOR,
DONEE,
FAMILY,
EMPLOYEE,
SUPPLIER,
CONTACT,
SERVICE_PROVIDER,
PARTNER,
BENEFICIARY,
SELF

Response

Successful Response

id
integer
required
owner_party_type
string
required
owner_party_id
integer
required
relationship_type
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
party
PartyResponse · object | null

PartyResponse

Last modified on June 23, 2026