List Samples
GET {{baseUrl}}/directories/:directoryId/samples?pageSize=100&skipToken=<string>
Return a list of all samples in a directory <!--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 |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"sampleId":"\u003cstring\u003e","parentGroupId":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","category":"\u003cstring\u003e","creatorId":"\u003cstring\u003e","ownerId":"\u003cstring\u003e","contactCount":0,"hidden":"\u003cboolean\u003e","frozen":"\u003cboolean\u003e","creationLogic":{}},{"sampleId":"\u003cstring\u003e","parentGroupId":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","category":"\u003cstring\u003e","creatorId":"\u003cstring\u003e","ownerId":"\u003cstring\u003e","contactCount":0,"hidden":"\u003cboolean\u003e","frozen":"\u003cboolean\u003e","creationLogic":{}}],"nextPage":"\u003cstring\u003e"},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}