GuidesRecipesAPI ReferenceChangelog
API Reference
Select productLog inHelp centre

Get contacts opted into a preference and an address book

get
https://{region}-api.dotdigital.com/v2/address-books//contacts/with-preference/

Gets contacts who are opted into a given preference and a given address book


This operation returns an array of up to 1000 contacts who are in a given address book and who are opted in to a given preference.

If no contacts in the given address book are opted in to the given preference, an empty array is returned. Otherwise an array containing contact objects is returned.

🚧

Preference categories

Results are returned only for preferences, not preference categories.

If you specify the id of a preference category in the path parameter, an empty array will always be returned.

Path Params
int32
required

The ID of the address book to which contacts must belong.

int32
required

The ID of the preference to which contacts must be opted in.

Query Params
int32

The minimum contact ID to query on, starting from 0

Headers
string
/^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/

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

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?