Get campaign address books

Gets any address books and segments that a campaign has ever been sent to


This operation retrieves a list of any address books/lists and segments that a specified campaign has ever been sent to.

The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.

The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

Please note: despite the fact that segments also form part of the result of this request and as such also get returned with a 'visibility' parameter, the parameter doesn't apply to segments. Contacts can't actively see, join or leave a segment.

Path Params
int32
required

The ID of the campaign

Query Params
int32
1 to 1000
Defaults to 1000

The number of records to select between 1 and 1000 to retrieve.

int32
≥ 1

The numbers of records to skip in the result set.

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

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