Get Participants Post
POST {{baseUrl}}/ex-projects/:projectId/participants?includeMetadata=false&pageSize=25&includeParticipantData=false
Retrieves all participants in the specified EX project.
Only use
skipToken
parameter after first requestYou should only use the
skipToken
parameter when it is returned in the response body after your first call to the API. Use theskipToken
parameter to paginate through the response.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
includeMetadata | boolean | Whether metadata should be included or not (default). | |
pageSize | number | Maximum number of items to return in a given response. | |
includeParticipantData | boolean | Whether participant data for EE project or subject data for 360 project should be included or not (default). |
Request Body
{"uniqueIdentifier"=>"<string>", "skipToken"=>"<string>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
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"}