Skip to content

Get one company address by id

GET
/addresses/{address_id}
address_id
required

Address id

string
/^[1-9]\d*$/
Example
42

Address

object
data
required
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
state
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

Address not found

object
error
required
string
Allowed values: ADDRESS_NOT_FOUND