Skip to main content
Ocean.io logo
  • Category: sales & crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: OCEAN_IO
  • Version: 20261101_00

Tools

Slug: OCEAN_IO_AUTOCOMPLETE_VALUESReturn Ocean.io suggestions for a company, keyword, job title, location, or skill query. Each call costs 0.1 credits.

Input Parameters

integer
Maximum suggestions to return (1-15). Valid for keyword, job_title, location, and skill resources; omit it for company autocomplete.
string
required
Partial company name or domain, keyword, job title, location, or skill. Company requests send this value as name; all others send it as query.
string ("company" | "keyword" | "job_title" | "location" | "skill")
required
Kind of value to autocomplete.
string ("companies" | "people")
Whether location suggestions should use company or people locations. Valid only when resource is location.
array
ISO country codes used to filter company suggestions. Valid only when resource is company.
array
Company domains to omit. Valid only when resource is company.
For company suggestions, keep true when results will seed a lookalike search. Valid only when resource is company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_ENRICH_COMPANYMatch and enrich one company from a domain, name, or LinkedIn URL, optionally using people as matching context. A matched result costs 0.1 credits. If Ocean.io must crawl the domain, the response explicitly reports processing instead of claiming enrichment completed.

Input Parameters

array
Ocean.io company fields to return. Omit to request all available fields.
array
People associated with the company that Ocean.io can use as additional matching context.
object
required
Company to match. Provide at least one of domain, name, or linkedin_url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_ENRICH_PERSONMatch and enrich one professional profile using person identifiers and optional company context. Returns privacy-sensitive professional profile data and costs 0.1 credits per result. It never requests or returns email or phone reveal data. If Ocean.io lacks current data, this operation may start background crawling and report processing instead of completed data.

Input Parameters

object
required
Person to match using documented identifiers. More known values can improve matching, but this tool never requests contact reveal.
object
Optional current-employer context used to disambiguate the person.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_GATHER_MISSING_COMPANY_DATACheck 1-500 company domains and return every Ocean.io outcome category. Although this call is free, it has an external side effect: for domains with missing data, it can irreversibly start provider-side background data gathering.

Input Parameters

array
required
Company domains to check (1-500). This free call can irreversibly queue provider-side background data gathering for domains whose data is missing. Every entry must be nonempty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_GET_CREDIT_BALANCEReturn Ocean.io’s general credit balance and, when reported, specialized credit balances and the remaining daily request allowance and reset time. This call is free and does not identify the account’s subscription plan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_GET_DATA_FIELD_VALUESReturn one Ocean.io taxonomy used to construct search filters, with optional case-insensitive local filtering and a bounded result set. This call is free.

Input Parameters

integer
Maximum matching taxonomy values to return (1-500).
string
Optional case-insensitive local text filter. Matches value names and their category, department, country, or region labels as applicable.
string ("industries" | "linkedin_industries" | "technologies" | "regions" | "seniorities" | "departments" | "sub_departments")
required
Taxonomy to return from Ocean.io’s data fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_LOOKUP_COMPANIESLookup and enrich 1-1000 companies by domain. Only successful matches are returned, at a cost of 0.05 credits per found result; no matches is a successful empty response.

Input Parameters

array
Company fields to include in matched results. Omit to return all available fields.
array
required
Company domains to look up (1-1000), without protocols or paths.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_LOOKUP_PEOPLELookup up to 1000 professional profiles by LinkedIn handle, Ocean.io person ID, or both. This returns privacy-sensitive personal profile data and costs 0.05 credits per found result. It does not request or expose email addresses, phone numbers, or other contact-reveal data.

Input Parameters

array
Ocean.io person IDs to look up. Empty lists are ignored.
array
LinkedIn profile handles to look up, without requiring full profile URLs. Empty lists are ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_SEARCH_COMPANIESSearch and page through companies using at least one non-empty company or employee filter. Results cost 0.2 credits each; the default 5-result first page costs at most 1 credit.

Input Parameters

integer
Maximum companies on this page. Defaults to 5 (at most 1 credit); each returned result costs 0.2 credits.
string
Opaque continuation token from a previous call; it restores the original filters, fields, and page size.
array
Company fields to include in each result. Defaults to domain, name, primaryCountry, and companySize. Explicit null requests all available fields. Use GET_DATA_FIELD_VALUES for supported taxonomy values.
object
Typed employee criteria; each returned company must have at least one matching person.
object
Typed company and lookalike criteria for the search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCEAN_IO_SEARCH_PEOPLESearch one page of professional profiles with typed person and employer filters; the first page requires at least one non-empty filter. Results cost 0.2 credits each, so the default 5-result first page costs at most 1 credit. This tool does not request contact reveal.

Input Parameters

integer
Maximum people in this page. Defaults to 5 (at most 1 credit); Ocean.io charges 0.2 credits per returned result.
string
Opaque continuation token from a previous response. It restores the original filters, projection, and page settings.
array
Profile and employer fields to return. Defaults to id, domain, name, jobTitle, and linkedinUrl. Explicit null uses Ocean.io’s larger default field set. Contact-address projections are intentionally unavailable.
object
Typed criteria applied to professional profiles.
object
Typed criteria applied to each profile’s current employer.
integer
Maximum matching people per company. When set, total accessible results are capped at 10,000.
number
Similarity threshold for job-title matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not