List Contacts In Segment
GET {{baseUrl}}/directories/:directoryId/segments/:segmentId/contacts?pageSize=50&skipToken=sed ut sit
Return a list of all contacts in a specified mailing list.
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":"Duis officia proident sit ut","lastName":"nisi culpa","email":"anim exercitation","phone":"reprehenderit Excepteur","extRef":"minim et amet cup","language":"cupidatat Lorem labore","directoryUnsubscribed":false,"directoryUnsubscribeDate":"1986-03-07T02:56:04.621Z","segmentUnsubscribed":false,"segmentUnsubscribeDate":"1985-01-29T13:14:59.978Z"},{"contactId":"CID_012345678901234","firstName":"commodo magna","lastName":"dolor ullamco non","email":"Duis laboris","phone":"enim nulla","extRef":"sit dolore","language":"laboris est esse","directoryUnsubscribed":true,"directoryUnsubscribeDate":"1961-05-29T05:35:04.964Z","segmentUnsubscribed":true,"segmentUnsubscribeDate":"2017-04-12T22:10:58.174Z"}],"nextPage":"enim dolor nostrud aliqua quis"},"meta":{"httpStatus":"proident commodo aute ut","requestId":"laboris adipisicing anim officia","notice":"nisi"}}