List Contact Addresses
GET {{baseUrl}}/cas/contacts/{{contactId}}/addresses
Retrieves all addresses for a Contact.
StartFragment
Response Body
Key | Datatype | Mandatory | Comments |
|---|---|---|---|
id | number | This is the AddressTypeId | |
addressType | string | Yes | Address Types: - RESIDENTIALADDRESS - ALTERNATEADDRESS - BUSINESSADDRESS - CORRESPONDENCEADDRESS - POSTALADDRESS - SERVICEADDRESS - OTHER_ADDRESS |
effectiveDate | string | Yes | |
| inUse | True/False | ||
addresses (object) | |||
id | number | ||
country | string | Yes | ISO 3166 country code/name |
block | string | No | Singapore only |
buildingEstate | string | No | Singapore only |
careOf | string | No | |
levelFloor | string | No | Singapore only |
unitFlat | string | No | Singapore Only |
streetLine1 | string | Yes | |
streetLine2 | string | No | |
suburb | string | No | |
postCode | string | Yes | |
state | string | Yes | If country is Australia the value must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT'. Can also be 'Foreign' if country is not 'Australia' |
Additional Keys
Key | Datatype | Mandatory |
|---|---|---|
total | Number | Yes |
EndFragment
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
| `` | null |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |