Retrieve details of a contact within an organization.
This API call is used to get contacts.
Some things to keep in mind are that a lot of the values found in the results
If you would like to get ALL contacts in your organization this the API call you will want to use.
The recommendation to get all contacts it to make one initial call to any page (page 1 will work). In the result object, you will see a field called “totalPageCount”. That tells you the total number of pages you will need to retrieve.
This API call is used to get contacts.
Some things to keep in mind are that a lot of the values found in the results
If you would like to get ALL contacts in your organization this the API call you will want to use.
The recommendation to get all contacts it to make one initial call to any page (page 1 will work). In the result object, you will see a field called “totalPageCount”. That tells you the total number of pages you will need to retrieve.
Response body
| Property | Description |
|---|---|
| path | An array of delivery paths |
| externalId | This is the user-defined unique identifier for a contact and must be unique.Typically an employee ID number is used |
| recordTypeId | This is the internal ID value of the record type of this contact. See Record Types |
| groups | An array of group IDs to which this contact belongs |
| topics | An array of subscription IDs to which this contact has opted in to |
Error Messages
| status | message |
|---|---|
| 401 | Missing Organization Id |
| 404 | Missing Contact Id |