Skip to main content

Retrieve a list of addresses from a profile

Retrieve a list of addresses from a profile.

Authorizations:Token, JWT
Query Parameters
profile_id
required
integer
pageintegerDefault: 1The collection page number
itemsPerPageinteger[0 .. true]Default: 30The number of items per page
paginationbooleanEnable or disable pagination
Query Parameters
profile_id
required
integer
pageintegerDefault: 1The collection page number
itemsPerPageinteger[0 .. true]Default: 30The number of items per page
paginationbooleanEnable or disable pagination

Responses

200Address collection
Response schema:
Address collection
Array
idinteger>= 0
is_billingboolean
is_shippingboolean
is_workboolean
typestring
titlestring
firstnamestring
lastnamestring
phonestring
address1string
address2string
address3string
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
401Unauthorized
Response schema:
Unauthorized
typestring
titlestring
detailstring or null
instancestring or null
500Internal error
Response schema:
Internal error
typestring
titlestring
detailstring or null
instancestring or null