GuidesRecipesAPI Reference
API Reference
Select productLog inHelp centre

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

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 retrieve all data fields.

data-fields
include
array of strings

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

include
string

Filter by created date.
Note:

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

Filter by last modified date.
Note:

integer

Filter by a specific list.
Note:

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

Filter by a specific segment.
Note:

  • Can't be used in conjunction with the ~listId parameter.
int32
1 to 5000

Maximum number of records to retrieve per page

string

Pagination marker to retrieve the data from

Headers
string

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

Responses

401

Unauthorized

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago