Overview of contacts in Cloud API

In Cloud API for ContactManager, contact information is stored in a resource named ABContact. It includes a contactSubtype field, which identifies the subtype of the corresponding ABContact in ContactManager. However, the ABContact resource is not subtyped. It contains fields from the ABContact level and from several different subtype levels. For any given instance of the ABContact resource, some fields will not be relevant.

Email addresses are stored as fields in the ABContact resource in the emailAddress1 and emailAddress2 fields.

Phone numbers are stored as child objects in the ABContact resource. Phone numbers make use of the contact_PhoneNumber schema, which includes countryCode, number, and extension. There is a primaryPhoneType field, which indicates which phone number is the primary phone number (such as "work"). There is also a primaryPhone field that resolves to the phone number of the field indicated by the primaryPhoneType field.

Postal addresses are stored in a separate ABContactAddress resource. You must access them as a child resource of an ABContact.

ABPerson and ABCompany contacts can have tax ids. By default, the value of the taxId field is masked so that only the last four digits are returned. You can configure the endpoint to change how the value is masked, or to remove the mask. For more information, see the Cloud API Developer Guide.

The following is an example of the response for an ABContact resource:

{
    "data": {
        "attributes": {
            "authorizationID": "S1l6v_8Eyfe-TrR9mxPsl",
            "contactSubtype": "ABPerson",
            "displayName": "William Matthew",
            "firstName": "William",
            "gender": {
                 "code": "M",
                 "name": "Male"
            },
            "id": "ab:13",
            "emailAddress1": "william_matthew@email.com",
            "lastName": "Matthew",
            "primaryAddress": {
                "displayName": "345 Fir Lane, La Canada, CA 91352",
                "id": "ab:26",
                "type": "ABContactAddress",
                "uri": "/contact/v1/contacts/ab:13/addresses/ab:26"
            },
            "pronounAggregate": {
                 "code": "hehimhis",
                 "name": "He/Him/His"
            },
            "pronounAggregateDisplay": "He/Him/His",
            "pronounObjective": "Him",
            "pronounPossessive": "His",
            "pronounSubjective": "He",
            "primaryPhone": "831-777-8472",
            "primaryPhoneType": {
                "code": "work",
                "name": "Work"
            },
            "tags": [
                {
                    "type": {
                        "code": "client",
                        "name": "Client"
                    }
                }
            ],
            "taxId": "***-**-6801",
            "workPhone": {
                "countryCode": {
                    "code": "US",
                    "name": "United States (1)"
                },
                "displayName": "831-777-8472",
                "number": "8317778472"
            }
        }
    }
}