Skip to main content
POST
/
studies
/
search
Get paginated list of studies in your workspace.
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",
      "owners": [
        {
          "userId": "<string>",
          "emailAccountId": "<string>",
          "fullname": "<string>",
          "email": "<string>"
        }
      ]
    }
  ],
  "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.

Body

application/json
​
filter
object

Filter option to search for studies

​
pageInfo
object

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

Example:
{ "size": 10 }

Response

The studies metadata

​
results
object[]
required
​
total
number
required

The total number of items in your workspaces based on your search parameters

​
pageInfo
object
required

Information about the current page