How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ocean.io API

REST API for B2B company and people intelligence — 26 operations across search (v2 and v3 filter and lookalike search for companies and people), enrichment (single and batch, by domain or LinkedIn handle), lookup, contact reveal (verified email and phone, delivered by webhook), autocomplete of filter values, segmentation, and account operations (credit balance, data fields, warmup). Authenticated with an account API token in the X-Api-Token header, metered from a shared credit pool, cursor-paginated with searchAfter.

This API exposes 26 operations across 26 paths, organized into 7 resource areas, and defines 156 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.ocean.io.

26 operations 26 paths 156 schemas 3 GET23 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.ocean.io
Resource Areas
7

Paths & Operations 26

Across 26 paths, the API surfaces 26 operations — 3 GET, 23 POST. They span 7 resource areas: Autocomplete, Search, Enrich, Other, Lookup, Reveal, Segmentation. Each is listed below with its method, path, parameters, and response codes.

Autocomplete 5
POST
/v2/autocomplete/companies
Autocomplete companies
autoCompleteCompany 2 params body → 200403402400404422
POST
/v2/autocomplete/keywords
Autocomplete keywords
autoCompleteKeywords 2 params body → 200403402400404422
POST
/v2/autocomplete/job-titles
Autocomplete job titles
autoCompleteJobTitles 2 params body → 200403402400404422
POST
/v2/autocomplete/locations
Autocomplete locations
autoCompleteLocations 2 params body → 200403402400404422
POST
/v2/autocomplete/skills
Autocomplete skills
autoCompleteSkills 2 params body → 200403402400404422
Search 6
POST
/v2/search/companiesdeprecated
Lookalike companies search (deprecated)
searchCompanies 2 params body → 200403402400404422
POST
/v3/search/companies
Lookalike companies search
searchCompaniesV3 2 params body → 200403402400404422
POST
/v2/search/people
Search people (deprecated)
searchPeople 2 params body → 200403402400404422
POST
/v3/search/people
Lookalike people search
searchPeopleV3 2 params body → 200403402400404422
POST
/v3/search/people/preview
Preview - Lookalike people
searchPeopleV3Preview 2 params body → 200403402400404422
POST
/v3/search/companies/preview
Preview - Lookalike companies
previewSearchCompaniesV3 2 params body → 200403402400404422
Enrich 4
POST
/v2/enrich/company
Enrich company
enrichCompany 2 params body → 200403402400404201422
POST
/v2/enrich/person
Enrich person
enrichPerson 2 params body → 200403402400404201422
POST
/v2/enrich/companies
Enrich companies
enrichCompanies 2 params body → 200403402400404422
POST
/v2/enrich/people
Enrich people
enrichPeople 2 params body → 200403402400404422
Other 3
GET
/v2/data-fields
Get data fields
getDataFieldsPublic 2 params → 200403402400404422
GET
/v2/credits/balance
Get credit balance
getCreditBalance 2 params → 200403402400404422
POST
/v2/warmup/companies
Warmup companies
warmupCompanies 2 params body → 200403402400404422
Lookup 2
POST
/v2/lookup/companies
Lookup multiple companies by domain
lookupCompanies 2 params body → 200403402400404422
POST
/v2/lookup/people
Lookup multiple people by LinkedIn handle or Ocean ID
lookupPeople 2 params body → 200403402400404422
Reveal 2
POST
/v2/reveal/emails
Reveal emails
revealEmails 2 params body → 200403402400404422
POST
/v2/reveal/phones
Reveal phones
revealPhones 2 params body → 200403402400404422
Segmentation 4
GET
/v2/segmentation/{segmentation_id}
Get segmentation
getSegmentation 3 params → 200403402400404422
POST
/v2/segmentation
Create segmentation
createSegmentation 2 params body → 200403402400404422
POST
/v2/segmentation/{segmentation_id}/markDomains
Add domains to the positive or negative list of a segmentation
addMarkedDomains 3 params body → 200403402400404422
POST
/v2/segmentation/{segmentation_id}/attribute-domains
Attribute domains to segments
attributeSegmentationDomains 3 params body → 200403402400404412502422

Schemas 156

