Get All Addresses for Contact

Gets the addresses for the specified contacts and specified records.

Resource Information

Scope	records Deprecated scope name: get_record_contact_addresses
App Type	All
Authorization Type	Access token
URI	/v4/records/{recordId}/contacts/{contactId}/addresses?lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
contactId	long	Yes	Get All Contacts	The unique ID associated with the contact.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	The address of the contact.	7.3.2
result.addressLine1	string	The first line of the address.	7.3.2
result.addressLine2	string	The second line of the address.	7.3.2
result.addressLine3	string	The third line of the address.	7.3.2
result.city	string	The name of the city.	7.3.2
result.country	result.country{}	The name of the country.	7.3.2
result.country.text	string	The localized display text.	7.3.2
result.country.value	string	The value for the specified parameter.	7.3.2
result.direction	result.direction{}	The street direction of the primary address associated with the application.	7.3.2
result.direction.text	string	The localized display text.	7.3.2
result.direction.value	string	The value for the specified parameter.	7.3.2
result.effectiveDate	dateTime	The date when you want the condition to become effective.	7.3.2
result.expirationDate	dateTime	The date when the condition expires.	7.3.2
result.fax	string	The fax number for the contact.	7.3.2
result.faxCountryCode	string	Fax Number Country Code	7.3.2
result.houseAlphaEnd	string	The ending street number that makes up the address.	7.3.2
result.houseAlphaStart	string	The beginning street number that makes up the address.	7.3.2
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isPrimary	string	Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.	7.3.2
result.levelEnd	string	The ending level number (floor number) that makes up the address within a complex.	7.3.2
result.levelPrefix	string	The prefix for the level numbers (floor numbers) that make up the address.	7.3.2
result.levelStart	string	The beginning level number (floor number) that makes up the address within a complex.	7.3.2
result.phone	string	The telephone number of the contact.	7.3.2
result.phoneCountryCode	string	The country code for the assoicated phone number.	7.3.2
result.postalCode	string	The postal ZIP code for the address.	7.3.2
result.recipient	string	The entity on the receiving end of an operation, for example a notification of an event.	7.3.2
result.state	result.state{}	The state corresponding to the address on record.	7.3.2
result.state.text	string	The localized display text.	7.3.2
result.state.value	string	The value for the specified parameter.	7.3.2
result.status	result.status{}	The contact address status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.streetAddress	string	The street address.	7.3.2
result.streetEnd	long	The end of a range of street numbers.	7.3.2
result.streetName	string	The street name for the address.	7.3.2
result.streetPrefix	string	Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.	7.3.2
result.streetStart	long	The start of a range of street numbers.	7.3.2
result.streetSuffix	result.streetSuffix{}	The type of street such as "Lane" or "Boulevard".	7.3.2
result.streetSuffix.text	string	The localized display text.	7.3.2
result.streetSuffix.value	string	The value for the specified parameter.	7.3.2
result.streetSuffixDirection	result.streetSuffixDirection{}	The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.	7.3.2
result.streetSuffixDirection.text	string	The localized display text.	7.3.2
result.streetSuffixDirection.value	string	The value for the specified parameter.	7.3.2
result.type	result.type{}	The address type.	7.3.2
result.type.text	string	The localized display text.	7.3.2
result.type.value	string	The value for the specified parameter.	7.3.2
result.unitEnd	string	The end parameter of a range of unit numbers.	7.3.2
result.unitStart	string	The starting parameter of a range of unit numbers.	7.3.2
result.unitType	result.unitType{}	The unit type designation of the address.	7.3.2
result.unitType.text	string	The localized display text.	7.3.2
result.unitType.value	string	The value for the specified parameter.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "id": 233,
      "addressLine1": "2633 Camino Ramon",
      "addressLine2": "Suite 500",
      "phone": "9256593200",
      "city": "San Ramon",
      "phoneCountryCode": "1",
      "country": {
        "value": "US",
        "text": "United States"
      },
      "state": {
        "value": "CA",
        "text": "CA"
      },
      "status": {
        "value": "A",
        "text": "Active"
      }
    }
  ],
  "page": {
    "offset": 0,
    "total": 1,
    "limit": 25,
    "hasmore": false
  },
  "status": 200
}