Retrieve a list of addresses from a profile

Retrieves the collection of Address resources.

Authorizations:Token, JWT

Query Parameters

profile_id required	integer>= 1
page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination

Query Parameters

profile_id required	integer>= 1
page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination

Responses

200Address collection

Response schema: application/jsonapplication/ld+json

Address collection

Array

is_billing	boolean
is_shipping	boolean
is_work	boolean
type	stringDefault: "R"Enum: "R""C"
title	string
firstname	string
lastname	string
phone	string
address1	string
address2	string
address3	string
zipcode	string<= 32 characters
city	string
country_code	string2 characters
state	integer>= 0
state_name	string
custom_fields	Array of objects
Array name string value string
id	integer>= 1

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null