Get All Addresses for Contact

Gets the addresses for the specified contacts and specified records.

Resource Information

Scoperecords

Deprecated scope name:   get_record_contact_addresses

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/contacts/{contactId}/addresses?lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
contactIdlongYes Get All Contacts The unique ID associated with the contact.7.3.2
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}The address of the contact.7.3.2
result.addressLine1stringThe first line of the address. 7.3.2
result.addressLine2stringThe second line of the address.7.3.2
result.addressLine3stringThe third line of the address.7.3.2
result.citystringThe name of the city.7.3.2
result.countryresult.country{}The name of the country.7.3.2
result.country.textstringThe localized display text.7.3.2
result.country.valuestringThe value for the specified parameter.7.3.2
result.directionresult.direction{}The street direction of the primary address associated with the application.7.3.2
result.direction.textstringThe localized display text.7.3.2
result.direction.valuestringThe value for the specified parameter.7.3.2
result.effectiveDatedateTimeThe date when you want the condition to become effective.7.3.2
result.expirationDatedateTimeThe date when the condition expires.7.3.2
result.faxstringThe fax number for the contact.7.3.2
result.faxCountryCodestringFax Number Country Code7.3.2
result.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isPrimarystringIndicates 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.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.phonestringThe telephone number of the contact.7.3.2
result.phoneCountryCodestringThe country code for the assoicated phone number.7.3.2
result.postalCodestringThe postal ZIP code for the address.7.3.2
result.recipientstringThe entity on the receiving end of an operation, for example a notification of an event.7.3.2
result.stateresult.state{}The state corresponding to the address on record.7.3.2
result.state.textstringThe localized display text.7.3.2
result.state.valuestringThe value for the specified parameter.7.3.2
result.statusresult.status{}The contact address status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.streetAddressstringThe street address. 7.3.2
result.streetEndlongThe end of a range of street numbers.7.3.2
result.streetNamestringThe street name for the address.7.3.2
result.streetPrefixstringAny 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.streetStartlongThe start of a range of street numbers.7.3.2
result.streetSuffixresult.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.streetSuffix.textstringThe localized display text.7.3.2
result.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.streetSuffixDirectionresult.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.textstringThe localized display text.7.3.2
result.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.typeresult.type{}The address type.7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.unitTyperesult.unitType{}The unit type designation of the address.7.3.2
result.unitType.textstringThe localized display text.7.3.2
result.unitType.valuestringThe value for the specified parameter.7.3.2
statusintegerThe 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
}