Search people
Quota limitation
Results received from this endpoint count towards the people search quota
Credits
When credit charging is enabled for your account, each call deducts ⌈results returned / 10⌉ ICP search credits (e.g. 1 to 10 results = 1 credit, 11 to 20 results = 2 credits, 21 to 30 results = 3 credits). Credits are charged on results returned, not limit — only the last page may return fewer results than requested. For optimal credit usage, request results in multiples of 10 (e.g. limit: 10, 20, 100).
Search for people based on the provided filters. Note that some filters only accept pre-defined values, as provided by the filters endpoint.
Job title matching
Job titles provided in peopleFilters.jobTitles are expanded automatically:
- Acronym matching is bidirectional — searching for
"CTO"also matches"Chief Technology Officer", and vice versa. You do not need to submit both forms. - Semantic matching additionally surfaces closely related titles. For example,
"Director of Engineering"may also match"VP of Engineering"or"Head of Engineering";"CTO"may also match"VP of Technology". - Exact matches appear first in results; semantic matches appear lower.
If you need stricter matching (exact titles only, no semantic expansion), contact api.support@surfe.com — this can be enabled per integration.
Example request
Pagination
Use the nextPageToken field from the response to fetch the next page. Pass it as pageToken in your next request — the original filters are reused automatically.
Authorization
AuthorizationRequiredBearer <token>In: header
Request Body
application/jsonRequiredList of filters to use as search criteria
companiesobjectlimitintegerLimit - Is the maximum amount of results per page, must be between 1 and 200
10Minimum: 1Maximum: 200organizationIDMappingsobjectMapping of an organization domain to its corresponding ID. Search results associated with the same organization will return this ID in the externalID field
pageTokenstringPageToken - token to retrieve the next page of results. When provided, the filters originally used for the first page are reused and any changes to filters are ignored.
peopleobjectpeoplePerCompanyintegerPeoplePerCompany - Limits the number of people returned per company when searching by domain or name only. Valid values are between 1 and 5. For more in-depth results, search using a single domain and omit this parameter. This field is ignored if the search includes criteria beyond domain or name.
List of people found