List Contacts In Mailing List
GET {{baseUrl}}/directories/:directoryId/mailinglists/:mailingListId/contacts?pageSize=50&skipToken=<string>&includeEmbedded=<boolean>
Return a list of contacts in a specified mailing list.
<!--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.
The maximum value for
pageSizeis 50.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 | |
includeEmbedded | string | Whether embeddedData is returned in the response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"contactId":"\u003cstring\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","extRef":"\u003cstring\u003e","language":"\u003cstring\u003e","unsubscribed":"\u003cboolean\u003e","embeddedData":{"eu686":"dolor minim incididunt"}},{"contactId":"\u003cstring\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","extRef":"\u003cstring\u003e","language":"\u003cstring\u003e","unsubscribed":"\u003cboolean\u003e","embeddedData":{"ex_9":"sit in nulla","esse2":"consectet"}}],"nextPage":"\u003cstring\u003e"},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}