Skip to main content
List the accounting system's suppliers

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; use dots for nested fields, such as linked_supplier.id. Fields: source_system, number, name, organization_number, active, removed, linked_supplier, companies.

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

Case-insensitive match on name, number or organization number.

Required string length: 1 - 200
active
boolean

Only active (true) or inactive (false) entries.

linked
boolean

Only entries linked (true) or not linked (false) to a supplier of ours.

integration_id
string<uuid>

Only this connection's register.

company_ids
string<uuid>[]

Only these workspace companies' registers. Each company has its own.

Required array length: 1 - 1000 elements

Response

One page.

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