Studies

Get paginated list of studies in your workspace.

Get a paginated list of studies in your workspace

post/studies/search

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies/search
  • Auth: HTTP bearer

Request body

Example request

{
  "filter": {
    "filters": [
      {
        "propertyType": "SINGLE_SELECT",
        "propertyGroup": "STUDY",
        "propertyName": "STATUS",
        "operator": "IS",
        "value": "DRAFT"
      }
    ]
  },
  "pageInfo": {
    "size": 10
  }
}

Response

The studies metadata

totalnumber required

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

Example response

{
  "results": [
    {
      "studyPlan": {
        "startDate": "2025-01-01",
        "endDate": "2025-01-02",
        "scheduler": {
          "interviewDurationMinutes": 60
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.