Skip to main content
GET
List addresses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Query Parameters

expand
string

Comma-separated list of relations to expand. Allowed values: client.

Example:

"client"

clientId
string

Unique identifier of the client.

Minimum string length: 1
Example:

"clnt_z2b3mo8qa5kzptgsu26q2wmh"

sort
string

Comma-separated list of sort clauses in "field:direction" format. Allowed fields: name, order, city, country, client.name, createdAt, updatedAt. Allowed directions: asc, desc.

Example:

"name:asc,order:desc"

Response

Default Response

Standard success response payload wrapped in a data property.

data
object[]
required

List of addresses returned by the API.