Skip to main content

Search People API Endpoint

The Search People API Endpoint lets you perform a search in our APIs to fetch one or more people based on your chosen filters in Ocean.

Use case

An example use case is to find people working in a particular company, or a list of people that work for companies similar to your ideal customer.

Step-by-step guide

Here's a step-by-step guide to make an API call to the Search People API Endpoint, using Postman.

Click on + in your workspace to add a new call.

Ensure the request type is set to POST

Copy and paste the link below into the Enter URL or paste text field, where you replace XXX with your API token (need help to find your API token?)

Ensure you add Content-Type: application/json in your Headers.

In the Body, parse whatever filters you want to apply to the search. For instance, if you want to find "Founders" working in Lookalike companies in Germany to pandadoc.com, you would use the body below in your request. Click here for the full list of possible attributes to parse.

{
"peopleFilters": {
"seniorities": [
"Founder"
],
},
"companiesFilters": {
"lookalikeDomains": [
"pandadoc.com",
],
"primaryCountries": [
"de"
],
},
}

Ensure you choose JSON in the Body, before hitting Send and make your call.

That's it! Now you get a list of Founders working in Lookalike companies to pandadoc.com with their primary location in Germany.

Getting the next page

If you don't parse a different "size" parameter, the default returned maximum results is 50. There are often more than 50 results available, so how do you get to the next "page" of results?

You do that by copying the "searchAfter" property that was returned to you:

And use that in your next API call, by adding it to the request body:

That way, you will receive the next 50 results, or whatever number you have specified in "size" in your API call.

πŸ’Έ Credit usage: Calling this endpoint costs 0.2 credit per returned person. If you also request our system to reveal their email or phone, it will additionally cost 1 credit per verified email or verified catch-all email, and 10 credits per direct phone found.

Reveal emails along the way

If you want the emails revealed of the contacts in the search at the same time, add a section to your body called "revealEmails".

In this section, you set the "includeEmails" to true, and provide a "webhookUrl" of your choice to receive the results returned once they are ready. See the below screenshot taken from the API documentation. Every verified email returned will cost 1 email credit.

πŸ’‘ Tip: You can apply both company- as well as people filters in this endpoint. Combine the two to get a targeted search that gives the best of both world

πŸ“… Did your subscription start before February 2026 or do you have a custom plan? Then you might be on our legacy plan. See this support article for more details (only accessible for legacy customers).

Did this answer your question?