List Mailing Lists
GET {{baseUrl}}/directories/:directoryId/mailinglists?ownerId=<string>&pageSize=100&skipToken=<string>&includeCount=<boolean>
Return a list of the mailing lists in an XM Directory
<!--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.
contactCount is an approximate value, use list contacts api to get exact count.
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 |
|---|---|---|---|
ownerId | string | To query for shared mailing lists available to the user, set ownerId to a user-groupId. | |
pageSize | number | The maximum number of items to return per request | |
skipToken | string | The start position for pagination | |
includeCount | string | When set to true will include the contact count, when set false that count will show zero and the count will not occur. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"contactCount":0,"mailingListId":"\u003cstring\u003e","name":"\u003cstring\u003e","lastModifiedDate":"\u003cstring\u003e","creationDate":"\u003cstring\u003e","ownerId":"\u003cstring\u003e"},{"contactCount":0,"mailingListId":"\u003cstring\u003e","name":"\u003cstring\u003e","lastModifiedDate":"\u003cstring\u003e","creationDate":"\u003cstring\u003e","ownerId":"\u003cstring\u003e"}],"nextPage":"\u003cstring\u003e"},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}