List contact identifiers

List contact identifiers

get
/workspaces/{workspaceId}/contacts/{contactId}/identifiers

This endpoint will return a list of identifiers for the specified contact.

Authorizations
AuthorizationstringRequired

An access token issued to a user.

Path parameters
workspaceIdstring · uuidRequired

The unique identifier of the workspace.

contactIdstringRequired

The ID of a contact.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61
Query parameters
limitinteger · max: 100Optional

Limits the number of results to return.

Default: 25
pageTokenstringOptional

The cursor that keeps track of the current position in the results.

reversebooleanOptional

Reverses the order in which the results are returned.

Default: false
Responses
chevron-right
200

A list of identifiers was returned. The list can be empty if no identifiers are found.

application/json
nextPageTokenstringOptional

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

get
/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Examples

Let's establish some of our data that will be used in the following examples:

  • Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

  • AccessKey: abcd

  • Contact ID: 12bd0e40-9361-4e32-8b26-99b4ab7eae09

List the identifiers from a contact

In this example, we're listing contact identifiers from a given contact ID.

Last updated

Was this helpful?