CASE FrameworkManagement APIParticipants
List participants
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Path Parameters
studyKey*string
Query Parameters
page?integer
page number (starting from 1)
Default
1Range
1 <= valuelimit?integer
maximum number of participants per page
Default
10Range
1 <= valuefilter?
bson.M object to filter participants
sort?
bson.M object to sort participants
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/studies/string/data-explorer/participants/"{
"participants": [
{
"id": "string",
"participantId": "string",
"currentStudySession": "string",
"modifiedAt": 0,
"enteredAt": 0,
"studyStatus": "string",
"flags": {
"property1": "string",
"property2": "string"
},
"linkingCodes": {
"property1": "string",
"property2": "string"
},
"assignedSurveys": [
{
"studyKey": "string",
"surveyKey": "string",
"validFrom": 0,
"validUntil": 0,
"category": "string",
"profileID": "string"
}
],
"lastSubmissions": {
"property1": 0,
"property2": 0
},
"messages": [
{}
]
}
],
"pagination": {
"totalCount": 0,
"currentPage": 0,
"totalPages": 0,
"pageSize": 0
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}