The contract defines 156 schemas that model the data the API accepts and returns. The most detailed are CompaniesFiltersV1 (36 properties), EnrichCompanyResult (35 properties), CompaniesFiltersV3 (35 properties), PublicCompany (34 properties). Each schema is shown below with its type and property counts.

AddMarkedDomainsInput
object
2 properties 2 required
AllAnyNoneFilter
object
3 properties
AllAnyNoneFilterSocialMedia
object
3 properties
AllJobDescriptionsFilter
object
3 properties
AttributeSegmentationDomainsRequest
object
1 property 1 required
AttributeSegmentationDomainsResponse
object
3 properties 3 required
AttributedDomain
object
3 properties 2 required
AutoCompletionCompany
object
3 properties 1 required
CompaniesCityFilter
object
4 properties 1 required
CompaniesFiltersV1
object
36 properties
CompaniesFiltersV3
object
35 properties
Company
object
17 properties
CompanyField
string
ContactNumber
object
3 properties 1 required
Credits
object
2 properties
CrmDealStatusFilter
string
CrmFilterV3
object
Filter to companies whose CRM record matches. Resolved server-side by the search engine, which calls integrations.SearchByCrmFilters with these options to deri…
4 properties
CurrentJobDescriptionFilter
object
3 properties
Department
string
DepartmentGrowthAllAnyFilter
object
2 properties
DepartmentGrowthFilter
object
4 properties 4 required
DepartmentSize
object
2 properties 2 required
DepartmentSizeFilter
object
3 properties 1 required
DepartmentSizesGrowth
object
2 properties 2 required
EmailWebhookPerson
object
25 properties 2 required
EnrichCompaniesResult
object
1 property 1 required
EnrichCompaniesWebhookResult
object
3 properties 2 required
EnrichCompanyResult
object
35 properties 2 required
EnrichPeopleResult
object
1 property 1 required
EnrichPeopleWebhookResult
object
3 properties 2 required
EnrichPersonResult
object
26 properties 3 required
Experience
object
6 properties
FromTo
object
2 properties
FromToFloat
object
2 properties
FromToStringDate
object
2 properties
FundingRound
object
4 properties
FundingRoundFilter
object
3 properties
FundingRoundType
string
GeolocationFilter
object
3 properties 3 required
GetCreditBalanceResponse
object
6 properties
Growth
object
6 properties
HTTPValidationError
object
1 property
HeadcountGrowthFilter
object
3 properties 3 required
HeadcountGrowthMonths
string
Impressum
object
8 properties
ImpressumPerson
object
2 properties 1 required
IndustriesFilter
object
2 properties 1 required
IndustryCategoriesFilter
object
2 properties 1 required
JobTitleKeywordsFilter
object
3 properties
KeywordsFilterV1
object
2 properties 1 required
LocationSearchType
string
LocationType
string
LocationsFilter
object
7 properties
LookalikePeopleResultV3
object
8 properties 3 required
LookalikePeopleStatuses
object
4 properties
LookalikePerson
object
27 properties 2 required
LookupCompaniesRequest
object
2 properties 1 required
LookupCompaniesResponse
object
5 properties 4 required
LookupPeopleRequest
object
2 properties
LookupPeopleResponse
object
4 properties 4 required
MatchCompaniesBody
object
3 properties 2 required
MatchCompanyBody
object
3 properties
MatchPeopleBody
object
2 properties 2 required
MatchPersonBaseBody
object
2 properties 1 required
MatchPersonBody
object
4 properties 1 required
MatchStatus
string
Media
object
4 properties 1 required
Medias
object
7 properties
MobileApp
object
2 properties 1 required
MobileAppsFilter
object
3 properties
OverallEnrichmentStatus
string
PeopleCityFilter
object
3 properties 1 required
PeopleFilters
object
17 properties
PeopleFiltersV3
object
28 properties
Person
object
11 properties
PersonCompany
object
8 properties
PersonCompanyField
string
PersonField
string
PhoneWebhookPerson
object
25 properties 2 required
ProfileDescriptionFilter
object
3 properties
PublicCompany
object
34 properties 1 required
PublicCompanySize
string
PublicCompanyWithRelevance
object
2 properties 1 required
PublicCompanyWithScore
object
2 properties 1 required
PublicCompanyWithUniqueId
object
3 properties 2 required
PublicCountryCodeToRegionMapping
object
3 properties
PublicGetDataFieldsResponse
object
6 properties
PublicIndustries
object
2 properties
PublicPerson
object
25 properties 2 required
PublicPersonPreviewBase
object
2 properties
PublicPersonWithCompanyPreview
object
3 properties 2 required
PublicPersonWithUniqueId
object
3 properties 2 required
PublicPreviewCompany
object
8 properties 7 required
PublicPreviewCompanyV3
object
8 properties 7 required
PublicPreviewCompanyV3Result
object
3 properties 2 required
PublicPreviewSearchCompaniesV3Body
object
3 properties
PublicPreviewSearchCompaniesV3Response
object
4 properties 3 required
PublicRevealEmailBody
object
2 properties 2 required
PublicRevealEmailResult
object
1 property 1 required
PublicRevealEmailWebhookResult
object
2 properties 2 required
PublicRevealPhoneBody
object
2 properties 2 required
PublicRevealPhoneResult
object
1 property 1 required
PublicRevealPhoneWebhookResult
object
2 properties 2 required
PublicSearchCompaniesBodyV1
object
6 properties
PublicSearchCompaniesBodyV3
object
5 properties
PublicSearchCompaniesResult
object
7 properties 3 required
PublicSearchCompaniesResultWithRelevance
object
8 properties 3 required
PublicSearchPeopleBody
object
9 properties
PublicSearchPeopleBodyV3
object
7 properties
PublicSearchPeopleBodyV3PreviewV3
object
7 properties
PublicSearchPeopleEmailWebhookResult
object
3 properties 2 required
PublicSearchPeoplePhoneWebhookResult
object
3 properties 2 required
PublicSearchPeopleResult
object
6 properties 3 required
PublicSearchPeopleResultPreviewV3
object
5 properties 3 required
PublicTechnology
object
2 properties
RevealEmails
object
2 properties
RevealPhones
object
2 properties
Revenue
string
ScoringFeature
object
3 properties 3 required
Segment
object
7 properties 4 required
SegmentCrmMetrics
object
4 properties 4 required
Segmentation
object
5 properties 3 required
SegmentationFilter
object
3 properties 2 required
SegmentationId
object
1 property 1 required
SegmentationInput
object
5 properties 1 required
SegmentationStatus
string
Seniority
string
SkillsFilter
object
3 properties
SocialMediasFilterV1
object
2 properties 1 required
SocialMediasFilterV3
object
2 properties
State
object
2 properties 2 required
StatusResponse
object
1 property 1 required
TechnologiesFilterV1
object
2 properties 1 required
TechnologiesFilterV3
object
2 properties
ValidationError
object
5 properties 3 required
WarmupCompaniesBody
object
1 property 1 required
WarmupCompaniesResult
object
5 properties
WebTraffic
object
4 properties
WebTrafficFilter
object
2 properties
models__autocomplete_companies__AutoCompletionBody
object
4 properties 1 required
models__autocomplete_companies__AutoCompletionResult
object
1 property 1 required
models__autocomplete_job_title__AutoCompletionBody
object
2 properties 1 required
models__autocomplete_job_title__AutoCompletionResult
object
1 property 1 required
models__autocomplete_keyword__AutoCompletionBody
object
2 properties 1 required
models__autocomplete_keyword__AutoCompletionResult
object
1 property 1 required
models__autocomplete_locations__AutoCompletionBody
object
3 properties 1 required
models__autocomplete_locations__AutoCompletionResult
object
1 property 1 required
models__autocomplete_locations__Location
object
6 properties 6 required
models__autocomplete_skills__AutoCompletionBody
object
2 properties 1 required
models__autocomplete_skills__AutoCompletionResult
object
1 property 1 required
public_api__models__company__Location
object
10 properties
public_api__models__person__Email
object
2 properties 2 required
public_api__models__person__Phone
object
2 properties 2 required
public_api__models__reveal_emails__Email
object
3 properties 3 required
public_api__models__reveal_phones__Phone
object
3 properties 3 required
RelevanceToThreshold

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocean-io-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Ocean.io API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.