The Reveal Emails API Endpoint lets you enter specific people for which you'd like Ocean to find and return their emails.
Use case
This endpoint is used once you have already identified the people of whom you'd like the email address to be found by Ocean. You will provide this endpoint with one or more "personIds" that you have found, for instance in the Search People API Endpoint, to which this endpoint will respond with a call to a Webhook API Endpoint of your choice.
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 1 to 500 personIds of which you want Ocean to find the email address. Then, add a "webhookUrl" in the body that you'd like the APIs to send a request to once the process is done and the emails have been revealed.
{
"personIds": [
"personId1",
"personId2"
],
"webhookUrl": "https://some-url.com"
}
Ensure you choose JSON in the Body, before hitting Send and make your call.
That's it! If your request worked, the response in this call should be "webhook sent".
Now take a look at the Webhook URL Endpoint that you had provided, to see if something has been sent. In the example below, we used a Webhook URL in Zapier to send the response to, which was successful. We received an email address and a "verified" status as a response.
💸 Credit usage: This endpoint costs 1 credit per verified email returned, or verified catch-all email returned.
📅 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).