Skip to main content
Get a supplier

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.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as address.street. id is always returned. Fields: id, name, organization_number, org_country, email, website, address, domain, relationships, created_at, updated_at.

Response

The party record. Editing it does not change the party details printed on invoices (invoiced_as).

id
string<uuid>
required
name
string
required
organization_number
string | null
required
org_country
string | null
required

Country issuing the organization number; null when unknown.

email
string | null
required
website
string | null
required
address
object
required
domain
string | null
required

Company domain, derived from the website or email. Read-only.

relationships
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required