Get All Participants [Deprecated]
GET {{baseUrl}}/employee-directories/:directoryId/participants?includeMetadata=false&skipToken=<string>&pageSize=25&uniqueIdentifier=<string>
Please use the POST API instead. Gets all participants, in the specified Directory.
Preview Functionality
This API is not yet generally available. It is available as part of Early Access to receive feedback. Be aware that there may be significant changes to this API with short notice until the time that the API is made Generally Available.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
includeMetadata | boolean | Whether metadata should be included or not (default). | |
skipToken | string | The start position for pagination. Comes back as response body of the previous call, if there is more paginated data | |
pageSize | number | Maximum number of items to return in a given response. | |
uniqueIdentifier | string | Unique Identifier of a specific participant. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"participants":[{"firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","email":"\u003cemail\u003e","username":"\u003cstring\u003e","userId":"\u003cstring\u003e","participantId":"\u003cstring\u003e","uniqueIdentifier":"\u003cstring\u003e","metadata":{"aliqua5":"\u003cstring\u003e","sint_4b":"\u003cstring\u003e","voluptate_85":"\u003cstring\u003e"},"participantData":{"respondent":"\u003cstring\u003e","complete":"\u003cstring\u003e"},"subjectData":{"status":"\u003cstring\u003e","nominationsSent":"\u003cstring\u003e","evaluationsReceived":"\u003cstring\u003e","nominationsReceived":"\u003cstring\u003e","completedEvaluations":"\u003cstring\u003e","selfEvaluationComplete":"\u003cstring\u003e","external":"\u003cstring\u003e","reportAvailable":"\u003cstring\u003e"}},{"firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","email":"\u003cemail\u003e","username":"\u003cstring\u003e","userId":"\u003cstring\u003e","participantId":"\u003cstring\u003e","uniqueIdentifier":"\u003cstring\u003e","metadata":{"proident39d":"\u003cstring\u003e"},"participantData":{"respondent":"\u003cstring\u003e","complete":"\u003cstring\u003e"},"subjectData":{"status":"\u003cstring\u003e","nominationsSent":"\u003cstring\u003e","evaluationsReceived":"\u003cstring\u003e","nominationsReceived":"\u003cstring\u003e","completedEvaluations":"\u003cstring\u003e","selfEvaluationComplete":"\u003cstring\u003e","external":"\u003cstring\u003e","reportAvailable":"\u003cstring\u003e"}}],"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"},"skipToken":"\u003cstring\u003e"}