List Segments
GET {{baseUrl}}/directories/:directoryId/segments?pageSize=20&skipToken=<string>
Retrieve a paginated list of segment definitions in a directory.
This API call is only available to XM Directory users.
Rate Limits
This API allows you to make 60 calls per minute.
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":[{"criteria":{"simpleFilter":{"filterType":"anyField","comparison":"empty","value":"\u003cstring\u003e","mailingListId":"\u003cstring\u003e"}},"segmentId":"\u003cstring\u003e","contactCount":"\u003cinteger\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","creationDate":"\u003cstring\u003e","lastModifiedDate":"\u003cstring\u003e"},{"criteria":{"simpleFilter":{"filterType":"anyField","comparison":"neq","value":"\u003cstring\u003e","mailingListId":"\u003cstring\u003e"}},"segmentId":"\u003cstring\u003e","contactCount":"\u003cinteger\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","creationDate":"\u003cstring\u003e","lastModifiedDate":"\u003cstring\u003e"}],"nextPage":"\u003cstring\u003e"},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}