Resource URL

Returns a specific address object.

GET /addresses/:id

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

id	number
full	string	The full address
title	string
street1	string
street2	string
city	string
zipcode	string
state	unsigned int or object
country	unsigned int or object
postal	String, yes or no
physical	String, yes or no

Fields that can be object indicate the field can be requested as a resource. For example.

GET /addresses?_fields=country

would return the country's id. Where as,

GET /addresses?_fields=country()

would return the country's object.

Sample Response

GET /addresses/1.json?_fields=country(),state

{
   "response" :
      {
         "country" : {
            "title" : "Australia",
            "id" : "1"
         },
         "id" : "1",
         "full" : "141/125 Oxford Street, , Bondi Junction, 2022, NSW, Australia",
         "state" : "1"
      },
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}