List Directory Contacts
GET {{baseUrl}}/directories/:directoryId/contacts?pageSize=100&skipToken=qui
Retrieve the contacts in a specific directory.
<!--From Readme-->
For the last page of results, the value associated with nextPage
will be null
.
This API call is only available to XM Directory users.
The new string-based pagination functionality results in improved performance and a lower rate of timeouts. To opt in, append query parameter useNewPaginationScheme=true
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pageSize | number | The maximum number of items to return per request | |
skipToken | string | The start position for pagination |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"contactId":"CID_012345678901234","firstName":"Jane","lastName":"Doe","email":"JaneDoe@email.com","phone":"111-111-1111","extRef":"my_Internal_ID_12345","language":"","unsubscribed":true},{"contactId":"CID_012345678901234","firstName":"Jane","lastName":"Doe","email":"JaneDoe@email.com","phone":"111-111-1111","extRef":"my_Internal_ID_12345","language":"","unsubscribed":true}],"nextPage":"pariatur eiusmod Duis laboris"},"meta":{"httpStatus":"consequat magna laborum nisi deserunt","requestId":"dolore","notice":"cillum Duis"}}