cURL
curl --request POST \ --url https://api.rallyuxr.com/api/public/v1/studies/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "filter": { "filters": [ { "propertyType": "DATETIME", "propertyName": "CREATED", "operator": "IS", "value": "TODAY", "timestamp": 123, "exactDate": "2023-12-25", "amount": 123, "days": 123, "propertyGroup": "STUDY" } ], "operator": "AND" }, "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>" } }
Get a paginated list of studies in your workspace
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Filter option to search for studies
Show child attributes
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
{ "size": 10 }
The studies metadata
The total number of items in your workspaces based on your search parameters
Information about the current page