GET
/
studies
/
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-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"
      }
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
startCursor
string

The cursor to start fetching from

​
size
number
default:10

The number of items to fetch

Required range: 0 < x <= 100
Example:

10

Response

200
application/json

The study templates

The response is of type object.