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

KeyDatatypeRequiredDescription
pageSizenumberThe maximum number of items to return per request
skipTokenstringThe start position for pagination

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;elements&quot;:[{&quot;sampleId&quot;:&quot;\u003cstring\u003e&quot;,&quot;parentGroupId&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;category&quot;:&quot;\u003cstring\u003e&quot;,&quot;creatorId&quot;:&quot;\u003cstring\u003e&quot;,&quot;ownerId&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactCount&quot;:0,&quot;hidden&quot;:&quot;\u003cboolean\u003e&quot;,&quot;frozen&quot;:&quot;\u003cboolean\u003e&quot;,&quot;creationLogic&quot;:{}},{&quot;sampleId&quot;:&quot;\u003cstring\u003e&quot;,&quot;parentGroupId&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;category&quot;:&quot;\u003cstring\u003e&quot;,&quot;creatorId&quot;:&quot;\u003cstring\u003e&quot;,&quot;ownerId&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactCount&quot;:0,&quot;hidden&quot;:&quot;\u003cboolean\u003e&quot;,&quot;frozen&quot;:&quot;\u003cboolean\u003e&quot;,&quot;creationLogic&quot;:{}}],&quot;nextPage&quot;:&quot;\u003cstring\u003e&quot;},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}