Clients / Addresses / Show

NameClients / Addresses / Show
DescriptionDisplay a specific Client Address
TypeGET
URL
/v9/clients/:client_id/addresses/:address_id
Credential TypeAPI
Supports PaginationNo

Parameters

Name
Description
Type
Presence
Location
client_idThe ID of the specific ClientIntegerRequiredURI
address_idThe ID of the specific AddressIntegerRequiredURI

Properties

Name
Description
Type
country_code
2 digit ISO 3166-1 alpha-2 Country CodeString
extended_address
Second line of the street address

String

idThe unique ID of this AddressInteger
label
Arbitrary description, like 'home' or 'office' String
latitude
Latitude for the AddressFloat|null
locality
CityArray|null
longitude
Longitude for the AddressFloat|null
name
Name of the person/recipientString|null
po_box
Whether or not this is considered a PO BoxBoolean
postal_code
Zip codeObject|null
primary
Whether or not this is considered the primary address for this ClientObject|null
region
State or provinceString|null
street_address
First line of the AddressString|null
updated_atLast updated timestampDate (ISO_8601)
urlThe unique URL for this AddressString

Examples

RequestResponse
GET /v9/clients/109402/addresses/501545
{
    "country_code": "US",
    "extended_address": "Suite M",
    "id": "501545",
    "label": "Moe’s Tavern",
    "latitude": null,
    "locality": "Springfield",
    "longitude": null,
    "name": "Moe Szyslak",
    "po_box": false,
    "postal_code": "85262",
    "primary": false,
    "region": "MG",
    "street_address": "555 Tire Fire Way",
    "updated_at": "2014-08-08T21:36:55Z",
    "url": "/clients/109402/addresses/501545"
}