People
Search for people
Search for people in your workspace. You can filter by studies, segments, and panels. Or just retrieve additional metadata about a list of person ids
POST
/
people
/
search
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/people/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"attachProperties": [
"<string>"
],
"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"
}
}
]
},
"pageInfo": {
"size": 10
}
}'
{
"results": [
{
"personId": "<string>",
"email": "<string>",
"properties": [
{
"propertyId": "<string>",
"propertyType": "SINGLE_SELECT",
"value": "2025-01-01"
}
],
"populationIds": [
"<string>"
]
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
},
"errors": [
{
"errorCode": "UNAUTHORIZED",
"propertyId": "<string>"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Search for people
Response
200
application/json
Successfully retrieved people
Response for a search of 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": [
"<string>"
],
"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"
}
}
]
},
"pageInfo": {
"size": 10
}
}'
{
"results": [
{
"personId": "<string>",
"email": "<string>",
"properties": [
{
"propertyId": "<string>",
"propertyType": "SINGLE_SELECT",
"value": "2025-01-01"
}
],
"populationIds": [
"<string>"
]
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
},
"errors": [
{
"errorCode": "UNAUTHORIZED",
"propertyId": "<string>"
}
]
}