Clients / Addresses / Index

Name	Clients / Addresses / Index
Description	List Addresses for a specified Client
Type	GET
URL	/v9/clients/:client_id/addresses
Credential Type	API
Supports Pagination	Yes

Long Description

List Addresses for a specified Client

Parameters

Name	Description	Type	Presence	Location	Conditionals
`client_id`	The ID of the specific Client	Integer	Required	URI	No
`label`	Arbitrary description, like 'home' or 'office'	String	Optional	Body	No
`name`	Name of the person at this address	String	Optional	Body	No
`company`	Company name in the address	String	Optional	Body	No
`street_address`	Street address of the new address	String	Optional	Body	No
`extended_address`	Second line of the street address	String	Optional	Body	No
`locality`	City	String	Optional	Body	No
`region`	State or province	String	Optional	Body	No
`postal_code`	Zip code	String	Optional	Body	No
`country_code`	2 digit ISO 3166-1 alpha-2 Country Code	String	Optional	Body	No
`created_at`	Creation timestamp	Date (ISO_8601)	Yes	Query	Yes
`updated_at`	Last updated timestamp	Date (ISO_8601)	Yes	Query	Yes

Examples

Request

Response

Paste in Request Code

{
   "addresses":[
      {
         "country_code":"US",
         "url":"/clients/1625/addresses/10110",
         "updated_at":"2011-09-20T20:33:22Z",
         "longitude":null,
         "street_address":"555 Evergreen Terrace",
         "name":null,
         "locality":"Springfield",
         "label":"Work",
         "id":"10110",
         "latitude":null,
         "postal_code":"58008-0000",
         "region":"MG",
         "extended_address":null
      }
   ],
   "current_page":1,
   "per_page":2,
   "total_entries":1
}