Skip to main content
List companies

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 register.name. id is always returned. Fields: id, name, country, registration_number, registration_exception_reason, description, register, peppol_available, identity_problems, archived_at, erasure_requested_at.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
ids
string<uuid>[]

Only these companies, for example to name the ones a member may access.

Required array length: 1 - 1000 elements
archived
boolean

true: only archived companies; false: only companies in use. Leave out for both.

Companies whose name or registration number contains the text.

Maximum string length: 256

Response

Companies by name.

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