Querying for contacts

Use the following endpoints to query for contacts and contact addresses.

Endpoint Returns
/contact/v1/contacts All contacts
/contact/v1/contacts/{contactId} The contact with the given ID
/contact/v1/contacts/{contactId}/addresses All addresses associated with the given contact
/contact/v1/contacts/{contactId}/addresses/{addressId} The address for the given contact with the given address ID

Masking the taxID field

The ABContact resource has a taxID field which stores the tax id of the contact. In the Cloud API base configuration, this field is masked in responses so that only the last four digits appear. For example, the following is the response for a GET that retrieves a contact.

{
    "data": {
        "attributes": {
            "displayName": "Ray Newton",
            "taxId": "***-**-6789"
        }
    }
}

For some callers, such as internal or external users, the masking of tax id may be appropriate as it protects personally identifiable information. For other callers, such as services, this masking may cause a problem as the callers may reference contacts internally using the tax id.

There are two ways that the taxId field can be unmasked:

  • You can configure the field so that it is always unmasked.
  • You can grant the caller the restunmasktaxid system permission. Any caller who has a role with this permission will get responses with unmasked tax IDs.

For information, see the Cloud API Developer Guide.