List Opted Out Directory Contacts
GET {{baseUrl}}/directories/:directoryId/contacts/optedOutContacts?pageSize=100&since=2022-01-01T00:00:00.00Z&skipToken=<string>
Retrieve the contacts, in a specific directory, who have opted out.
<!--From Readme-->
For the last page of results, the value associated with nextPage will be null.
<!-- theme: warning -->
This API call is only available to XM Directory users.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | The maximum number of items to return per request | |
since | string | The date before which unsubscribed contacts should be excluded. If excluded, all unsubscribed contacts are included regardless of the date on which they unsubscribed from the directory. | |
skipToken | string | The start position for pagination |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"contactId":"CID_012345678901234","firstName":"exampleFirstName0","lastName":"exampleLastName0","email":"example0@example.com","phone":"0000000000","extRef":"reference.com","language":"es","directoryUnsubscribed":false,"directoryUnsubscribeDate":null},{"contactId":"CID_012345678901235","firstName":"exampleFirstName1","lastName":"exampleLastName1","email":"example1@example.com","extRef":"reference.com","phone":null,"language":"de","directoryUnsubscribed":false,"directoryUnsubscribeDate":null}],"nextPage":null},"meta":{"requestId":"9699867f-7c37-49ce-8ff1-c34c5c845197","httpStatus":"200 - OK"}}