List contacts by externalIds and sources

GET

contacts

Query Parameters

externalIds

string[]

required

sources

string[]

maxResults

integer

default:

required

Maximum number of results to return per page.

Required range: 1 < x < 50

pageToken

string

Response

200 - application/json

data

object[]

required

Array of items

data.createdAt

string

required

Timestamp of contact creation in ISO 8601 format.

data.createdByUserId

string

required

The unique identifier of the user who created the contact.

data.customFields

object[]

required

data.defaultFields

object

required

data.externalId

string | null

required

An external identifier of the contact.

Required string length: 1 - 75

data.id

string

required

The unique identifier of the contact.

data.source

string | null

required

Indicates how the contact was created or where it originated from.

Required string length: 1 - 75

data.updatedAt

string

required

Timestamp of last contact update in ISO 8601 format.

nextPageToken

string | null

required

totalItems

integer

required

Total number of items available. ⚠️ Note: totalItems is not accurately returning the total number of items that can be paginated. We are working on fixing this issue.

Was this page helpful?

Get contact custom fields Create a contact

Getting started

Essentials

Calls

Contact Custom Fields

Contacts

Conversations

Messages

Phone Numbers

Webhooks

List contacts by externalIds and sources

Query Parameters

Response