Get contacts from address book

Gets a list of contacts in a given address book or segment by id

🚧

We recommend using get contacts instead

We recommend using the Get contacts based on your criteria instead of this call for better performance and compatibility with unified contacts. The ~listId filter can be used to find contacts in a list, and the ~segmentId can be used for segments.

📘

Pagination in our API

To learn about pagination in our API, check out Paging through data.


Path Params
int32
required

The ID of the address book or segment

Query Params
boolean
Defaults to false

Can be set to 'true' to retrieve the contacts along with their full contact data fields

int32

he 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. This parameter goes within the URL.

int32

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.

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