API Reference

Search for people

post
https://api.rallyuxr.com/api/public/v1/people/search

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Search for people

attachProperties
array of strings
length ≤ 10

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

attachProperties
segmentIds
array of strings
length ≤ 100
deprecated

List of segment IDs to filter people by

segmentIds
studyIds
array of strings
length ≤ 100
deprecated

List of study IDs to filter people by

studyIds
panelIds
array of strings
length ≤ 100
deprecated

List of panel IDs to filter people by

panelIds
peopleIds
array of strings
length ≤ 100

List of person IDs to filter people by

peopleIds
filter
object

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated over 1 year ago