Search people
POST/people/search
Searches for people in the external API using the supplied criteria and stores the results in the database.
Request Body
- q_keywords (str): Search keywords (optional).
- q_organization_domains (str): Organization domains to filter the search (optional).
- person_titles (List[str]): Person job titles to filter the search (optional).
- person_locations (List[str]): Person locations to filter the search (optional).
- person_seniorities (List[str]): Person seniority levels to filter the search (optional).
- organization_ids (List[str]): Organization IDs to filter the search (optional).
- organization_locations (List[str]): Organization locations to filter the search (optional).
- organization_num_employees_ranges (List[str]): Organization employee-count ranges to filter the search (optional).
- contact_email_status (List[str]): Contact email status to filter the search (optional).
- prospected_by_current_team (List[str]): Filters by current team members who prospected (optional).
- page (PositiveInt): Page number for pagination.
- per_page (PositiveInt): Number of items per page for pagination.
Request Body Example
{
"q_keywords": "engineer",
"q_organization_domains": "example.com",
"person_titles": ["Senior Engineer", "Lead Engineer"],
"person_locations": ["New York", "San Francisco"],
"person_seniorities": ["Senior", "Lead"],
"organization_ids": ["123", "456"],
"organization_locations": ["New York", "California"],
"organization_num_employees_ranges": ["100-500", "500-1000"],
"contact_email_status": ["verified", "unverified"],
"prospected_by_current_team": ["team1", "team2"],
"page": 1,
"per_page": 10
}
Possible Responses
- 200: Search completed successfully. Returns search results including contacts, people, and pagination.
- 204: No content returned by the external API.
- 500: Error calling the external API or accessing the database.
Response Example
{
"breadcrumbs": {
"q_keywords": "engineer",
"q_organization_domains": "example.com",
"person_titles": ["Senior Engineer", "Lead Engineer"],
"person_locations": ["New York", "San Francisco"],
"person_seniorities": ["Senior", "Lead"],
"organization_ids": ["123", "456"],
"organization_locations": ["New York", "California"],
"organization_num_employees_ranges": ["100-500", "500-1000"],
"contact_email_status": ["verified", "unverified"],
"prospected_by_current_team": ["team1", "team2"],
"contacts": [],
"people": [
{"name": "John Doe", "title": "Senior Engineer", "location": "New York"}
],
"pagination": {"page": 1, "total_pages": 10},
"requested_by": ["customer123"]
},
"response": {"id": 1, "field": "value"}
}
Contract Caveat
The source example uses breadcrumbs/response, but the imported schema describes a model without that envelope. Confirm the deployed response before assuming either format; the schema has not been changed.
Request
Responses
- 200
- 204
- 422
- 500
Search completed successfully.
No content from the external API.
Validation Error
Error calling the external API or accessing the database.