Search for people using a natural language prompt. Returns results and optional filter suggestions.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
AI search for people
Natural language prompt to search for people
1"People in California who have done at least 3 studies"
List of the propertyIds of custom properties to attach to the response for each person
25["EMAIL", "FIRST_NAME", "LAST_NAME"]List of rally properties to include in the response. If this or blocklistInternalProperties is not included we will return all internal properties
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, 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, 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 ["NAME", "CONTACT_STATUS", "OPTED_OUT"]List of rally properties to exclude from the response
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, 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, 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 The ID of the study to filter people by
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
{ "size": 10 }Successfully retrieved people
Response for AI search of people
The total number of items in your workspaces based on your search parameters
Information about the current page
true Filter option to search for people