Ocean.io API Documentation

Auto complete the name search

Auto complete the keyword search.

Auto complete the job title search.

Auto complete the location search

Auto complete the skill search.

Search companies using filters.

Match a company with our database and enrich it with additional information. **Webhook result:** [Documentation](/docs/webhooks/enrich_person_email)

Match a person with our database and enrich it with additional information. **Webhook result:** [Documentation](/docs/webhooks/enrich_person_phone)

Provides a list of all industries and industry categories, technologies and regions searchable by Ocean.io. Calling this endpoint does not consume any credits.

Search people using filters and/or people Ids **Webhook result:** [Email results](/docs/webhooks/people_search_emails) [Phone results](/docs/webhooks/people_search_phones)

Preview search people with company information. **Only available for enterprise API customers.**

Get credit balance

Lookup and enrich multiple companies by domain (max 1000). This endpoint provides simple, per-result pricing. **Key features:** - Batch lookup up to 1000 company domains - Domain redirections are handled automatically Returns enriched company data for each domain. Companies not found will have `company: null` in the result.

Lookup and enrich multiple people by LinkedIn handles and/or Ocean.io IDs (max 1000 total). This endpoint provides simple, per-result pricing. **Key features:** - Batch lookup up to 1000 people (combined total of linkedinHandles + oceanIds) - Provide either linkedinHandles, oceanIds, or both lists Returns only successfully matched people in the response.

Get emails and email statuses for people. **Webhook result:** [Documentation](/docs/webhooks/reveal_emails)

Get phones and phone statuses for people. **Webhook result:** [Documentation](/docs/webhooks/reveal_phones)

Check available companies in Ocean's database and trigger process of data gathering for the missing ones. Calling this endpoint does not consume any credits

Preview search companies using filters. **Only available for enterprise API customers.**

Match companies with our database and enrich it with additional information. **Webhook result:** [Documentation](/docs/webhooks/enrich_companies)

Match people with our database and enrich it with additional information. **Webhook result:** [Documentation](/docs/webhooks/enrich_people)

Retrieve a segmentation by its id, including its segments, traits, and CRM metrics once `status` is `SUCCESSFUL`.

Create a new segmentation from a list of company domains. Runs asynchronously — poll [Get Segmentation](/docs/getSegmentation) until `status` is `SUCCESSFUL` to read the resulting segments.

Append domains to the positive or negative list of an existing segmentation to steer future results toward good-fit companies and away from poor-fit ones.

Assign each input domain to the closest segment in a segmentation, with a 0-1 match score. The segmentation must have completed successfully first.

Retrieve all exclusion lists for the organization.

Create a new exclusion list of people or companies.

Add people or companies to an exclusion list. Creates a new list when `listId` is omitted. Each request accepts up to 10,000 items. A list holds up to 300,000 items, or your plan's exclusion limit if it is lower. A request that would take the list past that limit returns a 400 and adds nothing.

Remove people or companies from a list.

Retrieve an exclusion list by id, including its size and items.

Rename an exclusion list.

Delete an exclusion list and all of its items.

Get posts from a company's LinkedIn page. Provide either `linkedinNumID` or `linkedinID`. A valid empty result is not charged.

Get posts from a person's LinkedIn profile. Provide either `linkedinEntityID` or `linkedinID`. A valid empty result is not charged.

Get reactions for a LinkedIn post. A valid empty result is not charged.

Get reshares for a LinkedIn post. A valid empty result is not charged.

Get comments for a LinkedIn post. A valid empty result is not charged.