Search for people

curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/people/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attachProperties": [
    "EMAIL",
    "FIRST_NAME",
    "LAST_NAME"
  ],
  "allowlistInternalProperties": [
    "NAME",
    "CONTACT_STATUS",
    "OPTED_OUT"
  ],
  "blocklistInternalProperties": [
    "NAME"
  ],
  "segmentIds": [
    "<string>"
  ],
  "studyIds": [
    "<string>"
  ],
  "panelIds": [
    "<string>"
  ],
  "peopleIds": [
    "<string>"
  ],
  "studyId": "<string>",
  "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": [
    {
      "personId": "<string>",
      "email": "<string>",
      "properties": [
        {
          "propertyType": "STRING",
          "propertyId": "cm0b4eokq000vbbsimwelll3u",
          "value": "Blue"
        }
      ],
      "populationIds": [
        "<string>"
      ]
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  },
  "errors": [
    {
      "errorCode": "UNAUTHORIZED",
      "propertyId": "<string>"
    }
  ]
}

POST

people

Search for people

curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/people/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attachProperties": [
    "EMAIL",
    "FIRST_NAME",
    "LAST_NAME"
  ],
  "allowlistInternalProperties": [
    "NAME",
    "CONTACT_STATUS",
    "OPTED_OUT"
  ],
  "blocklistInternalProperties": [
    "NAME"
  ],
  "segmentIds": [
    "<string>"
  ],
  "studyIds": [
    "<string>"
  ],
  "panelIds": [
    "<string>"
  ],
  "peopleIds": [
    "<string>"
  ],
  "studyId": "<string>",
  "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": [
    {
      "personId": "<string>",
      "email": "<string>",
      "properties": [
        {
          "propertyType": "STRING",
          "propertyId": "cm0b4eokq000vbbsimwelll3u",
          "value": "Blue"
        }
      ],
      "populationIds": [
        "<string>"
      ]
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  },
  "errors": [
    {
      "errorCode": "UNAUTHORIZED",
      "propertyId": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Search for people

attachProperties

string[]

List of the propertyIds of custom properties to attach to the response for each person

Maximum array length: 10

Example:

["EMAIL", "FIRST_NAME", "LAST_NAME"]

allowlistInternalProperties

enum<string>[]

List of rally properties to include in the response. If this or blocklistInternalProperties is not included we will return all internal properties

Available options:

NAME,

FIRST_NAME,

LAST_NAME,

EMAIL,

PHONE,

IMPORT_SOURCE,

IMPORT_DATE,

OPTED_OUT,

LAST_CONTACT_DATE,

TOTAL_SENT_LAST_YEAR,

TOTAL_SENT_LAST_CALENDAR_YEAR,

TOTAL_SENT_ALL_TIME,

IMPORT_DATE,

IMPORT_SOURCE,

INVITED_TO_STUDY,

INVITED_TO_STUDY_L30,

INVITED_TO_STUDY_L90,

INVITED_TO_STUDY_L365,

TOTAL_NUMBER_OF_CONTACT,

TOTAL_NUMBER_OF_CONTACT_L30,

TOTAL_NUMBER_OF_CONTACT_L90,

TOTAL_NUMBER_OF_CONTACT_L365,

LAST_INTERVIEW_DATE,

OPTED_OUT,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L30,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L90,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L365,

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,

CONTACT_STATUS,

POPULATION_MEMBERSHIP,

POPULATION_LIST_MEMBERSHIP,

SIGNUP_REFERRAL_CODES,

LAST_CHANGED_AT

Example:

["NAME", "CONTACT_STATUS", "OPTED_OUT"]

blocklistInternalProperties

enum<string>[]

List of rally properties to exclude from the response

Available options:

NAME,

FIRST_NAME,

LAST_NAME,

EMAIL,

PHONE,

IMPORT_SOURCE,

IMPORT_DATE,

OPTED_OUT,

LAST_CONTACT_DATE,

TOTAL_SENT_LAST_YEAR,

TOTAL_SENT_LAST_CALENDAR_YEAR,

TOTAL_SENT_ALL_TIME,

IMPORT_DATE,

IMPORT_SOURCE,

INVITED_TO_STUDY,

INVITED_TO_STUDY_L30,

INVITED_TO_STUDY_L90,

INVITED_TO_STUDY_L365,

TOTAL_NUMBER_OF_CONTACT,

TOTAL_NUMBER_OF_CONTACT_L30,

TOTAL_NUMBER_OF_CONTACT_L90,

TOTAL_NUMBER_OF_CONTACT_L365,

LAST_INTERVIEW_DATE,

OPTED_OUT,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L30,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L90,

TOTAL_NUMBER_OF_INTERVIEWS_COMPLETED_L365,

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,

CONTACT_STATUS,

POPULATION_MEMBERSHIP,

POPULATION_LIST_MEMBERSHIP,

SIGNUP_REFERRAL_CODES,

LAST_CHANGED_AT

segmentIds

string[]

deprecated

List of segment IDs to filter people by

Maximum array length: 100

studyIds

string[]

deprecated

List of study IDs to filter people by

Maximum array length: 100

panelIds

string[]

deprecated

List of panel IDs to filter people by

Maximum array length: 100

peopleIds

string[]

List of person IDs to filter people by

Maximum array length: 100

studyId

string

The ID of the study to filter people by

filter

object

Filters to apply to the search. This and the deprecated top level filters cannot be used at the same time

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

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7

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 The cursor to start from

pageInfo.size

number

default:20

The number of items to return The number of items to return

Required range: 0 < x <= 50

Example:

10

Example:

{ "size": 10 }

Response

Successfully retrieved people

Response for a search of people

results

object[]

required

Show child attributes

results.personId

string

required

The ID of the person

results.email

string | null

required

The email of the person

results.properties

object[]

required

A property of a person, both internal and custom

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8

Show child attributes

results.properties.propertyType

enum<string>

required

Available options:

NUMBER

results.properties.propertyId

string

required

results.properties.value

number | null

required

Example:

{
  "propertyType": "STRING",
  "propertyId": "cm0b4eokq000vbbsimwelll3u",
  "value": "Blue"
}

results.populationIds

string[]

required

List of populationIds for populations the person is in

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

errors

object[]

required

Show child attributes

errors.errorCode

enum<string>

required

Available options:

UNAUTHORIZED

errors.propertyId

string

required

Get paginated list of panels Import people

⌘I

Backfills

Person

Imports

Incentives

Panels

People

Populations

Person Properties

Segments

Studies

Participants

Teams

Users

API Reference

Search for people

Authorizations

Body

Response