getAddressTypes

Retrieves a list of address types supported by the system for both users and contacts. These values are used to categorise the one-to-many addresses a user or contact may have.

Request

GET /rest/refdata/addressTypes

Parameters

None.

Response

200 OK

[
  { "addressTypeCode": "W", "addressTypeName": "Work" },
  { "addressTypeCode": "P", "addressTypeName": "Personal" },
  { "addressTypeCode": "O", "addressTypeName": "Other" }
]

Field	Type	Description
addressTypeCode	string	Single-character address type code
addressTypeName	string	Display name

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching address types

Version

GET /rest/refdata/addressTypes/version

{ "version": 1 }