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>"
  }
}

POST

studies

{studyId}

participants

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

Show child attributes

filter.filters

object[]

required

Maximum array length: 50

A filter for searching for people

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

filter.filters.customProperty

object

required

A custom property filter

Show child attributes

filter.filters.customProperty.propertyType

enum<string>

required

Available options:

BOOLEAN

filter.filters.customProperty.propertyId

string

required

filter.filters.customProperty.operator

enum<string>

required

Available options:

EQUAL,

NOT_EQUAL

filter.filters.customProperty.value

boolean

required

filter.filters.customProperty.propertyName

enum<string>

Available options:

CUSTOM_PROPERTY

filter.filters.customProperty.propertyGroup

enum<string>

Available options:

CUSTOM_PROPERTY

Example:

{
  "propertyType": "STRING",
  "propertyGroup": "CUSTOM_PROPERTY",
  "propertyName": "CUSTOM_PROPERTY",
  "propertyId": "custom_property_1",
  "operator": "IS",
  "value": "some value"
}

filter.operator

enum<string>

default:AND

Available options:

AND,

OR

filter.sort

object

Sorting to apply to the search

Option 1
Option 2
Option 3

Show child attributes

filter.sort.operator

enum<string>

required

Available options:

ASC,

DESC

filter.sort.propertyGroup

enum<string>

required

Available options:

PERSON

filter.sort.propertyName

enum<string>

required

Available options:

PERSON_ID,

NAME,

FIRST_NAME,

LAST_NAME,

EMAIL,

PHONE,

IMPORT_SOURCE,

IMPORT_DATE,

OPTED_OUT,

LAST_CONTACT_DATE,

STUDY_MEMBERSHIP,

SEGMENT_MEMBERSHIP,

POPULATION_MEMBERSHIP,

POPULATION_LIST_MEMBERSHIP,

INVITED_TO_STUDY,

INVITED_TO_STUDY_L30,

INVITED_TO_STUDY_L90,

INVITED_TO_STUDY_L365,

TOTAL_SENT_LAST_YEAR,

TOTAL_SENT_LAST_CALENDAR_YEAR,

TOTAL_SENT_ALL_TIME,

TOTAL_NUMBER_OF_CONTACT,

TOTAL_NUMBER_OF_CONTACT_L30,

TOTAL_NUMBER_OF_CONTACT_L90,

TOTAL_NUMBER_OF_CONTACT_L365,

LAST_INTERVIEW_DATE,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L30,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L90,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L365,

TOTAL_NUMBER_OF_NO_SHOW_INTERVIEWS,

SHOW_RATE,

LAST_UNMOD_TEST_DATE,

TOTAL_NUMBER_OF_UNMOD_TESTS_COMPLETED,

TOTAL_NUMBER_OF_UNMOD_TESTS_COMPLETED_L30,

TOTAL_NUMBER_OF_UNMOD_TESTS_COMPLETED_L90,

TOTAL_NUMBER_OF_UNMOD_TESTS_COMPLETED_L365,

LAST_SURVEY_DATE,

TOTAL_NUMBER_OF_SURVEYS_COMPLETED,

TOTAL_NUMBER_OF_SURVEYS_COMPLETED_L30,

TOTAL_NUMBER_OF_SURVEYS_COMPLETED_L90,

TOTAL_NUMBER_OF_SURVEYS_COMPLETED_L365,

PARTICIPANT_RATING,

TOTAL_RATINGS,

CONTACT_STATUS,

CONTACT_STATUS_UPDATE_DATE,

IMPORT_UPLOAD_LIST,

CONSENT_SUBMISSIONS,

LAST_CHANGED_AT,

SIGNUP_REFERRAL_CODES,

SCREENER_STATUS,

SCREENER_SUBMITTED_AT,

CONSENT_FORM_WAS_SUBMITTED,

FORM_SIGNEDUP_AT,

FORM_APPROVAL_STATUS,

FORM_FIRST_SIGNUP_REFERRAL_CODE,

FORM_LAST_SIGNUP_REFERRAL_CODE,

PANEL_MEMBERSHIP

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

Show child attributes

pageInfo.startCursor

string

The cursor to start from

pageInfo.size

number

default:25

The number of items to return

Required range: x <= 50

Example:

10

Example:

{ "size": 10 }

Response

The participants

results

object[]

required

Show child attributes

results.participantId

string

required

The ID of the participant

results.personId

string

required

The ID of the person

results.studyId

string

required

The ID of the study

results.email

string | null

required

The primary email of the participant

results.additionalEmails

string<email>[]

required

The additional emails of the participant

results.phone

string | null

required

The primary phone of the participant

results.additionalPhones

string[]

required

The additional phones of the participant

results.status

enum<string> | null

required

The status of the participant

Available options:

NOT_STARTED,

INVITE_SENT,

NOT_ELIGIBLE,

SCREENER_STARTED,

SCREENER_COMPLETED,

SCREENER_QUALIFIED,

SCREENER_DISQUALIFIED,

INTERVIEW_INVITE_SENT,

INTERVIEW_SCHEDULED,

INTERVIEW_COMPLETED,

INTERVIEW_CANCELLED,

INTERVIEW_NO_SHOWED,

SURVEY_STARTED,

SURVEY_COMPLETED,

INCENTIVE_SENT,

INCENTIVE_CLAIMED,

INCENTIVE_SKIPPED,

UNMODERATED_TEST_INVITE_SENT,

UNMODERATED_TEST_STARTED,

UNMODERATED_TEST_COMPLETED,

COMPLETED_STUDY,

CANCELLED,

OPTED_OUT,

EMAIL_SOFT_BOUNCED,

EMAIL_HARD_BOUNCED

results.invitedToStudyAt

string<date-time> | null

required

The date the participant was invited to the study

results.approvalStatus

enum<string>

required

The approval status of the participant

Available options:

HIDDEN,

AWAITING_APPROVAL,

APPROVED,

REJECTED,

REPORTED

results.approvedAt

string<date-time> | null

required

The date the participant was approved

results.screenerState

enum<string> | null

required

The screener state of the participant

Available options:

SCREENER_SENT,

SCREENER_COMPLETED,

QUALIFIED,

AUTO_QUALIFIED,

NOT_QUALIFIED,

AUTO_NOT_QUALIFIED

results.screenerSentAt

string<date-time> | null

required

The date the screener was sent

results.addedToStudyAt

string<date-time> | null

required

The date the participant was added to the study

results.note

object

required

The note of the participant

Show child attributes

results.note.note

string | null

required

The note of the person

results.note.createdByUserId

string | null

required

The ID of the user who created the note

total

number

required

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

pageInfo

object

required

Information about the current page

Show child attributes

pageInfo.hasNextPage

boolean

required

Whether there are additional pages of results

pageInfo.hasPreviousPage

boolean

required

Whether there is a prior page of results

pageInfo.startCursor

string

The start of the current page of results

pageInfo.endCursor

string

The end of the current page of results. Use to fetch the next page

Get the transcript for an observer room bot Import participants to a study

⌘I

Backfills

Person

Imports

Incentives

Panels

People

Populations

Person Properties

Segments

Studies

Participants

Teams

Users

API Reference

Paginated list of participants in a study

Authorizations

Path Parameters

Body

Response