Studies
Get paginated list of studies in your workspace.
Get a paginated list of studies in your workspace
POST
/
studies
/
search
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"operator": "AND",
"filters": [
{
"propertyType": "DATETIME",
"propertyGroup": "STUDY",
"propertyName": "CREATED",
"operator": "IS",
"value": "TODAY",
"timestamp": 123,
"exactDate": "<string>",
"days": 123
}
]
},
"pageInfo": {
"size": 10
}
}'
{
"results": [
{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveType": "MONEY_OR_GIFT_CARD",
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en"
},
"createdAt": "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.
Body
application/json
Response
200
application/json
The studies metadata
The response is of type object
.
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"operator": "AND",
"filters": [
{
"propertyType": "DATETIME",
"propertyGroup": "STUDY",
"propertyName": "CREATED",
"operator": "IS",
"value": "TODAY",
"timestamp": 123,
"exactDate": "<string>",
"days": 123
}
]
},
"pageInfo": {
"size": 10
}
}'
{
"results": [
{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveType": "MONEY_OR_GIFT_CARD",
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}