Skip to main content

Retrieve an address from a profile

Retrieves a Address resource.

Authorizations:Token, JWT
Query Parameters
profile_id
required
integer>= 1
id
required
integer>= 1

Responses

200Address resource
Response schema:
Address resource
is_billingboolean
is_shippingboolean
is_workboolean
typestringDefault: "R"Enum: "R""C"Example: "R"
titlestring
firstnamestring
lastnamestring
phonestring
address1string
address2string
address3string
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger>= 0
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
idinteger or null>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
404Resource not found
Response schema:
Resource not found
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null