List contacts
Returns all contacts at a specific contact company location. The ExternalId on each contact reflects any ERP identifier stored via the external ID system.
x-api-keyField | Type | Required |
|---|---|---|
| ContactCompanyLocationKey | uuid | Yes |
Status | When |
|---|---|
| 200 | Success |
| 400 | Validation failed or the request was malformed. |
| 401 | Unauthorized |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data | object | null | No | |
| data. | object[] | No | |
| data. | uuid | No | Unique identifier for the contact |
| data. | uuid | No | Identifier for the contact company location this contact belongs to |
| data. | string | No | Email address of the contact |
| data. | string | No | First name of the contact |
| data. | string | No | Last name of the contact |
| data. | string | No | Phone number of the contact |
| data. | string | null | No | External ERP identifier for the contact, if set |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on. |
| errors[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"data": {
"items": [
{
"contactKey": "2e883457-fcb8-4fa5-aa10-aabe744871a0",
"contactCompanyLocationKey": "fc0f0a87-2a40-49cb-9ccc-ca8f9afb1895",
"emailAddress": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalId": "string"
}
]
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}