Skip to main content
POST
/
people
/
search
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": {
    "operator": "AND",
    "filters": [
      {
        "customProperty": {
          "propertyType": "STRING",
          "propertyGroup": "CUSTOM_PROPERTY",
          "propertyName": "CUSTOM_PROPERTY",
          "propertyId": "custom_property_1",
          "operator": "IS",
          "value": "some value"
        }
      }
    ],
    "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 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

Example:
["NAME", "CONTACT_STATUS", "OPTED_OUT"]
​
blocklistInternalProperties
enum<string>[]

List of rally properties to exclude from the response

​
segmentIds
string[]
deprecated

List of segment IDs to filter people by

Maximum length: 100
​
studyIds
string[]
deprecated

List of study IDs to filter people by

Maximum length: 100
​
panelIds
string[]
deprecated

List of panel IDs to filter people by

Maximum length: 100
​
peopleIds
string[]

List of person IDs to filter people by

Maximum length: 100
​
studyId
string

The ID of the study to filter people by

​
filter
object

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

​
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

Successfully retrieved people

Response for a search of people

​
results
object[]
required
​
total
number
required

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

Required range: x > 0
​
pageInfo
object
required

Information about the current page

​
errors
object[]
required
⌘I