CASE FrameworkParticipant APIParticipant data
Get survey responses for a profile
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Path Parameters
studyKey*string
Query Parameters
pid?string
Profile ID
surveyKey?string
page?integer
page number (starting from 1)
Default
1Range
1 <= valuelimit?integer
maximum number of responses per page
Default
10Range
1 <= valuefilter?
bson.M object to filter responses
sort?
bson.M object to sort responses
shortKeys?boolean
whether to return short keys for responses
Default
falsequestionOptionSep?string
character used to seperate slot keys in response
Default
"-"format?string
format for survey responses
Default
"wide"Value in
"wide" | "long" | "json"extraContextColumns?string
comma-separated list of extra context columns to include in the response
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/study-service/participant-data/string/responses"{
"responses": [
{
"property1": {},
"property2": {}
}
],
"pagination": {
"totalCount": 0,
"currentPage": 0,
"totalPages": 0,
"pageSize": 0
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}