Skip to main content
List a company's delivery addresses

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 of each row. id is always returned. Fields: id, name, street, postal_code, city, country_code, source_system, is_default.

Response

The addresses.

company_id
string<uuid>
required
default_address_id
string<uuid> | null
required

Where a new order delivers: the address marked default, else the only one; null delivers to the buyer.

data
object[]
required

By name.