Get contacts based on your criteria

get

https://{region}-api.dotdigital.com/contacts/v3

Get contacts based on criteria you specify. Contacts are returned with full data, specified data fields, or key information and identifiers only.

Note: All data is returned in ascending order

Note: This call also returns deleted contacts, with the status deleted. When a contact or its mobile number is deleted, email and mobileNumber are returned with the value deleted.

📘
Date time filtering
We currently only support the Greater Than or Equal to (gte:: ) operation for our date time filters such as ~created and ~modified.

Query Params

data-fields

array of strings

Contact data is returned with a minimum of contactId and any associated identifiers. Use this field to specify any additional data fields you want to return. Enter a pipe delimited string of the contact data fields required or [[ALL]] to Get all data fields.

data-fields

include

array of strings

Specify additional data sets associated with the contact to include in the returned data.

include

Allowed:

~created

string

^gte::\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z$

Filter by created date.

Note:

The date must be in (ISO 8601 format)
Can't be used in conjunction with the ~modified parameter.

~modified

string

^gte::\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z$

Filter by last modified date.

Note:

The date must be in (ISO 8601 format)

~listId

integer

Filter by a specific list.

Note:

Can't be used in conjunction with the ~segmentId parameter.

~segmentId

integer

Filter by a specific segment.

Note:

Can't be used in conjunction with the ~listId parameter.

limit

int32

1 to 5000

Maximum number of records to retrieve per page

marker

string

Pagination marker to retrieve the data from

Headers

x-ddg-integration-token

uuid

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Responses

401

Unauthorized

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Date time filtering

200Contacts retrieved

400Bad request