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 request

You should only use the skipToken parameter when it is returned in the response body after your first call to the API. Use the skipToken parameter to paginate through the response.

Request Params

KeyDatatypeRequiredDescription
includeMetadatabooleanWhether metadata should be included or not (default).
pageSizenumberMaximum number of items to return in a given response.
includeParticipantDatabooleanWhether participant data for EE project or subject data for 360 project should be included or not (default).

Request Body

{"uniqueIdentifier"=>"<string>", "skipToken"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;participants&quot;:[{&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;username&quot;:&quot;\u003cstring\u003e&quot;,&quot;userId&quot;:&quot;\u003cstring\u003e&quot;,&quot;participantId&quot;:&quot;\u003cstring\u003e&quot;,&quot;uniqueIdentifier&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;aliqua5&quot;:&quot;\u003cstring\u003e&quot;,&quot;sint_4b&quot;:&quot;\u003cstring\u003e&quot;,&quot;voluptate_85&quot;:&quot;\u003cstring\u003e&quot;},&quot;participantData&quot;:{&quot;respondent&quot;:&quot;\u003cstring\u003e&quot;,&quot;complete&quot;:&quot;\u003cstring\u003e&quot;},&quot;subjectData&quot;:{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;nominationsSent&quot;:&quot;\u003cstring\u003e&quot;,&quot;evaluationsReceived&quot;:&quot;\u003cstring\u003e&quot;,&quot;nominationsReceived&quot;:&quot;\u003cstring\u003e&quot;,&quot;completedEvaluations&quot;:&quot;\u003cstring\u003e&quot;,&quot;selfEvaluationComplete&quot;:&quot;\u003cstring\u003e&quot;,&quot;external&quot;:&quot;\u003cstring\u003e&quot;,&quot;reportAvailable&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;username&quot;:&quot;\u003cstring\u003e&quot;,&quot;userId&quot;:&quot;\u003cstring\u003e&quot;,&quot;participantId&quot;:&quot;\u003cstring\u003e&quot;,&quot;uniqueIdentifier&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;proident39d&quot;:&quot;\u003cstring\u003e&quot;},&quot;participantData&quot;:{&quot;respondent&quot;:&quot;\u003cstring\u003e&quot;,&quot;complete&quot;:&quot;\u003cstring\u003e&quot;},&quot;subjectData&quot;:{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;nominationsSent&quot;:&quot;\u003cstring\u003e&quot;,&quot;evaluationsReceived&quot;:&quot;\u003cstring\u003e&quot;,&quot;nominationsReceived&quot;:&quot;\u003cstring\u003e&quot;,&quot;completedEvaluations&quot;:&quot;\u003cstring\u003e&quot;,&quot;selfEvaluationComplete&quot;:&quot;\u003cstring\u003e&quot;,&quot;external&quot;:&quot;\u003cstring\u003e&quot;,&quot;reportAvailable&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;},&quot;skipToken&quot;:&quot;\u003cstring\u003e&quot;}