Paginated list of participants in a study
Get a paginated list of participants in a study
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/participants/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"operator": "AND",
"filters": [
{
"customProperty": {
"propertyType": "STRING",
"propertyGroup": "CUSTOM_PROPERTY",
"propertyName": "CUSTOM_PROPERTY",
"propertyId": "custom_property_1",
"operator": "IS",
"value": "some value"
}
}
]
},
"pageInfo": {
"size": 10
}
}'{
"results": [
{
"participantId": "<string>",
"personId": "<string>",
"studyId": "<string>",
"email": "<string>",
"additionalEmails": [
"jsmith@example.com"
],
"status": "NOT_STARTED",
"invitedToStudyAt": "2023-11-07T05:31:56Z",
"approvalStatus": "HIDDEN",
"approvedAt": "2023-11-07T05:31:56Z",
"screenerState": "SCREENER_SENT",
"screenerSentAt": "2023-11-07T05:31:56Z",
"addedToStudyAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Filter option to search for people
A custom property filter
BOOLEAN CUSTOM_PROPERTY EQUAL, NOT_EQUAL {
"propertyType": "STRING",
"propertyGroup": "CUSTOM_PROPERTY",
"propertyName": "CUSTOM_PROPERTY",
"propertyId": "custom_property_1",
"operator": "IS",
"value": "some value"
}
AND, OR Pagination arguments. Use startCursor from the result of the endCursor of the response to get the next page. Pagination in reverse is not currently supported
Response
A study's participant information
The ID of the participant
The ID of the person
The ID of the study
The primary email of the participant
The additional emails of the participant
The status of the participant
NOT_STARTED, INVITE_SENT, NOT_ELIGIBLE, SCREENER_STARTED, SCREENER_COMPLETED, SCREENER_QUALIFIED, SCREENER_DISQUALIFIED, INTERVIEW_INVITE_SENT, INTERVIEW_SCHEDULED, INTERVIEW_COMPLETED, INTERVIEW_CANCELLED, INTERVIEW_NO_SHOWED, SURVEY_STARTED, SURVEY_COMPLETED, INCENTIVE_SENT, INCENTIVE_CLAIMED, UNMODERATED_TEST_INVITE_SENT, UNMODERATED_TEST_STARTED, UNMODERATED_TEST_COMPLETED, COMPLETED_STUDY, CANCELLED, OPTED_OUT, EMAIL_SOFT_BOUNCED, EMAIL_HARD_BOUNCED The date the participant was invited to the study
The approval status of the participant
HIDDEN, AWAITING_APPROVAL, APPROVED, REJECTED, REPORTED The date the participant was approved
The screener state of the participant
SCREENER_SENT, SCREENER_COMPLETED, QUALIFIED, AUTO_QUALIFIED, NOT_QUALIFIED, AUTO_NOT_QUALIFIED The date the screener was sent
The date the participant was added to the study
The total number of items in your workspaces based on your search parameters
x > 0Information about the current page
Whether there are additional pages of results
Whether there is a prior page of results
The start of the current page of results
The end of the current page of results. Use to fetch the next page
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/participants/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"operator": "AND",
"filters": [
{
"customProperty": {
"propertyType": "STRING",
"propertyGroup": "CUSTOM_PROPERTY",
"propertyName": "CUSTOM_PROPERTY",
"propertyId": "custom_property_1",
"operator": "IS",
"value": "some value"
}
}
]
},
"pageInfo": {
"size": 10
}
}'{
"results": [
{
"participantId": "<string>",
"personId": "<string>",
"studyId": "<string>",
"email": "<string>",
"additionalEmails": [
"jsmith@example.com"
],
"status": "NOT_STARTED",
"invitedToStudyAt": "2023-11-07T05:31:56Z",
"approvalStatus": "HIDDEN",
"approvedAt": "2023-11-07T05:31:56Z",
"screenerState": "SCREENER_SENT",
"screenerSentAt": "2023-11-07T05:31:56Z",
"addedToStudyAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}