Get a paginated list of study templates
curl --request GET \
--url https://api.rallyuxr.com/api/public/v1/studies/templates \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01T00:00:00Z",
"endDate": "2025-01-02T00:00:00Z",
"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"
}
}
],
"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.
Query Parameters
The cursor to start fetching from
The number of items to fetch
0 < x < 100Response
The type of study
SURVEY, INTERVIEWS, UNMODERATED_TEST, GROUP_INTERVIEW The recruitment strategy for the study
IN_RALLY, EXTERNAL Study plan object
The internal name of the study
The external name of the study
The internal description of the study
The external description of the study
The start date of the study in ISO 8601 in UTC(with no offset). The time is truncated
The end date of the study in ISO 8601 in UTC(with no offset). The time is truncated
The URL of the research plan
The participation limit of the study
The ID of the consent form
The incentive details for the study
The type of incentive
MONEY_OR_GIFT_CARD, MONEY_OR_GIFT_CARD_WITH_TREMENDOUS, EXTERNAL_MONEY_OR_GIFT_CARD, CHARITY, CUSTOM, RESPONDENT_MONEY, RECRUITMENT_FEE The ID of the incentive budget
The amount of the incentive
If type is CUSTOM then the ID of the custom incentive
If type is CUSTOM then the default value of the custom incentive
Whether to include a screener. If type is SURVEY the default is true, if not then false
The ID of the branding configuration
The language code for the study
en, es, fr, it, ro, pt, pl, de, nl, ja 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 GET \
--url https://api.rallyuxr.com/api/public/v1/studies/templates \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01T00:00:00Z",
"endDate": "2025-01-02T00:00:00Z",
"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"
}
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}