Get Sample Contacts
GET {{baseUrl}}/directories/:directoryId/samples/:sampleId/contacts?pageSize=50&skipToken=<string>&includeEmbedded=<boolean>
Retrieves a paginated list of contacts in a sample <!--From Readme--> <!-- 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 | |
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":{"eiusmod_a53":"\u003cstring\u003e"}},{"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":{"nostrud_7d":"\u003cstring\u003e"}}],"nextPage":"\u003cstring\u003e"},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}