Skip to main content
POST
/
studies
/
{studyId}
/
participants
/
search
Paginated list of participants in a study
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/participants/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "filters": [
      {
        "customProperty": {
          "propertyType": "STRING",
          "propertyGroup": "CUSTOM_PROPERTY",
          "propertyName": "CUSTOM_PROPERTY",
          "propertyId": "custom_property_1",
          "operator": "IS",
          "value": "some value"
        }
      }
    ],
    "operator": "AND",
    "sort": {
      "operator": "ASC",
      "propertyGroup": "PERSON",
      "propertyName": "PERSON_ID"
    }
  },
  "pageInfo": {
    "size": 10
  }
}
'
{
  "results": [
    {
      "participantId": "<string>",
      "personId": "<string>",
      "studyId": "<string>",
      "email": "<string>",
      "additionalEmails": [
        "[email protected]"
      ],
      "phone": "<string>",
      "additionalPhones": [
        "<string>"
      ],
      "status": "NOT_STARTED",
      "invitedToStudyAt": "2023-11-07T05:31:56Z",
      "approvalStatus": "HIDDEN",
      "approvedAt": "2023-11-07T05:31:56Z",
      "screenerState": "SCREENER_SENT",
      "screenerSentAt": "2023-11-07T05:31:56Z",
      "addedToStudyAt": "2023-11-07T05:31:56Z",
      "note": {
        "note": "<string>",
        "createdByUserId": "<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.

Path Parameters

​
studyId
string
required

Body

application/json
​
filter
object

Filter option to search for people

​
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 participants

​
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