Skip to main content
List suppliers or recipients

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string[]

Return only these fields of each row. id is always returned. Fields: id, company_id, name, organization_number.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
type
enum<string>
required

supplier: issues invoices. recipient: invoices are addressed to it.

Available options:
supplier,
recipient
ids
string<uuid>[]

Return only these IDs.

Case-insensitive match on name.

Required string length: 1 - 200

Response

A page of parties; next_cursor is null at the end.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required
total_count
integer
required