Skip to main content
GET
List Addresses

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100
created_after
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

created_before
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_after
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_before
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

customer_id
string
reference_ids
string[]

Filter by reference IDs: repeated params only, e.g. ?reference_ids=ref_1&reference_ids=ref_2

sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at
sort
enum<string>
default:desc
Available options:
asc,
desc

Response

OK

data
object[]
pagination
object