Skip to content

List company addresses

GET
/addresses
limit

Page size (max 100)

integer
default: 50 >= 1 <= 100
Example
50
offset

Number of items to skip

integer
0 nullable
0

Paginated addresses

object
data
required
Array<object>
object
id
required
integer
first_name
required
string
nullable
last_name
required
string
nullable
phone
required
string
nullable
phone_country
required
string
nullable
address1
required
string
nullable
address2
required
string
nullable
type
required
string
nullable
zip
required
string
nullable
city
required
string
nullable
country
required

ISO 3166-1 alpha-2 country code

string
nullable
Example
FR
label
required
string
nullable
comment
required
string
nullable
is_default
required
boolean
is_hq
required
boolean
meta
required
object
total
required

Total rows matching filters (before paging)

integer
Example
42
limit
required

Requested page size after validation

integer
Example
50
offset
required

Requested offset after validation

integer
0

Validation error

object
error
required
string