{"openapi":"3.1.0","info":{"title":"Ocean.io API Documentation","summary":"Welcome to Ocean.io's API.","description":"\n            Welcome to Ocean.io's API.\n            The API can be used to access all our API endpoints, such as our enrich API to look up company information, or our discover API to identify companies based on specific search criteria such as semantic similarity, technologies or industries.\n            Ocean.io's APIs are a set of HTTPS endpoints that you can use to retrieve and integrate Ocean.io's data into your existing workflows.\n            All requests should be made through https and the request and response bodies should be formatted in JSON.\n        ","version":"2.0.0","x-logo":{"url":"https://cdn2.ocean.io/assets/images/logo/256x92_ocean-logo.svg"}},"servers":[{"url":"https://api.ocean.io"}],"paths":{"/v2/autocomplete/companies":{"post":{"tags":["Autocomplete"],"summary":"Autocomplete companies","description":"Auto complete the name search","operationId":"autoCompleteCompany","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_companies__AutoCompletionBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_companies__AutoCompletionResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/autocomplete/keywords":{"post":{"tags":["Autocomplete"],"summary":"Autocomplete keywords","description":"Auto complete the keyword search.","operationId":"autoCompleteKeywords","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_keyword__AutoCompletionBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_keyword__AutoCompletionResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/autocomplete/job-titles":{"post":{"tags":["Autocomplete"],"summary":"Autocomplete job titles","description":"Auto complete the job title search.","operationId":"autoCompleteJobTitles","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_job_title__AutoCompletionBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_job_title__AutoCompletionResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/autocomplete/locations":{"post":{"tags":["Autocomplete"],"summary":"Autocomplete locations","description":"Auto complete the location search","operationId":"autoCompleteLocations","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_locations__AutoCompletionBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_locations__AutoCompletionResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/autocomplete/skills":{"post":{"tags":["Autocomplete"],"summary":"Autocomplete skills","description":"Auto complete the skill search.","operationId":"autoCompleteSkills","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_skills__AutoCompletionBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models__autocomplete_skills__AutoCompletionResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/search/companies":{"post":{"tags":["Search"],"summary":"Lookalike companies search (deprecated)","description":"Search companies using filters.","operationId":"searchCompanies","deprecated":true,"parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchCompaniesBodyV1"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchCompaniesResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers","Plan version not supported for this endpoint"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/search/companies":{"post":{"tags":["Search"],"summary":"Lookalike companies search","description":"Search companies using filters.\n\nLooking for the legacy endpoint? [Access it here](/docs/searchCompanies)","operationId":"searchCompaniesV3","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchCompaniesBodyV3"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchCompaniesResultWithRelevance"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/enrich/company":{"post":{"tags":["Enrich"],"summary":"Enrich company","description":"Match a company with our database and enrich it with additional information.\n\n\n**Webhook result:**\n[Documentation](/docs/webhooks/enrich_person_email)","operationId":"enrichCompany","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchCompanyBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichCompanyResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers","Empty body"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Data gathering process has started. Please try again later."]}},"required":["detail"]}}},"description":"Created"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/enrich/person":{"post":{"tags":["Enrich"],"summary":"Enrich person","description":"Match a person with our database and enrich it with additional information.\n\n\n**Webhook result:**\n[Documentation](/docs/webhooks/enrich_person_phone)","operationId":"enrichPerson","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchPersonBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichPersonResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers","Empty `person` body"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["No matching record found"]}},"required":["detail"]}}},"description":"Not Found"},"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Data gathering process has started. Please try again later."]}},"required":["detail"]}}},"description":"Created"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/data-fields":{"get":{"tags":["Other"],"summary":"Get data fields","description":"Provides a list of all industries and industry categories, technologies and regions searchable by Ocean.io.\n\nCalling this endpoint does not consume any credits.","operationId":"getDataFieldsPublic","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDataFieldsResponse"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/search/people":{"post":{"tags":["Search"],"summary":"Search people (deprecated)","description":"Search people using filters and/or people Ids","operationId":"searchPeople","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeopleBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeopleResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient standard credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers","Plan version not supported for this endpoint"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/search/people":{"post":{"tags":["Search"],"summary":"Lookalike people search","description":"Search people using filters and/or people Ids\n\nLooking for the legacy endpoint? [Access it here](/docs/searchPeople)\n\n**Webhook result:**\n[Email results](/docs/webhooks/people_search_emails)\n[Phone results](/docs/webhooks/people_search_phones)","operationId":"searchPeopleV3","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeopleBodyV3"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookalikePeopleResultV3"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/search/people/preview":{"post":{"tags":["Search"],"summary":"Preview - Lookalike people","description":"Preview search people with company information. \n **Only available for enterprise API customers.**","operationId":"searchPeopleV3Preview","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeopleBodyV3PreviewV3"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeopleResultPreviewV3"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/credits/balance":{"get":{"tags":["Other"],"summary":"Get credit balance","description":"Get credit balance","operationId":"getCreditBalance","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreditBalanceResponse"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/lookup/companies":{"post":{"tags":["Lookup"],"summary":"Lookup multiple companies by domain","description":"Lookup and enrich multiple companies by domain (max 1000). This endpoint provides simple, per-result pricing.\n\n**Key features:**\n- Batch lookup up to 1000 company domains\n- Domain redirections are handled automatically\n\nReturns enriched company data for each domain. Companies not found will have `company: null` in the result.","operationId":"lookupCompanies","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupCompaniesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupCompaniesResponse"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/lookup/people":{"post":{"tags":["Lookup"],"summary":"Lookup multiple people by LinkedIn handle or Ocean ID","description":"Lookup and enrich multiple people by LinkedIn handles and/or Ocean.io IDs (max 1000 total). This endpoint provides simple, per-result pricing.\n\n**Key features:**\n- Batch lookup up to 1000 people (combined total of linkedinHandles + oceanIds)\n- Provide either linkedinHandles, oceanIds, or both lists\n\nReturns only successfully matched people in the response.","operationId":"lookupPeople","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupPeopleRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupPeopleResponse"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/reveal/emails":{"post":{"tags":["Reveal"],"summary":"Reveal emails","description":"Get emails and email statuses for people.\n\n**Webhook result:**\n[Documentation](/docs/webhooks/reveal_emails)","operationId":"revealEmails","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRevealEmailBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRevealEmailResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/reveal/phones":{"post":{"tags":["Reveal"],"summary":"Reveal phones","description":"Get phones and phone statuses for people.\n\n**Webhook result:**\n[Documentation](/docs/webhooks/reveal_phones)","operationId":"revealPhones","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRevealPhoneBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRevealPhoneResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient phone credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/warmup/companies":{"post":{"tags":["Other"],"summary":"Warmup companies","description":"Check available companies in Ocean's database and trigger process of data gathering for the missing ones.\n\nCalling this endpoint does not consume any credits","operationId":"warmupCompanies","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarmupCompaniesBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarmupCompaniesResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/search/companies/preview":{"post":{"tags":["Search"],"summary":"Preview - Lookalike companies","description":"Preview search companies using filters. \n **Only available for enterprise API customers.**","operationId":"previewSearchCompaniesV3","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPreviewSearchCompaniesV3Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPreviewSearchCompaniesV3Response"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database","You are not allowed to access this feature"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/enrich/companies":{"post":{"tags":["Enrich"],"summary":"Enrich companies","description":"Match companies with our database and enrich it with additional information.\n\n\n**Webhook result:**\n[Documentation](/docs/webhooks/enrich_companies)","operationId":"enrichCompanies","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchCompaniesBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichCompaniesResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/enrich/people":{"post":{"tags":["Enrich"],"summary":"Enrich people","description":"Match people with our database and enrich it with additional information.\n\n\n**Webhook result:**\n[Documentation](/docs/webhooks/enrich_people)","operationId":"enrichPeople","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchPeopleBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichPeopleResult"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/segmentation/{segmentation_id}":{"get":{"tags":["Segmentation"],"summary":"Get segmentation","description":"Retrieve a segmentation by its id, including its segments, traits, and CRM metrics once `status` is `SUCCESSFUL`.","operationId":"getSegmentation","parameters":[{"name":"segmentation_id","in":"path","required":true,"schema":{"type":"integer","title":"Segmentation Id"}},{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/segmentation":{"post":{"tags":["Segmentation"],"summary":"Create segmentation","description":"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.","operationId":"createSegmentation","parameters":[{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentationInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentationId"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/segmentation/{segmentation_id}/markDomains":{"post":{"tags":["Segmentation"],"summary":"Add domains to the positive or negative list of a segmentation","description":"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.","operationId":"addMarkedDomains","parameters":[{"name":"segmentation_id","in":"path","required":true,"schema":{"type":"integer","title":"Segmentation Id"}},{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMarkedDomainsInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Segmentation not found"]}},"required":["detail"]}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/segmentation/{segmentation_id}/attribute-domains":{"post":{"tags":["Segmentation"],"summary":"Attribute domains to segments","description":"Assign each input domain to the closest segment in a segmentation, with a 0-1 match score. The segmentation must have completed successfully first.","operationId":"attributeSegmentationDomains","parameters":[{"name":"segmentation_id","in":"path","required":true,"schema":{"type":"integer","title":"Segmentation Id"}},{"name":"apiToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apitoken"}},{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeSegmentationDomainsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeSegmentationDomainsResponse"}}}},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["API token should be provided in headers or query parameters","Current API token is not registered in our database"]}},"required":["detail"]}}},"description":"Forbidden"},"402":{"content":{"application/json":{"schema":{"title":"","type":"object","properties":{"detail":{"type":"string","enum":["Insufficient email credits","Some email verifications are already in progress and might use all your remaining email credits. Please try again later.","Insufficient phone credits","Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.","Insufficient credits"]}},"required":["detail"]}}},"description":"Payment Required"},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Conflicting API tokens provided in query parameters and headers"]}},"required":["detail"]}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"]}}},"description":"Not Found"},"412":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Segmentation must be re-run to enable attribution."]}},"required":["detail"]}}},"description":"Precondition Failed"},"502":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","enum":["Clustering service error"]}},"required":["detail"]}}},"description":"Bad Gateway"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"webhooks":{"reveal_emails":{"post":{"summary":"Reveal Email Results","description":"When the email verifications are done, the results will be sent to you via a POST request to\nthe url you passed in the Reveal endpoint.","operationId":"reveal_email_resultsreveal_emails_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRevealEmailWebhookResult"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"people_search_emails":{"post":{"summary":"People Search Email Results","description":"When the email verifications from the search are done, the results will be sent to you via a POST request to\nthe url you passed in the Search People endpoint.","operationId":"people_search_email_resultspeople_search_emails_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeopleEmailWebhookResult"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"enrich_person_email":{"post":{"summary":"Enrich Person Email Result","description":"When the email verification from the request is done, the results will be sent to you via a POST request to\nthe url you passed in the `Enrich person` endpoint.","operationId":"enrich_person_email_resultenrich_person_email_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailWebhookPerson"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"reveal_phones":{"post":{"summary":"Reveal Phone Results","description":"When the phone verifications are done, the results will be sent to you via a POST request to\nthe url you passed in the Reveal endpoint.","operationId":"reveal_phone_resultsreveal_phones_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRevealPhoneWebhookResult"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"people_search_phones":{"post":{"summary":"People Search Phone Results","description":"When the phone verifications from the search are done, the results will be sent to you via a POST request to\nthe url you passed in the Search People endpoint.","operationId":"people_search_phone_resultspeople_search_phones_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchPeoplePhoneWebhookResult"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"enrich_person_phone":{"post":{"summary":"Enrich Person Phone Result","description":"When the phone verification from the request is done, the results will be sent to you via a POST request to\nthe url you passed in the `Enrich person` endpoint.","operationId":"enrich_person_phone_resultenrich_person_phone_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneWebhookPerson"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"enrich_companies":{"post":{"summary":"Enrich Companies Result","description":"When the companies enrichment request is completed, the results will be sent to you via a POST request\nto the url you provided in the `Enrich companies` endpoint.","operationId":"enrich_companies_resultenrich_companies_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichCompaniesWebhookResult"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"enrich_people":{"post":{"summary":"Enrich People Result","description":"When the people enrichment request is completed, the results will be sent to you via a POST request\nto the url you provided in the `Enrich people` endpoint.","operationId":"enrich_people_resultenrich_people_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichPeopleWebhookResult"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AddMarkedDomainsInput":{"properties":{"domains":{"items":{"type":"string"},"type":"array","title":"Domains","description":"Domains to add to the positive or negative list.","examples":[["stripe.com","twilio.com"]]},"type":{"type":"string","enum":["positive","negative"],"title":"Type","description":"Whether these domains are a good fit (`positive`) or a poor fit (`negative`).","examples":["positive"]}},"type":"object","required":["domains","type"],"title":"AddMarkedDomainsInput"},"AllAnyNoneFilter":{"properties":{"anyOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Any of the values","description":"The filter should match **any** of the specified values."},"allOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"All values","description":"The filter should match **all** of the specified values."},"noneOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"None of the values","description":"The filter should match **none** of the specified values."}},"additionalProperties":false,"type":"object","title":"AllAnyNoneFilter"},"AllAnyNoneFilterSocialMedia":{"properties":{"anyOf":{"items":{"type":"string","enum":["linkedin","x","facebook","instagram","youtube","xing","tiktok"]},"type":"array","nullable":true,"title":"Any of the values","description":"The filter should match **any** of the specified values."},"allOf":{"items":{"type":"string","enum":["linkedin","x","facebook","instagram","youtube","xing","tiktok"]},"type":"array","nullable":true,"title":"All values","description":"The filter should match **all** of the specified values."},"noneOf":{"items":{"type":"string","enum":["linkedin","x","facebook","instagram","youtube","xing","tiktok"]},"type":"array","nullable":true,"title":"None of the values","description":"The filter should match **none** of the specified values."}},"additionalProperties":false,"type":"object","title":"AllAnyNoneFilterSocialMedia"},"AllJobDescriptionsFilter":{"properties":{"allOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"All of","description":"Job descriptions must include all of these","examples":[["software engineer"]]},"anyOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Any of","description":"Job descriptions must include at least one of these","examples":[["software engineer"]]},"noneOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"None of","description":"Job descriptions must not include any of these","examples":[["entry-level"]]}},"additionalProperties":false,"type":"object","title":"AllJobDescriptionsFilter"},"AttributeSegmentationDomainsRequest":{"properties":{"domains":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Domains","description":"Domains to attribute (max 1000).","examples":[["domain1.com","domain2.com"]]}},"type":"object","required":["domains"],"title":"AttributeSegmentationDomainsRequest"},"AttributeSegmentationDomainsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/AttributedDomain"},"type":"array","title":"Results","description":"One result per input domain, in the same order."},"totalRequested":{"type":"integer","title":"Totalrequested","description":"Total number of domains requested.","examples":[3]},"totalAttributed":{"type":"integer","title":"Totalattributed","description":"Number of domains attributed to a segment. Excludes unmatched domains and domains that couldn't be evaluated.","examples":[2]}},"type":"object","required":["results","totalRequested","totalAttributed"],"title":"AttributeSegmentationDomainsResponse"},"AttributedDomain":{"properties":{"domain":{"type":"string","title":"Domain","description":"The domain that was attributed.","examples":["domain1.com"]},"segmentId":{"type":"integer","nullable":true,"title":"Segmentid","description":"ID of the matching segment, or `null` if the domain didn't match any segment closely enough (the unattributed bucket).","examples":[42]},"score":{"type":"number","maximum":1.0,"minimum":0.0,"nullable":true,"title":"Score","description":"Match score (0-1). Higher means a stronger match to the assigned segment. `null` when the domain didn't match any segment closely enough or couldn't be evaluated.","examples":[0.91]}},"type":"object","required":["domain","segmentId"],"title":"AttributedDomain"},"AutoCompletionCompany":{"properties":{"domain":{"type":"string","title":"Domain","description":"Domain of the company, used as a unique identifier","examples":["ocean.io"]},"logo":{"type":"string","nullable":true,"title":"Logo","description":"Logo of the company (URL)","examples":["https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Name of the company","examples":["Ocean"]}},"additionalProperties":false,"type":"object","required":["domain"],"title":"AutoCompletionCompany"},"CompaniesCityFilter":{"properties":{"city":{"type":"string","title":"City","description":"City name","examples":["New York","Los Angeles"]},"country":{"type":"string","nullable":true,"title":"Country code","description":"Alpha-2 ISO 3166 country code","examples":["us","ca"]},"region":{"$ref":"#/components/schemas/State","nullable":true,"title":"Region filter","description":"Filter by country region (if applicable)","examples":[[{"abbreviation":"CA","country":"us"},{"abbreviation":"YT","country":"ca"}]]},"postalCode":{"type":"string","nullable":true,"title":"Postal code","description":"Filter by postal code","examples":["10001","90001"]}},"additionalProperties":false,"type":"object","required":["city"],"title":"CompaniesCityFilter"},"CompaniesFiltersV1":{"properties":{"lookalikeDomains":{"items":{"type":"string"},"type":"array","maxItems":10,"nullable":true,"title":"Similar domains","description":"Find domains similar to the provided","examples":[["bestcustomer.com","idealcustomer.com"]]},"includeDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Domains to include","description":"Only return specified domains","examples":[["interesting.com","amazing.com"]]},"excludeDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Domains to exclude","description":"Exclude specified domains from the results","examples":[["boring.com","useless.com"]]},"companySizes":{"items":{"$ref":"#/components/schemas/PublicCompanySize"},"type":"array","nullable":true,"title":"Company size","description":"Filter by company size ranges","examples":[["2-10","51-200","100001-500000"]]},"ecommerce":{"type":"boolean","nullable":true,"title":"E-commerce","description":"true -> returns only e-commerce companies<br>false -> excludes e-commerce companies<br>none -> returns everything","examples":[true,false]},"yearFounded":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Year founded","description":"Filter by year founded. Valid range: 0-2100","examples":[{"from":1960,"to":1990}]},"countriesCount":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Countries count","description":"Filter by the number of countries in which the company operates. Valid range: 0-300","examples":[{"from":1,"to":5}]},"revenues":{"items":{"$ref":"#/components/schemas/Revenue"},"type":"array","nullable":true,"title":"Revenue","description":"Filter by revenue ranges","examples":[["0-1M","1-10M",">1000M"]]},"employeeCountOcean":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Employee count","description":"Only return companies that have a certain number of employee profiles in our database. Valid range: 0-10,000,000","examples":[{"from":10,"to":100}]},"mobileApps":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Number of mobile apps","description":"Filter by the number of mobile apps that the company produced. Valid range: 0-10,000","examples":[{"from":1,"to":5}],"deprecated":true},"mobileAppsFilter":{"$ref":"#/components/schemas/MobileAppsFilter","nullable":true,"title":"Mobile apps filter","description":"Filter by mobile app attributes (count, downloads, release year)","examples":[{"count":{"from":1,"to":5}}]},"locationsCount":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Locations count","description":"Only return companies that have a certain amount of locations. Valid range: 0-100,000","examples":[{"from":5,"to":10}]},"departmentSizes":{"items":{"$ref":"#/components/schemas/DepartmentSizeFilter"},"type":"array","nullable":true,"title":"Department size filter","description":"Filter by the size of company departments. Valid range: 0-10,000,000","examples":[[{"department":"Accounting and Finance","from":5,"to":10}]]},"employeeCountLinkedin":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Employee count on LinkedIn","description":"The number of employees a company has on LinkedIn. Valid range: 0-10,000,000","examples":[{"from":50,"to":100}]},"industries":{"$ref":"#/components/schemas/IndustriesFilter","nullable":true,"title":"Industries","description":"Filter by company industries. Available values are located at /v2/data-fields endpoint.<br>","examples":[{"industries":["Advertising Platforms","Biopharma"],"mode":"anyOf"}]},"excludeIndustries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude industries","description":"Array of the industries to exclude","examples":[["CRM","B2B"]]},"industryCategories":{"$ref":"#/components/schemas/IndustryCategoriesFilter","nullable":true,"title":"Industry categories","description":"Filter by company industry categories. Available values are located at /v2/data-fields endpoint.<br>","examples":[{"industryCategories":["Real Estate","Hardware"],"mode":"anyOf"}]},"excludeIndustryCategories":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude industry categories","description":"Array of the industry categories to exclude","examples":[["Information Technology","Privacy and Security"]]},"linkedinIndustries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Linkedin industries","description":"Filter by Linkedin industries. This is OR filter. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management Consulting","Computer Software"]]},"excludeLinkedinIndustries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude Linkedin industries","description":"Array of Linkedin industries to exclude. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management Consulting","Computer Software"]]},"fundingRound":{"$ref":"#/components/schemas/FundingRoundFilter","nullable":true,"title":"Funding rounds","description":"Filter by funding rounds","examples":[{"date":{"from":"2020-01-01","to":"2023-01-01"},"raised":{"from":1000000,"to":5000000},"types":["Seed","Series A"]}]},"countries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Countries","description":"Filter by **all** countries where the company has presence.<br>Must be provided as alpha-2 ISO 3166 country codes.<br>`[\"es\", \"pt\"]` means Spain (primary/not primary) **OR** Portugal (primary/not primary).<br>if additional filter `primaryCountries = [\"de\"]` is used then it means:<br>(Spain (not primary) **OR** Portugal (not primary)) **AND** Germany (primary)","examples":[["es","pt"]]},"primaryCountries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Primary countries","description":"Filter only by **primary** countries where the company has presence.<br>Must be provided as alpha-2 ISO 3166 country codes.<br>`countries = [\"de\", \"at\"]` means Germany (primary) **OR** Austria (primary).<br>if additional filter `countries = [\"es\"]` is used then it means:<br>(Germany (primary) **OR** Austria (primary)) **AND** Spain (not primary)","examples":[["de"]]},"states":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"State filter","description":"Filter by country states (if applicable)","examples":[[{"abbreviation":"CA","country":"us"},{"abbreviation":"YT","country":"ca"}]]},"primaryStates":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"Primary states","description":"Filter only by **primary** states where the company has presence.<br>Behavior is the same as for primary countries","examples":[[{"abbreviation":"NY","country":"us"}]]},"cities":{"items":{"$ref":"#/components/schemas/CompaniesCityFilter"},"type":"array","nullable":true,"title":"Cities","description":"Filter by cities","examples":[[{"city":"New York","country":"us"},{"city":"Los Angeles","country":"us"}]]},"primaryCities":{"items":{"$ref":"#/components/schemas/CompaniesCityFilter"},"type":"array","nullable":true,"title":"Primary cities","description":"Filter only by **primary** cities where the company has presence.<br>Behavior is the same as for primary countries","examples":[[{"city":"New York","country":"us"},{"city":"Los Angeles","country":"us"}]]},"headquarterGeolocation":{"$ref":"#/components/schemas/GeolocationFilter","nullable":true,"title":"Headquarter location","description":"Filter by headquarter location","examples":[{"latitude":38.880817,"longitude":-77.10216,"radius":1000}]},"geolocation":{"$ref":"#/components/schemas/GeolocationFilter","nullable":true,"title":"Office locations","description":"Filter by locations of offices other than the headquarters","examples":[{"latitude":50.83348,"longitude":-0.1410065,"radius":5000}]},"webTrafficVisits":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Web traffic visits","description":"Only return companies that have a certain amount of visits. Valid range: 0-100,000,000,000","examples":[{"from":1000,"to":10000}]},"keywords":{"$ref":"#/components/schemas/KeywordsFilterV1","nullable":true,"title":"Keywords filter","description":"Filter by keywords","examples":[{"keywords":["premium copy paper","paper"],"mode":"anyOf"}]},"fieldsExist":{"items":{"type":"string","enum":["companySize","countries","departmentSizes","description","emails","faxes","impressum","industries","industryCategories","keywords","legalName","linkedinIndustry","locations","logo","medias","mobileApps","name","phones","primaryCountry","revenue","rootUrl","technologies","technologyCategories","webTraffic","yearFounded"]},"type":"array","nullable":true,"title":"Fields exist","description":"Return records where specified fields exist","examples":[["industries","emails","locations"]]},"fieldsNotExist":{"items":{"type":"string","enum":["companySize","countries","departmentSizes","description","emails","faxes","impressum","industries","industryCategories","keywords","legalName","linkedinIndustry","locations","logo","medias","mobileApps","name","phones","primaryCountry","revenue","rootUrl","technologies","technologyCategories","webTraffic","yearFounded"]},"type":"array","nullable":true,"title":"Fields do not exist","description":"Return records where specified fields do not exist","examples":[["industryCategories","phones"]]},"socialMedias":{"$ref":"#/components/schemas/SocialMediasFilterV1","nullable":true,"title":"Social medias","description":"Filter by social media presence","examples":[{"medias":["linkedin","facebook"],"mode":"anyOf"}]},"technologies":{"$ref":"#/components/schemas/TechnologiesFilterV1","nullable":true,"title":"Technologies","description":"Filter by software technologies used by the company. Available values are located at /v2/data-fields endpoint.<br>","examples":[{"mode":"anyOf","technologies":["Amazon Advertising","Google Maps"]}]},"minScore":{"type":"number","maximum":1.0,"exclusiveMinimum":0.0,"nullable":true,"title":"Minimum score","description":"Minimum score for companies to appear in the results.","default":0.79,"examples":[0.95]}},"additionalProperties":false,"type":"object","title":"CompaniesFiltersV1"},"CompaniesFiltersV3":{"properties":{"lookalikeDomains":{"items":{"type":"string"},"type":"array","maxItems":10,"nullable":true,"title":"Similar domains","description":"Find domains similar to the provided","examples":[["bestcustomer.com","idealcustomer.com"]]},"includeDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Domains to include","description":"Only return specified domains","examples":[["interesting.com","amazing.com"]]},"excludeDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Domains to exclude","description":"Exclude specified domains from the results","examples":[["boring.com","useless.com"]]},"companySizes":{"items":{"$ref":"#/components/schemas/PublicCompanySize"},"type":"array","nullable":true,"title":"Company size","description":"Filter by company size ranges","examples":[["2-10","51-200","100001-500000"]]},"ecommerce":{"type":"boolean","nullable":true,"title":"E-commerce","description":"true -> returns only e-commerce companies<br>false -> excludes e-commerce companies<br>none -> returns everything","examples":[true,false]},"yearFounded":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Year founded","description":"Filter by year founded. Valid range: 0-2100","examples":[{"from":1960,"to":1990}]},"countriesCount":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Countries count","description":"Filter by the number of countries in which the company operates. Valid range: 0-300","examples":[{"from":1,"to":5}]},"revenues":{"items":{"$ref":"#/components/schemas/Revenue"},"type":"array","nullable":true,"title":"Revenue","description":"Filter by revenue ranges","examples":[["0-1M","1-10M",">1000M"]]},"employeeCountOcean":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Employee count","description":"Only return companies that have a certain number of employee profiles in our database. Valid range: 0-10,000,000","examples":[{"from":10,"to":100}]},"mobileApps":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Number of mobile apps","description":"Filter by the number of mobile apps that the company produced. Valid range: 0-10,000","examples":[{"from":1,"to":5}],"deprecated":true},"mobileAppsFilter":{"$ref":"#/components/schemas/MobileAppsFilter","nullable":true,"title":"Mobile apps filter","description":"Filter by mobile app attributes (count, downloads, release year)","examples":[{"count":{"from":1,"to":5}}]},"locationsCount":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Locations count","description":"Only return companies that have a certain amount of locations. Valid range: 0-100,000","examples":[{"from":5,"to":10}]},"departmentSizes":{"items":{"$ref":"#/components/schemas/DepartmentSizeFilter"},"type":"array","nullable":true,"title":"Department size filter","description":"Filter by the size of company departments. Valid range: 0-10,000,000","examples":[[{"department":"Accounting and Finance","from":5,"to":10}]]},"employeeCountLinkedin":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Employee count on LinkedIn","description":"The number of employees a company has on LinkedIn. Valid range: 0-10,000,000","examples":[{"from":50,"to":100}]},"industries":{"$ref":"#/components/schemas/IndustriesFilter","nullable":true,"title":"Industries","description":"Filter by company industries. Available values are located at /v2/data-fields endpoint.<br>","examples":[{"industries":["Advertising Platforms","Biopharma"],"mode":"anyOf"}]},"excludeIndustries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude industries","description":"Array of the industries to exclude","examples":[["CRM","B2B"]]},"industryCategories":{"$ref":"#/components/schemas/IndustryCategoriesFilter","nullable":true,"title":"Industry categories","description":"Filter by company industry categories. Available values are located at /v2/data-fields endpoint.<br>","examples":[{"industryCategories":["Real Estate","Hardware"],"mode":"anyOf"}]},"excludeIndustryCategories":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude industry categories","description":"Array of the industry categories to exclude","examples":[["Information Technology","Privacy and Security"]]},"linkedinIndustries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Linkedin industries","description":"Filter by Linkedin industries. This is OR filter. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management Consulting","Computer Software"]]},"excludeLinkedinIndustries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude Linkedin industries","description":"Array of Linkedin industries to exclude. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management Consulting","Computer Software"]]},"fundingRound":{"$ref":"#/components/schemas/FundingRoundFilter","nullable":true,"title":"Funding rounds","description":"Filter by funding rounds","examples":[{"date":{"from":"2020-01-01","to":"2023-01-01"},"raised":{"from":1000000,"to":5000000},"types":["Seed","Series A"]}]},"primaryLocations":{"$ref":"#/components/schemas/LocationsFilter","nullable":true,"title":"Primary locations (HQ) filter","description":"Filter by primary locations (HQ)"},"otherLocations":{"$ref":"#/components/schemas/LocationsFilter","nullable":true,"title":"Office locations filter","description":"Filter by locations of offices other than the headquarters"},"webTraffic":{"$ref":"#/components/schemas/WebTrafficFilter","nullable":true,"title":"Web traffic","description":"Filter by web traffic metrics","examples":[{"views":{"from":1000,"to":1000000},"visits":{"from":1000,"to":10000}}]},"socialMedias":{"$ref":"#/components/schemas/SocialMediasFilterV3","nullable":true,"title":"Social medias","description":"Filter by social media presence","examples":[{"medias":{"all_of":["facebook","x"],"any_of":["youtube","xing"],"none_of":["instagram","tiktok"]},"min_count":3}]},"technologies":{"$ref":"#/components/schemas/TechnologiesFilterV3","nullable":true,"title":"Technologies filter","description":"Filter by the software technologies present on the company's website","examples":[{"apps":{"all_of":["Amazon Advertising","Google Maps"],"any_of":["BrightEdge","Nette Framework"],"none_of":["Kount","Nativo"]},"categories":{"all_of":["Analytics","Security"],"any_of":["Advertising","WordPress themes"],"none_of":["CMS","Reviews"]}}]},"keywords":{"$ref":"#/components/schemas/AllAnyNoneFilter","nullable":true,"title":"Keywords","description":"Filter by keywords","examples":[{"all_of":["lead generation","marketing"],"any_of":["smart prospecting","data platform"],"none_of":["seo"]}]},"minRelevance":{"type":"string","enum":["A","B","C"],"nullable":true,"title":"Min relevance (inclusive)","description":"Filter by min relevance (A - the most relevant).","examples":["B"]},"maxRelevance":{"type":"string","enum":["A","B","C"],"nullable":true,"title":"Max relevance (inclusive)","description":"Filter by max relevance (A - the most relevant). Use combination of min_relevance: \"B\" and max_relevance: \"B\" to get only results with the \"B\" relevance","examples":["B"]},"headcountGrowth":{"$ref":"#/components/schemas/HeadcountGrowthFilter","nullable":true,"title":"Headcount growth","description":"Filter by headcount growth","examples":[{"asPercentage":false,"growthRange":{"from":-1.0,"to":3.0},"months":"Three months"}]},"departmentHeadcountGrowth":{"$ref":"#/components/schemas/DepartmentGrowthAllAnyFilter","nullable":true,"title":"Department headcount growth","description":"Filter by department headcount growth","examples":[{"anyOf":[{"asPercentage":false,"department":"Accounting and Finance","growthRange":{"from":-1.0,"to":3.0},"months":"Three months"}]}]},"updatedWithinMonths":{"type":"integer","maximum":60.0,"exclusiveMinimum":0.0,"nullable":true,"title":"Updated within months","description":"Filter companies updated within the last N months.","examples":[1,3,12]},"fieldsExist":{"items":{"type":"string","enum":["companySize","countries","departmentSizes","description","emails","faxes","impressum","industries","industryCategories","keywords","legalName","linkedinIndustry","locations","logo","medias","mobileApps","name","phones","primaryCountry","revenue","rootUrl","technologies","technologyCategories","webTraffic","yearFounded"]},"type":"array","nullable":true,"title":"Fields exist","description":"Return records where specified fields exist","examples":[["industries","emails","locations"]]},"fieldsNotExist":{"items":{"type":"string","enum":["companySize","countries","departmentSizes","description","emails","faxes","impressum","industries","industryCategories","keywords","legalName","linkedinIndustry","locations","logo","medias","mobileApps","name","phones","primaryCountry","revenue","rootUrl","technologies","technologyCategories","webTraffic","yearFounded"]},"type":"array","nullable":true,"title":"Fields do not exist","description":"Return records where specified fields do not exist","examples":[["industryCategories","phones"]]},"companyMatchingMode":{"type":"string","enum":["precise","broad"],"nullable":true,"title":"Company matching mode","description":"Controls how strictly companies are matched when using lookalike_domains. \"precise\" (default): Matches companies with similar products/services using semantic similarity. \"broad\": Matches companies within the same industries, casting a wider net for results.","examples":["precise"]}},"additionalProperties":false,"type":"object","title":"CompaniesFiltersV3"},"Company":{"properties":{"name":{"type":"string","nullable":true,"title":"Company name","description":"The name of the company","examples":["Ocean ApS"]},"registrationNumber":{"type":"string","nullable":true,"title":"Registration number","description":"The registration number of the company","examples":["123456789"]},"email":{"type":"string","nullable":true,"title":"Email","description":"The email of the company","examples":["hello@ocean.io"]},"phone":{"type":"string","nullable":true,"title":"Phone","description":"The phone number of the company","examples":["+45 12345678"]},"countryCode":{"type":"string","nullable":true,"title":"Country code","description":"Country code of the company's headquarters","examples":["dk"]},"state":{"type":"string","nullable":true,"title":"State","description":"Name of the state/region where the company is located","examples":["Arkansas"]},"city":{"type":"string","nullable":true,"title":"City","description":"The city where the company is located","examples":["Copenhagen"]},"streetAddress":{"type":"string","nullable":true,"title":"Street address","description":"Street address of the company","examples":["Strandgade 6"]},"postalCode":{"type":"string","nullable":true,"title":"Postal code","description":"The postal code of the company","examples":["1401"]},"address":{"type":"string","nullable":true,"title":"Address","description":"Full address of the company","examples":["Strandgade 6, 1401 Copenhagen"]},"facebook":{"type":"string","nullable":true,"title":"Facebook","description":"The Facebook page of the company","examples":["https://www.facebook.com/oceanio"]},"twitter":{"type":"string","nullable":true,"title":"Twitter","description":"Company's Twitter page","examples":["https://twitter.com/oceanio"]},"linkedin":{"type":"string","nullable":true,"title":"LinkedIn","description":"LinkedIn page of the company","examples":["https://www.linkedin.com/company/oceanio"]},"instagram":{"type":"string","nullable":true,"title":"Instagram","description":"Instagram page of the company","examples":["https://www.instagram.com/oceanio"]},"xing":{"type":"string","nullable":true,"title":"Xing","description":"The Xing page of the company","examples":["https://www.xing.com/oceanio"]},"domain":{"type":"string","nullable":true,"title":"Domain","description":"The domain name of the company's website","examples":["ocean.io"]},"youtube":{"type":"string","nullable":true,"title":"YouTube","description":"The YouTube page of the company","examples":["https://www.youtube.com/oceanio"]}},"additionalProperties":false,"type":"object","title":"Company"},"CompanyField":{"type":"string","enum":["domain","countries","primaryCountry","companySize","industryCategories","industries","linkedinIndustry","ecommerce","keywords","employeeCountOcean","employeeCountLinkedin","revenue","yearFounded","description","emails","phones","phones.number","phones.country","phones.primary","logo","technologies","technologyCategories","mobileApps","mobileApps.link","mobileApps.name","webTraffic","webTraffic.visits","webTraffic.pageViews","webTraffic.pagesPerVisit","medias","medias.linkedin","medias.twitter","medias.youtube","medias.facebook","medias.xing","medias.tiktok","medias.instagram","name","legalName","locations","locations.primary","locations.country","locations.locality","locations.region","locations.postalCode","locations.streetAddress","locations.state","locations.regionCode","departmentSizes","rootUrl","faxes","faxes.number","faxes.country","faxes.primary","impressum","impressum.company","impressum.address","impressum.email","impressum.phone","impressum.fax","impressum.vat","impressum.url","impressum.people","fundingRound","fundingRound.date","fundingRound.type","fundingRound.moneyRaisedInUsd","fundingRound.cbUrl","redirectedFrom","updatedAt","headcountGrowth","headcountGrowth.threeMonths","headcountGrowth.threeMonthsPercentage","headcountGrowth.sixMonths","headcountGrowth.sixMonthsPercentage","headcountGrowth.twelveMonths","headcountGrowth.twelveMonthsPercentage","headcountGrowthPerDepartment"],"title":"CompanyField"},"ContactNumber":{"properties":{"number":{"type":"string","title":"Number","description":"Contact number"},"country":{"type":"string","nullable":true,"title":"Contact number country code","description":"Country code of the contact number"},"primary":{"type":"boolean","nullable":true,"title":"Primary contact number","description":"True if the contact number is the primary contact number of the company"}},"type":"object","required":["number"],"title":"ContactNumber"},"Credits":{"properties":{"oneTime":{"type":"number","title":"Onetime","description":"Number of one-time credits left.","default":0,"examples":[1000]},"recurrent":{"type":"number","title":"Recurrent","description":"Number of recurrent credits left.","default":0,"examples":[1000]}},"type":"object","title":"Credits"},"CrmDealStatusFilter":{"type":"string","enum":["won","lost","open","noDeal"],"title":"CrmDealStatusFilter"},"CrmFilterV3":{"properties":{"dealStatus":{"items":{"$ref":"#/components/schemas/CrmDealStatusFilter"},"type":"array","nullable":true,"title":"Dealstatus","description":"Companies must have at least one CRM deal in any of these statuses (e.g. `['won']` for closed-won customers)."},"latestDealStatus":{"items":{"$ref":"#/components/schemas/CrmDealStatusFilter"},"type":"array","nullable":true,"title":"Latestdealstatus","description":"Companies whose *latest* CRM deal is in any of these statuses."},"accountOwnerIds":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Accountownerids","description":"CRM account-owner IDs."},"latestDealOwnerIds":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Latestdealownerids","description":"Owner IDs of the latest CRM deal on the account."}},"additionalProperties":false,"type":"object","title":"CrmFilterV3","description":"Filter to companies whose CRM record matches.\n\nResolved server-side by the search engine, which calls\n`integrations.SearchByCrmFilters` with these options to derive a\ndomain include-list before running the main companies query, so this\ncomposes naturally with every other filter (lookalike, segmentation,\nindustry, size, etc.)."},"CurrentJobDescriptionFilter":{"properties":{"allOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"All of","description":"The current job description must include all of these","examples":[["software engineer","big tech company"]]},"anyOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Any of","description":"The current job description must include at least one of these","examples":[["software engineer"]]},"noneOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"None of","description":"The current job description must not include any of these","examples":[["entry-level"]]}},"additionalProperties":false,"type":"object","title":"CurrentJobDescriptionFilter"},"Department":{"type":"string","enum":["Accounting and Finance","Board","Business Support","Customer Relations","Design","Editorial Personnel","Engineering","Founder/Owner","Healthcare","HR","Legal","Management","Manufacturing","Marketing and Advertising","Operations","PR and Communications","Procurement","Product","Quality Control","R&D","Sales","Security","Supply Chain","Other"],"title":"Department"},"DepartmentGrowthAllAnyFilter":{"properties":{"anyOf":{"items":{"$ref":"#/components/schemas/DepartmentGrowthFilter"},"type":"array","nullable":true,"title":"Any of department headcount growth filters","description":"The result should match **any** of the department headcount growth filters.","examples":[[{"asPercentage":false,"department":"Accounting and Finance","growthRange":{"from":-1.0,"to":3.0},"months":"Three months"}]]},"allOf":{"items":{"$ref":"#/components/schemas/DepartmentGrowthFilter"},"type":"array","nullable":true,"title":"All values","description":"The result should match **all** of the he department headcount growth filters.","examples":[[{"asPercentage":false,"department":"Accounting and Finance","growthRange":{"from":-1.0,"to":3.0},"months":"Three months"}]]}},"additionalProperties":false,"type":"object","title":"DepartmentGrowthAllAnyFilter"},"DepartmentGrowthFilter":{"properties":{"asPercentage":{"type":"boolean","title":"As percentage","description":"true -> filter on the percentage value of the headcount growth<br>false -> filter on the absolute value of the headcount growth<br>","examples":[true,false]},"growthRange":{"$ref":"#/components/schemas/FromToFloat","title":"Headcount growth","description":"Filter by headcount growth values. Valid range: -10,000,000 to 10,000,000.<br>If `as_percentage=false`, values are in integer form (e.g., `5`, `-5`).<br>If `as_percentage=true`, values are in decimal form (e.g., `0.5` = 50%).","examples":[{"from":-1.0,"to":3.0}]},"months":{"$ref":"#/components/schemas/HeadcountGrowthMonths","title":"Period in months","description":"Headcount growth period in months","examples":["Three months"]},"department":{"$ref":"#/components/schemas/Department","description":"Functional department for the headcount growth filter. Departments are assigned by job function, not seniority — a VP of Sales appears under 'Sales', a CTO under 'Engineering', a CMO under 'Marketing and Advertising', a CFO under 'Accounting and Finance', a CHRO under 'HR', a CLO/General Counsel under 'Legal'. 'Management' captures CEO, COO, and general-manager roles only. For VP/leadership hiring signals across functions, use anyOf with the relevant functional departments rather than 'Management' alone.","examples":["Accounting and Finance"]}},"additionalProperties":false,"type":"object","required":["asPercentage","growthRange","months","department"],"title":"DepartmentGrowthFilter"},"DepartmentSize":{"properties":{"department":{"$ref":"#/components/schemas/Department","description":"Department name"},"size":{"type":"integer","title":"Size","description":"Department size"}},"type":"object","required":["department","size"],"title":"DepartmentSize"},"DepartmentSizeFilter":{"properties":{"from":{"type":"integer","nullable":true,"title":"Greater than or equal to","description":"Greater than or equal to"},"to":{"type":"integer","nullable":true,"title":"Less than or equal to","description":"Less than or equal to"},"department":{"$ref":"#/components/schemas/Department"}},"additionalProperties":false,"type":"object","required":["department"],"title":"DepartmentSizeFilter"},"DepartmentSizesGrowth":{"properties":{"department":{"$ref":"#/components/schemas/Department","description":"Department name"},"growth":{"$ref":"#/components/schemas/Growth","nullable":true,"title":"Headcount growth","description":"Headcount growth per department"}},"type":"object","required":["department","growth"],"title":"DepartmentSizesGrowth"},"EmailWebhookPerson":{"properties":{"id":{"type":"string","title":"Id","description":"Internal ocean id of the person","examples":["e9447c74eafa8a19"]},"domain":{"type":"string","title":"Domain","description":"Domain of the company the person is working for","examples":["google.com"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the person","examples":["John Doe"]},"firstName":{"type":"string","nullable":true,"title":"Firstname","description":"First name of the person","examples":["John"]},"lastName":{"type":"string","nullable":true,"title":"Lastname","description":"Last name of the person","examples":["Doe"]},"country":{"type":"string","nullable":true,"title":"Country","description":"Country code of the person","examples":["us","dk"]},"state":{"type":"string","nullable":true,"title":"State","description":"State code of the person","examples":["CA","NY"]},"location":{"type":"string","nullable":true,"title":"Location","description":"Location of the person","examples":["Copenhagen, Capital Region, Denmark"]},"linkedinUrl":{"type":"string","nullable":true,"title":"Linkedinurl","description":"Link to the linkedin profile of the person","examples":["https://www.linkedin.com/in/someone"]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"List of seniorities computed from the job title of the person","examples":[["C-Level","Manager"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"List of departments computed from the job title of the person","examples":[["Management","Marketing and Advertising"]]},"photo":{"type":"string","nullable":true,"title":"Photo","description":"Link to the person's profile picture on LinkedIn","examples":["http://media.licdn.com/dms/image/somelink"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["Professeur"]},"jobTitleEnglish":{"type":"string","nullable":true,"title":"Jobtitleenglish","description":"English translation of the person's job title","examples":["Teacher"]},"currentJobDescription":{"type":"string","nullable":true,"title":"Currentjobdescription","description":"Current job description of the person","examples":["Software Engineer specializing in cloud infrastructure"]},"experiences":{"items":{"$ref":"#/components/schemas/Experience"},"type":"array","nullable":true,"title":"Experiences","description":"List of experiences of the person","examples":[[{"dateFrom":"2020-01-01","dateTo":"2021-01-01","description":"Software Engineer specializing in cloud infrastructure","domain":"domain.com","jobTitle":"Software Engineer"}]]},"summary":{"type":"string","nullable":true,"title":"Summary","description":"Summary of the person","examples":["Some text that the person wrote to describe themselves"]},"skills":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Skills","description":"Skills of the person","examples":[["Product Management","Entrepreneurship","Social Media"]]},"phone":{"$ref":"#/components/schemas/public_api__models__person__Phone","nullable":true,"description":"Phone numbers of the person","examples":[{"numbers":["+4512345678","+33 6 00 00 00 00"],"status":"verified"}]},"email":{"$ref":"#/components/schemas/public_api__models__person__Email","nullable":true,"title":"Email","description":"Email of the person","examples":[{"address":"guessed@somedomain.com","status":"guessed"},{"address":"verified@otherdomain.com","status":"verified"}]},"inferredEmails":{"items":{"type":"string"},"type":"array","title":"Inferredemails","description":"List of inferred email addresses for the person. This is only available for enterprise subscriptions.","examples":[["john.doe@domain.com","j.doe@domain.com"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the person data been updated for the last time","examples":["2022-10-27T12:09:37Z"]},"connectionsCount":{"type":"integer","nullable":true,"title":"Number of connections","description":"Number of LinkedIn connections of the person","examples":[10,500]},"followersCount":{"type":"integer","nullable":true,"title":"Number of followers","description":"Number of LinkedIn followers of the person","examples":[50,1000]},"headline":{"type":"string","nullable":true,"title":"Headline","description":"Headline of the person","examples":["Senior Software Engineer | Tech Lead"]}},"type":"object","required":["id","domain"],"title":"EmailWebhookPerson"},"EnrichCompaniesResult":{"properties":{"status":{"type":"string","const":"in progress","title":"Status","description":"Status of the enrichment request. Always `\"in progress\"` initially, as enrichment is processed asynchronously in the background. Once completed, results for all companies will be sent to the provided webhook.","examples":["in progress"]}},"type":"object","required":["status"],"title":"EnrichCompaniesResult"},"EnrichCompaniesWebhookResult":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/PublicCompanyWithUniqueId"},"type":"array","title":"Enriched companies","description":"List of enriched companies"},"overallStatus":{"$ref":"#/components/schemas/OverallEnrichmentStatus","title":"Overall enrichment status","description":"Status of the whole enrichment batch: `\"Completed`\" if all companies were processed, `\"Incomplete`\" if enrichment failed because of time out."},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]}},"type":"object","required":["overallStatus","creditsUsed"],"title":"EnrichCompaniesWebhookResult"},"EnrichCompanyResult":{"properties":{"domain":{"type":"string","title":"Domain","description":"Domain of the company, used as a unique identifier","examples":["dundermifflinpaper.com"]},"countries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Countries","description":"List of all countries in which the company operates","examples":[["us","ca"]]},"primaryCountry":{"type":"string","nullable":true,"title":"Primary country","description":"Main country of the company","examples":["us"]},"companySize":{"$ref":"#/components/schemas/PublicCompanySize","nullable":true,"title":"Company size range","description":"Company size range","examples":["2-10"]},"industryCategories":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Industrycategories","description":"Industry categories of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":[["Consumer Electronics","Hardware"]]},"industries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Industries","description":"Industries of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":[["Audio","Electronics"]]},"linkedinIndustry":{"type":"string","nullable":true,"title":"Linkedinindustry","description":"Linkedin industry of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":["Computer Software"]},"ecommerce":{"type":"boolean","nullable":true,"title":"E-Commerce","description":"True if the company is an e-commerce company","examples":[true]},"keywords":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Keywords","description":"Keywords associated with the company","examples":[["paper","premium copy paper"]]},"employeeCountOcean":{"type":"integer","nullable":true,"title":"Employeecountocean","description":"Number of people working at the company in our database.","examples":[57]},"employeeCountLinkedin":{"type":"integer","nullable":true,"title":"Employeecountlinkedin","description":"Number of people linked to the company page on Linkedin. This number might be higher than `employeeCountOcean` because of private profiles.","examples":[70]},"revenue":{"$ref":"#/components/schemas/Revenue","nullable":true,"title":"Revenue range","description":"Revenue range","examples":["1-10M"]},"yearFounded":{"type":"integer","nullable":true,"title":"Yearfounded","description":"Year the company was founded","examples":[1999]},"description":{"type":"string","nullable":true,"title":"Description","description":"Company's description","examples":["Dunder Mifflin Paper Company, Inc. is a fictional paper and office supplies wholesale company featured in the American television series The Office."]},"emails":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Emails","description":"Emails of the company","examples":[["email1@domain.com","email2@domain.com"]]},"phones":{"items":{"$ref":"#/components/schemas/ContactNumber"},"type":"array","nullable":true,"title":"Phones","description":"Phones of the company","examples":[[{"country":"us","number":"+1 212 456 7890","primary":true},{"country":"ca","number":"+1 250 555 0199"}]]},"logo":{"type":"string","nullable":true,"title":"Logo","description":"Logo of the company (URL)","examples":["https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png"]},"technologies":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Technologies","description":"Software technologies used by the company","examples":[["Accesso","Adcash","Atlassian Jira"]]},"technologyCategories":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Technology categories","description":"Technology categories of the company","examples":[["Security","Analytics","Blogs"]]},"mobileApps":{"items":{"$ref":"#/components/schemas/MobileApp"},"type":"array","nullable":true,"title":"Mobile apps","description":"Mobile apps produced by the company"},"webTraffic":{"$ref":"#/components/schemas/WebTraffic","nullable":true,"description":"Web traffic of the domain","examples":[{"bounceRate":0.5227,"pageViews":2155984,"pagesPerVisit":4.88,"visits":10000}]},"medias":{"$ref":"#/components/schemas/Medias","nullable":true,"title":"Social medias","description":"Social medias of the company"},"name":{"type":"string","nullable":true,"title":"Name","description":"Name of the company","examples":["Dunder Mifflin Paper Company"]},"legalName":{"type":"string","nullable":true,"title":"Legalname","description":"Legal name of the company","examples":["Dunder Mifflin Paper Company, Inc."]},"locations":{"items":{"$ref":"#/components/schemas/public_api__models__company__Location"},"type":"array","nullable":true,"title":"Locations","description":"Locations of the company"},"departmentSizes":{"items":{"$ref":"#/components/schemas/DepartmentSize"},"type":"array","nullable":true,"title":"Department sizes","description":"Number of employees per department","examples":[[{"department":"Accounting and Finance","size":10},{"department":"Sales","size":15}]]},"rootUrl":{"type":"string","nullable":true,"title":"Rooturl","description":"Root url to access the website","examples":["https://dundermifflinpaper.com/"]},"faxes":{"items":{"$ref":"#/components/schemas/ContactNumber"},"type":"array","nullable":true,"title":"Faxes","description":"Faxes of the company","examples":[[{"country":"us","number":"5709045026","primary":true}]]},"impressum":{"$ref":"#/components/schemas/Impressum","nullable":true,"title":"Impressum","description":"Impressum (Imprint) data of the company (only for Germany, Austria, Switzerland)"},"fundingRound":{"$ref":"#/components/schemas/FundingRound","nullable":true,"title":"Funding round","description":"Funding round of the company","examples":[{"cbUrl":"https://www.crunchbase.com/funding_round/orderyoyo-post-ipo-equity--5c26b0c0","date":"2020-01-01","moneyRaisedInUsd":1000000,"type":"Seed"}]},"redirectedFrom":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Redirected from","description":"Urls that redirects to this domain. We provide maximum 10 urls in this field.","examples":[["pol.dk","pressen.nu"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the company data been updated for the last time","examples":["2022-08-22T12:09:37Z"]},"headcountGrowth":{"$ref":"#/components/schemas/Growth","nullable":true,"title":"Headcount growth","description":"Headcount growth of the company","examples":[{"sixMonths":10,"sixMonthsPercentage":0.2,"threeMonths":5,"threeMonthsPercentage":0.1,"twelveMonths":15,"twelveMonthsPercentage":0.3}]},"headcountGrowthPerDepartment":{"items":{"$ref":"#/components/schemas/DepartmentSizesGrowth"},"type":"array","nullable":true,"title":"Headcount growth per department","description":"Headcount growth per department","examples":[[{"department":"Accounting and Finance","growth":{"sixMonths":10,"sixMonthsPercentage":0.2,"threeMonths":5,"threeMonthsPercentage":0.1,"twelveMonths":15,"twelveMonthsPercentage":0.3}}]]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[0.1]}},"type":"object","required":["domain","creditsUsed"],"title":"EnrichCompanyResult"},"EnrichPeopleResult":{"properties":{"status":{"type":"string","const":"in progress","title":"Status","description":"Status of the enrichment request. Always `\"in progress\"` initially, as enrichment is processed asynchronously in the background. Once completed, results for all people will be sent to the provided webhook.","examples":["in progress"]}},"type":"object","required":["status"],"title":"EnrichPeopleResult"},"EnrichPeopleWebhookResult":{"properties":{"people":{"items":{"$ref":"#/components/schemas/PublicPersonWithUniqueId"},"type":"array","title":"Enriched people","description":"List of enriched people"},"overallStatus":{"$ref":"#/components/schemas/OverallEnrichmentStatus","title":"Overall enrichment status","description":"Status of the whole enrichment batch: `\"Completed`\" if all people were processed, `\"Incomplete`\" if enrichment failed because of time out."},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]}},"type":"object","required":["overallStatus","creditsUsed"],"title":"EnrichPeopleWebhookResult"},"EnrichPersonResult":{"properties":{"id":{"type":"string","title":"Id","description":"Internal ocean id of the person","examples":["e9447c74eafa8a19"]},"domain":{"type":"string","title":"Domain","description":"Domain of the company the person is working for","examples":["google.com"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the person","examples":["John Doe"]},"firstName":{"type":"string","nullable":true,"title":"Firstname","description":"First name of the person","examples":["John"]},"lastName":{"type":"string","nullable":true,"title":"Lastname","description":"Last name of the person","examples":["Doe"]},"country":{"type":"string","nullable":true,"title":"Country","description":"Country code of the person","examples":["us","dk"]},"state":{"type":"string","nullable":true,"title":"State","description":"State code of the person","examples":["CA","NY"]},"location":{"type":"string","nullable":true,"title":"Location","description":"Location of the person","examples":["Copenhagen, Capital Region, Denmark"]},"linkedinUrl":{"type":"string","nullable":true,"title":"Linkedinurl","description":"Link to the linkedin profile of the person","examples":["https://www.linkedin.com/in/someone"]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"List of seniorities computed from the job title of the person","examples":[["C-Level","Manager"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"List of departments computed from the job title of the person","examples":[["Management","Marketing and Advertising"]]},"photo":{"type":"string","nullable":true,"title":"Photo","description":"Link to the person's profile picture on LinkedIn","examples":["http://media.licdn.com/dms/image/somelink"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["Professeur"]},"jobTitleEnglish":{"type":"string","nullable":true,"title":"Jobtitleenglish","description":"English translation of the person's job title","examples":["Teacher"]},"currentJobDescription":{"type":"string","nullable":true,"title":"Currentjobdescription","description":"Current job description of the person","examples":["Software Engineer specializing in cloud infrastructure"]},"experiences":{"items":{"$ref":"#/components/schemas/Experience"},"type":"array","nullable":true,"title":"Experiences","description":"List of experiences of the person","examples":[[{"dateFrom":"2020-01-01","dateTo":"2021-01-01","description":"Software Engineer specializing in cloud infrastructure","domain":"domain.com","jobTitle":"Software Engineer"}]]},"summary":{"type":"string","nullable":true,"title":"Summary","description":"Summary of the person","examples":["Some text that the person wrote to describe themselves"]},"skills":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Skills","description":"Skills of the person","examples":[["Product Management","Entrepreneurship","Social Media"]]},"phone":{"$ref":"#/components/schemas/public_api__models__person__Phone","nullable":true,"description":"Phone numbers of the person","examples":[{"numbers":["+4512345678","+33 6 00 00 00 00"],"status":"verified"}]},"email":{"$ref":"#/components/schemas/public_api__models__person__Email","nullable":true,"description":"Email of the person","examples":[{"address":"example.jonas@ocean.io","status":"verified"}]},"inferredEmails":{"items":{"type":"string"},"type":"array","title":"Inferredemails","description":"List of inferred email addresses for the person. This is only available for enterprise subscriptions.","examples":[["john.doe@domain.com","j.doe@domain.com"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the person data been updated for the last time","examples":["2022-10-27T12:09:37Z"]},"connectionsCount":{"type":"integer","nullable":true,"title":"Number of connections","description":"Number of LinkedIn connections of the person","examples":[10,500]},"followersCount":{"type":"integer","nullable":true,"title":"Number of followers","description":"Number of LinkedIn followers of the person","examples":[50,1000]},"headline":{"type":"string","nullable":true,"title":"Headline","description":"Headline of the person","examples":["Senior Software Engineer | Tech Lead"]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[0.1]}},"type":"object","required":["id","domain","creditsUsed"],"title":"EnrichPersonResult"},"Experience":{"properties":{"domain":{"type":"string","nullable":true,"title":"Domain","description":"Domain of the company the person is working for","examples":["domain.com"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["Designer"]},"dateFrom":{"type":"string","nullable":true,"title":"Datefrom","description":"Start date of the experience","examples":["2020-01-01"]},"dateTo":{"type":"string","nullable":true,"title":"Dateto","description":"End date of the experience","examples":["2021-01-01"]},"description":{"type":"string","nullable":true,"title":"Description","description":"Description of the experience","examples":["Software Engineer specializing in cloud infrastructure"]},"linkedinCompanyHandle":{"type":"string","nullable":true,"title":"Linkedincompanyhandle","description":"Linkedin handle of the company the person is working for","examples":["colliers"]}},"type":"object","title":"Experience"},"FromTo":{"properties":{"from":{"type":"integer","nullable":true,"title":"Greater than or equal to","description":"Greater than or equal to"},"to":{"type":"integer","nullable":true,"title":"Less than or equal to","description":"Less than or equal to"}},"additionalProperties":false,"type":"object","title":"FromTo"},"FromToFloat":{"properties":{"from":{"type":"number","nullable":true,"title":"Greater than or equal to","description":"Greater than or equal to"},"to":{"type":"number","nullable":true,"title":"Less than or equal to","description":"Less than or equal to"}},"additionalProperties":false,"type":"object","title":"FromToFloat"},"FromToStringDate":{"properties":{"from":{"type":"string","nullable":true,"title":"Greater than or equal to","description":"Date in YYYY-MM-DD format"},"to":{"type":"string","nullable":true,"title":"Less than or equal to","description":"Date in YYYY-MM-DD format"}},"additionalProperties":false,"type":"object","title":"FromToStringDate"},"FundingRound":{"properties":{"date":{"type":"string","nullable":true,"title":"Funding date","description":"Date of the funding round"},"type":{"$ref":"#/components/schemas/FundingRoundType","nullable":true,"title":"Funding round type","description":"Type of the funding round"},"moneyRaisedInUsd":{"type":"integer","nullable":true,"title":"Money raised in USD","description":"Amount of money raised in USD"},"cbUrl":{"type":"string","nullable":true,"title":"Crunchbase URL","description":"URL of the funding round on Crunchbase"}},"type":"object","title":"FundingRound"},"FundingRoundFilter":{"properties":{"raised":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Raised amount","description":"Amount of money raised in funding round. Valid range: 0-100,000,000,000","examples":[{"from":1000000,"to":5000000}]},"types":{"items":{"$ref":"#/components/schemas/FundingRoundType"},"type":"array","nullable":true,"title":"Funding round types","description":"List of funding round types","examples":[["Seed","Series A"]]},"date":{"$ref":"#/components/schemas/FromToStringDate","nullable":true,"title":"Funding date","description":"Date range of the funding round. Valid range: 1800-01-01 to 2100-12-31","examples":[{"from":"2023-01-01","to":"2024-01-01"}]}},"additionalProperties":false,"type":"object","title":"FundingRoundFilter"},"FundingRoundType":{"type":"string","enum":["Seed","Series A","Angel","Series B","Series Unknown","Pre-Seed","Grant","Series C","Convertible Note","Debt Financing","Non-Equity Assistance","Undisclosed","Series D","Corporate Round","Equity Crowdfunding","Product Crowdfunding","Series E","Private Equity","Secondary Market","Initial Coin Offering","Post-IPO Equity","Series F","Post-IPO Debt","Series H","Series G","Post-IPO Secondary","Series I","Series J"],"title":"FundingRoundType"},"GeolocationFilter":{"properties":{"latitude":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Latitude","description":"Latitude of the location"},"longitude":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Longitude","description":"Longitude of the location"},"radius":{"type":"integer","maximum":500000.0,"minimum":1.0,"title":"Radius","description":"Radius in meters"}},"additionalProperties":false,"type":"object","required":["latitude","longitude","radius"],"title":"GeolocationFilter"},"GetCreditBalanceResponse":{"properties":{"credits":{"$ref":"#/components/schemas/Credits","description":"'Standard' credits balance.","examples":[{"oneTime":100.0,"recurrent":100.0}]},"emailCredits":{"$ref":"#/components/schemas/Credits","description":"'Email' credits balance.","examples":[{"oneTime":100.0,"recurrent":100.0}]},"phoneCredits":{"$ref":"#/components/schemas/Credits","description":"'Phone' credits balance.","examples":[{"oneTime":100.0,"recurrent":100.0}]},"previewCredits":{"$ref":"#/components/schemas/Credits","description":"'Preview' credits balance.","examples":[{"oneTime":100.0,"recurrent":100.0}]},"dailyLimitRateLeft":{"type":"integer","title":"Dailylimitrateleft","description":"Number of requests left for the current day.","default":0,"examples":[10]},"dailyLimitRateSecondsToReset":{"type":"integer","title":"Dailylimitratesecondstoreset","description":"Number of seconds left until the daily limit resets.","default":0,"examples":[3600]}},"type":"object","title":"GetCreditBalanceResponse"},"Growth":{"properties":{"threeMonths":{"type":"integer","nullable":true,"title":"Growth in the last 3 months","description":"Actual headcount change (positive or negative number)"},"threeMonthsPercentage":{"type":"number","nullable":true,"title":"Headcount change in the last 3 months","description":"Headcount growth as a decimal (e.g., 0.15 represents 15% growth) "},"sixMonths":{"type":"integer","nullable":true,"title":"Growth in the last 6 months","description":"Actual headcount change (positive or negative number)"},"sixMonthsPercentage":{"type":"number","nullable":true,"title":"Headcount change in the last 6 months","description":"Headcount growth as a decimal (e.g., 0.15 represents 15% growth)"},"twelveMonths":{"type":"integer","nullable":true,"title":"Growth in the last 12 months","description":"Actual headcount change (positive or negative number)"},"twelveMonthsPercentage":{"type":"number","nullable":true,"title":"Headcount change in the last 12 months","description":"Headcount growth as a decimal (e.g., 0.15 represents 15% growth)"}},"type":"object","title":"Growth"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HeadcountGrowthFilter":{"properties":{"asPercentage":{"type":"boolean","title":"As percentage","description":"true -> filter on the percentage value of the headcount growth<br>false -> filter on the absolute value of the headcount growth<br>","examples":[true,false]},"growthRange":{"$ref":"#/components/schemas/FromToFloat","title":"Headcount growth","description":"Filter by headcount growth values. Valid range: -10,000,000 to 10,000,000.<br>If `as_percentage=false`, values are in integer form (e.g., `5`, `-5`).<br>If `as_percentage=true`, values are in decimal form (e.g., `0.5` = 50%).","examples":[{"from":-1.0,"to":3.0}]},"months":{"$ref":"#/components/schemas/HeadcountGrowthMonths","title":"Period in months","description":"Headcount growth period in months","examples":["Three months"]}},"additionalProperties":false,"type":"object","required":["asPercentage","growthRange","months"],"title":"HeadcountGrowthFilter"},"HeadcountGrowthMonths":{"type":"string","enum":["Three months","Six months","Twelve months"],"title":"HeadcountGrowthMonths"},"Impressum":{"properties":{"company":{"type":"string","nullable":true,"title":"Company name","description":"Company name as mentioned in Impressum","examples":["Dunder Mifflin Paper Company, Inc."]},"address":{"type":"string","nullable":true,"title":"Address","description":"Company address as mentioned in Impressum","examples":["Scranton Business Park, 1725 Slough Ave Suit 200, Scranton, USA"]},"email":{"type":"string","nullable":true,"title":"Email","description":"Company email as mentioned in Impressum","examples":["email@dundermifflin.com"]},"phone":{"type":"string","nullable":true,"title":"Phone","description":"Company phone as mentioned in Impressum","examples":["+35123456789"]},"fax":{"type":"string","nullable":true,"title":"Fax","description":"Company fax as mentioned in Impressum","examples":["+35123456790"]},"vat":{"type":"string","nullable":true,"title":"VAT","description":"VAT number as mentioned in Impressum","examples":["123456"]},"url":{"type":"string","nullable":true,"title":"Impressum url","description":"url where Impressum can be found","examples":["https://dundermifflinpaper.com/impressum"]},"people":{"items":{"$ref":"#/components/schemas/ImpressumPerson"},"type":"array","nullable":true,"title":"People","description":"People mentioned in Impressum"}},"type":"object","title":"Impressum"},"ImpressumPerson":{"properties":{"name":{"type":"string","title":"Name","examples":["Michael Scott"]},"position":{"type":"string","nullable":true,"title":"Position","examples":["Regional Manager"]}},"type":"object","required":["name"],"title":"ImpressumPerson"},"IndustriesFilter":{"properties":{"industries":{"items":{"type":"string"},"type":"array","title":"Industries","description":"Array of the industries to include","examples":[["Digital Agencies","Advertising Services"]]},"mode":{"type":"string","enum":["anyOf","allOf"],"title":"Search mode","description":"[default] anyOf - match at least one of the industries<br>allOf - match all of the industries","default":"anyOf"}},"additionalProperties":false,"type":"object","required":["industries"],"title":"IndustriesFilter"},"IndustryCategoriesFilter":{"properties":{"industryCategories":{"items":{"type":"string"},"type":"array","title":"Industry categories","description":"Array of the industry categories to include"},"mode":{"type":"string","enum":["anyOf","allOf"],"title":"Search mode","description":"[default] anyOf - match at least one of the industry categories<br>allOf - match all of the industry categories","default":"anyOf"}},"additionalProperties":false,"type":"object","required":["industryCategories"],"title":"IndustryCategoriesFilter"},"JobTitleKeywordsFilter":{"properties":{"allOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"All keywords","description":"Match all of the keywords","examples":[["Manager"]]},"anyOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Any keyword","description":"Match at least one of the keywords","examples":[["Marketing","designer"]]},"noneOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"No keywords","description":"Match none of the keywords","examples":[["content"]]}},"additionalProperties":false,"type":"object","title":"JobTitleKeywordsFilter"},"KeywordsFilterV1":{"properties":{"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords","description":"Array of the keywords"},"mode":{"type":"string","enum":["anyOf","allOf","noneOf"],"title":"Search mode","description":"[default] anyOf - match at least one of the keywords<br>allOf - match all of the keywords<br>noneOf - match none of the keywords","default":"anyOf"}},"additionalProperties":false,"type":"object","required":["keywords"],"title":"KeywordsFilterV1"},"LocationSearchType":{"type":"string","enum":["companies","people"],"title":"LocationSearchType"},"LocationType":{"type":"string","enum":["1-country","2-region","3-municipality","4-city"],"title":"LocationType"},"LocationsFilter":{"properties":{"includeCountries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Include countries","description":"Filter by all countries where the company has presence.<br>Must be provided as alpha-2 ISO 3166 country codes.","examples":[["es"]]},"excludeCountries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude countries","description":"Exclude companies that are present in the specified countries.<br>Must be provided as alpha-2 ISO 3166 country codes.","examples":[["br","de"]]},"includeRegions":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"Include regions (states / provinces)","description":"Filter by country regions — US states, Canadian provinces, etc. (if applicable). Available values are located at /v2/data-fields endpoint.","examples":[[{"abbreviation":"CA","country":"us"},{"abbreviation":"YT","country":"ca"}]]},"excludeRegions":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"Exclude regions (states / provinces)","description":"Exclude companies present in the specified regions — US states, Canadian provinces, etc. (if applicable). Available values are located at /v2/data-fields endpoint.","examples":[[{"abbreviation":"CA","country":"us"},{"abbreviation":"YT","country":"ca"}]]},"includeCities":{"items":{"$ref":"#/components/schemas/CompaniesCityFilter"},"type":"array","nullable":true,"title":"Include cities","description":"Filter by cities","examples":[[{"city":"New York","country":"us"},{"city":"Los Angeles","country":"us"}]]},"excludeCities":{"items":{"$ref":"#/components/schemas/CompaniesCityFilter"},"type":"array","nullable":true,"title":"Exclude cities","description":"Exclude companies that are present in the specified cities","examples":[[{"city":"New York","country":"us"},{"city":"Los Angeles","country":"us"}]]},"geolocation":{"$ref":"#/components/schemas/GeolocationFilter","nullable":true,"title":"Geographical location","description":"Filter by latitude and longitude","examples":[{"latitude":38.880817,"longitude":-77.10216,"radius":1000}]}},"additionalProperties":false,"type":"object","title":"LocationsFilter"},"LookalikePeopleResultV3":{"properties":{"people":{"items":{"$ref":"#/components/schemas/LookalikePerson"},"type":"array","title":"People"},"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"lookalikePeopleStatuses":{"$ref":"#/components/schemas/LookalikePeopleStatuses","nullable":true,"title":"Lookalike people statuses","description":"Statuses of the lookalike people"},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of results of the search, accessible with pagination.","examples":[32871]},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Used for pagination. Use `searchAfter` returned by this request in the next request to get the next page of search results.","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]},"includeDomainsStatuses":{"additionalProperties":{"anyOf":[{"type":"string","enum":["missing context vector","missing industries","missing keywords","missing industry categories"]},{"type":"string","enum":["bad content","crawler failed","data gathering started","in progress","invalid domain","other error","robots disallowed","unsupported language","invalid redirect","ssl certificate error"]}]},"type":"object","nullable":true,"title":"Include domains statuses","description":"Domains from `includeDomains` filter that were not found in the search results, along with the reason","examples":[{"bad-content-domain.com":"bad content","invalid-domain.com":"invalid domain","not-found-domain.com":"in progress"}]}},"type":"object","required":["people","detail","creditsUsed"],"title":"LookalikePeopleResultV3"},"LookalikePeopleStatuses":{"properties":{"successfulPeople":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Successful people","description":"People that are found in the database","examples":[["person_id_1","person_id_2"]]},"notFoundPeople":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Not found people","description":"People that are not found in the database","examples":[["person_id_1","person_id_2"]]},"triggeredDomainPeople":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Triggered domain people","description":"People linked to a company that was not crawled","examples":[["person_id_1","person_id_2"]]},"missingCompanyInformationPeople":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Missing company information people","description":"People linked to a company that is missing necessary data","examples":[["person_id_1","person_id_2"]]}},"type":"object","title":"LookalikePeopleStatuses"},"LookalikePerson":{"properties":{"id":{"type":"string","title":"Id","description":"Internal ocean id of the person","examples":["e9447c74eafa8a19"]},"domain":{"type":"string","title":"Domain","description":"Domain of the company the person is working for","examples":["google.com"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the person","examples":["John Doe"]},"firstName":{"type":"string","nullable":true,"title":"Firstname","description":"First name of the person","examples":["John"]},"lastName":{"type":"string","nullable":true,"title":"Lastname","description":"Last name of the person","examples":["Doe"]},"country":{"type":"string","nullable":true,"title":"Country","description":"Country code of the person","examples":["us","dk"]},"state":{"type":"string","nullable":true,"title":"State","description":"State code of the person","examples":["CA","NY"]},"location":{"type":"string","nullable":true,"title":"Location","description":"Location of the person","examples":["Copenhagen, Capital Region, Denmark"]},"linkedinUrl":{"type":"string","nullable":true,"title":"Linkedinurl","description":"Link to the linkedin profile of the person","examples":["https://www.linkedin.com/in/someone"]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"List of seniorities computed from the job title of the person","examples":[["C-Level","Manager"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"List of departments computed from the job title of the person","examples":[["Management","Marketing and Advertising"]]},"photo":{"type":"string","nullable":true,"title":"Photo","description":"Link to the person's profile picture on LinkedIn","examples":["http://media.licdn.com/dms/image/somelink"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["Professeur"]},"jobTitleEnglish":{"type":"string","nullable":true,"title":"Jobtitleenglish","description":"English translation of the person's job title","examples":["Teacher"]},"currentJobDescription":{"type":"string","nullable":true,"title":"Currentjobdescription","description":"Current job description of the person","examples":["Software Engineer specializing in cloud infrastructure"]},"experiences":{"items":{"$ref":"#/components/schemas/Experience"},"type":"array","nullable":true,"title":"Experiences","description":"List of experiences of the person","examples":[[{"dateFrom":"2020-01-01","dateTo":"2021-01-01","description":"Software Engineer specializing in cloud infrastructure","domain":"domain.com","jobTitle":"Software Engineer"}]]},"summary":{"type":"string","nullable":true,"title":"Summary","description":"Summary of the person","examples":["Some text that the person wrote to describe themselves"]},"skills":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Skills","description":"Skills of the person","examples":[["Product Management","Entrepreneurship","Social Media"]]},"phone":{"$ref":"#/components/schemas/public_api__models__person__Phone","nullable":true,"description":"Phone numbers of the person","examples":[{"numbers":["+4512345678","+33 6 00 00 00 00"],"status":"verified"}]},"email":{"$ref":"#/components/schemas/public_api__models__person__Email","nullable":true,"description":"Email of the person","examples":[{"address":"example.jonas@ocean.io","status":"verified"}]},"inferredEmails":{"items":{"type":"string"},"type":"array","title":"Inferredemails","description":"List of inferred email addresses for the person. This is only available for enterprise subscriptions.","examples":[["john.doe@domain.com","j.doe@domain.com"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the person data been updated for the last time","examples":["2022-10-27T12:09:37Z"]},"connectionsCount":{"type":"integer","nullable":true,"title":"Number of connections","description":"Number of LinkedIn connections of the person","examples":[10,500]},"followersCount":{"type":"integer","nullable":true,"title":"Number of followers","description":"Number of LinkedIn followers of the person","examples":[50,1000]},"headline":{"type":"string","nullable":true,"title":"Headline","description":"Headline of the person","examples":["Senior Software Engineer | Tech Lead"]},"company":{"$ref":"#/components/schemas/PersonCompany","nullable":true},"relevance":{"type":"string","enum":["A","B","C"],"nullable":true,"title":"Relevance category","description":"Relevance category (A - the most relevant)","examples":["A"]}},"type":"object","required":["id","domain"],"title":"LookalikePerson"},"LookupCompaniesRequest":{"properties":{"domains":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Domains","description":"List of company domains to lookup (max 1000). Domain redirections are handled automatically.","examples":[["ocean.io","google.com","apple.com"]]},"fields":{"items":{"$ref":"#/components/schemas/CompanyField"},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.","examples":[["domain","countries","primaryCountry","companySize","industryCategories","industries","linkedinIndustry","ecommerce","keywords","employeeCountOcean","employeeCountLinkedin","revenue","yearFounded","description","emails","phones","logo","technologies","technologyCategories","mobileApps","webTraffic","medias","name","legalName","locations","departmentSizes","rootUrl","faxes","impressum","fundingRound","updatedAt"]]}},"type":"object","required":["domains"],"title":"LookupCompaniesRequest"},"LookupCompaniesResponse":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/PublicCompany"},"type":"array","title":"Companies","description":"List of enriched companies found. Only includes successfully matched companies."},"totalRequested":{"type":"integer","title":"Totalrequested","description":"Total number of domains requested","examples":[3]},"totalFound":{"type":"integer","title":"Totalfound","description":"Total number of companies found","examples":[2]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]}},"type":"object","required":["companies","totalRequested","totalFound","creditsUsed"],"title":"LookupCompaniesResponse"},"LookupPeopleRequest":{"properties":{"linkedinHandles":{"items":{"type":"string"},"type":"array","maxItems":1000,"title":"Linkedinhandles","description":"List of LinkedIn profile handles to lookup (e.g., ['john-doe', 'jane-smith'])","examples":[["john-doe","jane-smith"]]},"oceanIds":{"items":{"type":"string"},"type":"array","maxItems":1000,"title":"Oceanids","description":"List of Ocean.io person IDs to lookup (e.g., ['abc123', 'def456'])","examples":[["abc123","def456"]]}},"type":"object","title":"LookupPeopleRequest"},"LookupPeopleResponse":{"properties":{"people":{"items":{"$ref":"#/components/schemas/LookalikePerson"},"type":"array","title":"People","description":"List of enriched people found. Only includes successfully matched people."},"totalRequested":{"type":"integer","title":"Totalrequested","description":"Total number of identifiers requested","examples":[2]},"totalFound":{"type":"integer","title":"Totalfound","description":"Total number of people found","examples":[1]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]}},"type":"object","required":["people","totalRequested","totalFound","creditsUsed"],"title":"LookupPeopleResponse"},"MatchCompaniesBody":{"properties":{"companyDataMapping":{"additionalProperties":{"$ref":"#/components/schemas/MatchCompanyBody"},"type":"object","maxProperties":10000,"minProperties":1,"title":"Mapping of user-defined IDs to company data","description":"A dictionary where each key is unique user-defined ID for a company, and each value is the data for that company to be enriched. This ID will be included in the webhook response together with the enriched company data, allowing the user to match the response to the original request."},"webhookUrl":{"type":"string","title":"Webhookurl","description":"Url of the webhook the enriched companies should be sent to, when completed.","examples":["https://some-url.com"]},"fields":{"items":{"$ref":"#/components/schemas/CompanyField"},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.","examples":[["domain","countries","primaryCountry","companySize","industryCategories","industries","linkedinIndustry","ecommerce","keywords","employeeCountOcean","employeeCountLinkedin","revenue","yearFounded","description","emails","phones","logo","technologies","technologyCategories","mobileApps","webTraffic","medias","name","legalName","locations","departmentSizes","rootUrl","faxes","impressum","fundingRound","updatedAt"]]}},"additionalProperties":false,"type":"object","required":["companyDataMapping","webhookUrl"],"title":"MatchCompaniesBody"},"MatchCompanyBody":{"properties":{"company":{"$ref":"#/components/schemas/Company","description":"The company to match with"},"people":{"items":{"$ref":"#/components/schemas/Person"},"type":"array","title":"People","description":"The people to match company with"},"fields":{"items":{"$ref":"#/components/schemas/CompanyField"},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.","examples":[["domain","countries","primaryCountry","companySize","industryCategories","industries","linkedinIndustry","ecommerce","keywords","employeeCountOcean","employeeCountLinkedin","revenue","yearFounded","description","emails","phones","logo","technologies","technologyCategories","mobileApps","webTraffic","medias","name","legalName","locations","departmentSizes","rootUrl","faxes","impressum","fundingRound","updatedAt"]]}},"additionalProperties":false,"type":"object","title":"MatchCompanyBody"},"MatchPeopleBody":{"properties":{"peopleDataMapping":{"additionalProperties":{"$ref":"#/components/schemas/MatchPersonBaseBody"},"type":"object","maxProperties":10000,"minProperties":1,"title":"Unique string id to people match body mapping","description":"A dictionary where each key is a unique user-defined ID for a person, and each value is the data for that person to be enriched. This ID will be included in the webhook response together with the enriched person data, allowing the user to match the response to the original request."},"webhookUrl":{"type":"string","title":"Webhookurl","description":"Url of the webhook the enriched people should be sent to, when completed.","examples":["https://some-url.com"]}},"additionalProperties":false,"type":"object","required":["peopleDataMapping","webhookUrl"],"title":"MatchPeopleBody"},"MatchPersonBaseBody":{"properties":{"person":{"$ref":"#/components/schemas/Person","description":"The person to match with"},"company":{"$ref":"#/components/schemas/Company","nullable":true,"title":"Company","description":"The company to match the person with"}},"additionalProperties":false,"type":"object","required":["person"],"title":"MatchPersonBaseBody"},"MatchPersonBody":{"properties":{"person":{"$ref":"#/components/schemas/Person","description":"The person to match with"},"company":{"$ref":"#/components/schemas/Company","nullable":true,"title":"Company","description":"The company to match the person with"},"revealEmails":{"$ref":"#/components/schemas/RevealEmails","nullable":true,"title":"Reveal emails","examples":[{"includeEmails":true,"webhookUrl":"https://url.com/webhook"}]},"revealPhones":{"$ref":"#/components/schemas/RevealPhones","nullable":true,"title":"Reveal phones","examples":[{"includePhones":true,"webhookUrl":"https://url.com/webhook"}]}},"additionalProperties":false,"type":"object","required":["person"],"title":"MatchPersonBody"},"MatchStatus":{"type":"string","enum":["Success","Not enough data","Not found","Too many matches"],"title":"MatchStatus"},"Media":{"properties":{"url":{"type":"string","title":"Media URL","description":"URL of the media"},"handle":{"type":"string","nullable":true,"title":"Handle","description":"ids extracted from social media urls"},"name":{"type":"string","nullable":true,"title":"Name","description":"Name of the company as it appears in the social media account"},"specialties":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Specialties","description":"Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.","examples":[["artificial intelligence","machine learning"]]}},"type":"object","required":["url"],"title":"Media"},"Medias":{"properties":{"linkedin":{"$ref":"#/components/schemas/Media","nullable":true,"description":"LinkedIn page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://www.linkedin.com/company/dunder-mifflin"}]},"twitter":{"$ref":"#/components/schemas/Media","nullable":true,"description":"Twitter page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://twitter.com/dunder-mifflin"}]},"youtube":{"$ref":"#/components/schemas/Media","nullable":true,"description":"YouTube page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://youtube.com/channel/dunder-mifflin"}]},"facebook":{"$ref":"#/components/schemas/Media","nullable":true,"description":"Facebook page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://facebook.com/dunder-mifflin"}]},"xing":{"$ref":"#/components/schemas/Media","nullable":true,"description":"Xing page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://xing.com/dunder-mifflin"}]},"tiktok":{"$ref":"#/components/schemas/Media","nullable":true,"description":"TikTok page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://tiktok.com/dunder-mifflin"}]},"instagram":{"$ref":"#/components/schemas/Media","nullable":true,"description":"Instagram page associated with the company","examples":[{"handle":"dunder-mifflin","name":"Dunder Mifflin Paper Company, Inc.","url":"https://instagram.com/dunder-mifflin"}]}},"type":"object","title":"Medias"},"MobileApp":{"properties":{"link":{"type":"string","nullable":true,"title":"url","description":"Website address for this app","examples":["https://www.my.app.com/"]},"name":{"type":"string","title":"App name","description":"App name","examples":["My awesome app"]}},"type":"object","required":["name"],"title":"MobileApp"},"MobileAppsFilter":{"properties":{"count":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Number of mobile apps","description":"Filter by the number of mobile apps that the company produced. Valid range: 0-10,000","examples":[{"from":1,"to":5}]},"downloads":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Number of downloads","description":"Filter by the number of mobile app downloads. Valid range: 0-10,000,000,000","examples":[{"from":1000000,"to":5000000}]},"releaseYear":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Release year","description":"Filter by the release year of mobile apps. Valid range: 2000-2100","examples":[{"from":2018,"to":2023}]}},"additionalProperties":false,"type":"object","title":"MobileAppsFilter"},"OverallEnrichmentStatus":{"type":"string","enum":["Completed","Incomplete"],"title":"OverallEnrichmentStatus"},"PeopleCityFilter":{"properties":{"city":{"type":"string","title":"City","description":"City name","examples":["New York","Los Angeles"]},"country":{"type":"string","nullable":true,"title":"Country code","description":"Alpha-2 ISO 3166 country code","examples":["us","ca"]},"region":{"$ref":"#/components/schemas/State","nullable":true,"title":"Region filter","description":"Filter by country region (if applicable)","examples":[[{"abbreviation":"CA","country":"us"},{"abbreviation":"YT","country":"ca"}]]}},"additionalProperties":false,"type":"object","required":["city"],"title":"PeopleCityFilter"},"PeopleFilters":{"properties":{"includeIds":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Ids to include","description":"Only return specified people. Note: this is not implemented yet.","examples":[["51e19df9c1d70c7c","971b1b1bfb1ffb1a"]]},"excludeIds":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Ids to exclude","description":"Exclude specified people from the results. Note: this is not implemented yet.","examples":[["51e19df9c1d70c7c","971b1b1bfb1ffb1a"]]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"Filter by seniorities. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Founder","Owner"]]},"jobTitles":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Jobtitles","description":"Filter by job title","examples":[["CEO","CTO"]]},"excludeJobTitles":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Excludejobtitles","description":"Exclude people by job title","examples":[["CEO","CTO"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"Filter by departments. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management","Marketing and Advertising"]]},"countries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Countries","description":"Filter by countries (alpha-2 ISO 3166 country codes)","examples":[["us","dk"]]},"states":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"States","description":"List of states/regions (ISO-3166-2 region codes) to search for people","examples":[[{"abbreviation":"NY","country":"us"},{"abbreviation":"ON","country":"ca"},{"abbreviation":"5","country":"at"},{"abbreviation":"SH","country":"de"}]]},"excludeStates":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"Exclude States","description":"List of states/regions (ISO-3166-2 region codes) to exclude when searching for people","examples":[[{"abbreviation":"NY","country":"us"},{"abbreviation":"ON","country":"ca"},{"abbreviation":"5","country":"at"},{"abbreviation":"SH","country":"de"}]]},"excludeCountries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Excludecountries","description":"List of countries (alpha-2 ISO 3166 country codes) to exclude when searching for people","examples":[["us","dk"]]},"names":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Names","description":"Filter by names","examples":[["John Doe","Peter Pan"]]},"emails":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Emails","description":"Filter by email address","examples":[["email_1@domain.com","email_2@domain.com"]]},"keywords":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Keywords","description":"Filter people based on keywords from their summary","examples":[["engineering","research"]]},"fieldsExist":{"items":{"type":"string","enum":["country","departments","firstName","jobTitle","jobTitleEnglish","lastName","linkedinUrl","location","name","photo","seniorities","summary"]},"type":"array","nullable":true,"title":"Fields exist","description":"Return records where specified fields exist","examples":[["name","country","linkedinUrl"]]},"fieldsNotExist":{"items":{"type":"string","enum":["country","departments","firstName","jobTitle","jobTitleEnglish","lastName","linkedinUrl","location","name","photo","seniorities","summary"]},"type":"array","nullable":true,"title":"Fields do not exist","description":"Return records where specified fields do not exist","examples":[["firstName","location","jobTitleEnglish"]]},"changedPositionAfter":{"type":"string","nullable":true,"title":"Changedpositionafter","description":"Return people who started a new job between the specified date (inclusive) and now","examples":["2023-01"]},"changedPositionBefore":{"type":"string","nullable":true,"title":"Changedpositionbefore","description":"Return people who started a new currently active job before the specified date (inclusive)","examples":["2023-01"]}},"additionalProperties":false,"type":"object","title":"PeopleFilters"},"PeopleFiltersV3":{"properties":{"lookalikeLinkedinHandles":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Lookalike people handles","description":"List of people linkedin handles to search for similar people.","examples":[["michael-scott-13532","dwight-schrute"]]},"countries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Country codes","description":"List of country codes (alpha-2 ISO 3166) to search for people.","examples":[["us","dk"]]},"includePeopleIds":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Include people IDs","description":"List of people IDs to include in the search.","examples":[["43g19df9c1d70f9a","54hb1b1bfb1ffc5t"]]},"includeLinkedinHandles":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Include people by LinkedIn handles","description":"List of people linkedin handles to include in the search.","examples":[["jim-halpert-5343","toby-67832"]]},"excludePeopleIds":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude people IDs","description":"List of people IDs to exclude from the search.","examples":[["43g19df9c1d70f9a","54hb1b1bfb1ffc5t"]]},"excludeLinkedinHandles":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude people by LinkedIn handles","description":"List of people linkedin handles to exclude from the search.","examples":[["jim-halpert-5343","toby-67832"]]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"Filter by seniorities. Available values are located at /v2/data-fields endpoint.","examples":[["Founder","Owner"]]},"skills":{"$ref":"#/components/schemas/SkillsFilter","nullable":true,"title":"Skills","description":"Filter by skills"},"jobTitleKeywords":{"$ref":"#/components/schemas/JobTitleKeywordsFilter","nullable":true,"title":"Job title keywords filter","description":"Filter by keywords present in job titles"},"allJobDescriptions":{"$ref":"#/components/schemas/AllJobDescriptionsFilter","nullable":true,"title":"All job descriptions filter","description":"Filter by all job descriptions"},"currentJobDescription":{"$ref":"#/components/schemas/CurrentJobDescriptionFilter","nullable":true,"title":"Current job description filter","description":"Filter by current job description"},"profileDescription":{"$ref":"#/components/schemas/ProfileDescriptionFilter","nullable":true,"title":"Profile description filter","description":"Filter by profile description"},"regions":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Region codes","description":"List of region codes to search for people.","examples":[["CA","TX"]],"deprecated":true},"states":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"States","description":"List of states/regions to search for people (ISO-3166-2 region codes). Available abbreviation values are located at /v2/data-fields endpoint (region section).","examples":[[{"abbreviation":"NY","country":"us"},{"abbreviation":"ENG","country":"gb"},{"abbreviation":"5","country":"at"},{"abbreviation":"SH","country":"de"}]]},"excludeStates":{"items":{"$ref":"#/components/schemas/State"},"type":"array","nullable":true,"title":"Exclude States","description":"List of states/regions to exclude when searching for people (ISO-3166-2 region codes). Available abbreviation values are located at /v2/data-fields endpoint (region section).","examples":[[{"abbreviation":"NY","country":"us"},{"abbreviation":"ENG","country":"gb"},{"abbreviation":"5","country":"at"},{"abbreviation":"SH","country":"de"}]]},"excludeCountries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude Countries","description":"List of country codes (alpha-2 ISO 3166) to exclude when searching for people.","examples":[["us","dk"]]},"cities":{"items":{"$ref":"#/components/schemas/PeopleCityFilter"},"type":"array","nullable":true,"title":"Cities","description":"List of cities to search for people.","examples":[[{"city":"New York","country":"us"},{"city":"Los Angeles","country":"us"}]]},"excludeCities":{"items":{"$ref":"#/components/schemas/PeopleCityFilter"},"type":"array","nullable":true,"title":"Exclude Cities","description":"List of cities to exclude when searching for people.","examples":[[{"city":"New York","country":"us"},{"city":"Los Angeles","country":"us"}]]},"names":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Names","description":"Filter by names","examples":[["John Doe","Peter Pan"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"Filter by departments. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management","Marketing and Advertising"]]},"excludeDepartments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Excludedepartments","description":"Exclude people by departments. Available values are located at /v2/data-fields endpoint.<br>","examples":[["Management","Marketing and Advertising"]]},"fieldsExist":{"items":{"type":"string","enum":["country","departments","firstName","jobTitle","jobTitleEnglish","lastName","linkedinUrl","location","name","photo","seniorities","summary"]},"type":"array","nullable":true,"title":"Fields exist","description":"Return records where specified fields exist","examples":[["name","country","linkedinUrl"]]},"fieldsNotExist":{"items":{"type":"string","enum":["country","departments","firstName","jobTitle","jobTitleEnglish","lastName","linkedinUrl","location","name","photo","seniorities","summary"]},"type":"array","nullable":true,"title":"Fields do not exist","description":"Return records where specified fields do not exist","examples":[["firstName","location","jobTitleEnglish"]]},"changedPositionAfter":{"type":"string","nullable":true,"title":"Changedpositionafter","description":"Return people who started a new job between the specified date (inclusive) and now","examples":["2023-01"]},"changedPositionBefore":{"type":"string","nullable":true,"title":"Changedpositionbefore","description":"Return people who started a new currently active job before the specified date (inclusive)","examples":["2023-01"]},"updatedWithinMonths":{"type":"integer","maximum":60.0,"exclusiveMinimum":0.0,"nullable":true,"title":"Updated within months","description":"Filter people updated within the last N months.","examples":[1,3,12]},"connections":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Number of connections","description":"Number of connections of the person on Linkedin","examples":[{"from":100,"to":400},{"from":500}]},"followers":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Number of followers","description":"Number of followers of the person on Linkedin","examples":[{"from":100,"to":5000},{"from":1000}]}},"additionalProperties":false,"type":"object","title":"PeopleFiltersV3"},"Person":{"properties":{"id":{"type":"string","nullable":true,"title":"Person id","description":"Ocean id of the person","examples":["b8952796be57982d"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the contact","examples":["John Doe"]},"firstName":{"type":"string","nullable":true,"title":"First name","description":"First name of the contact","examples":["John"]},"lastName":{"type":"string","nullable":true,"title":"Last name","description":"Last name of the contact","examples":["Doe"]},"jobTitle":{"type":"string","nullable":true,"title":"Job title","description":"Job title of the contact","examples":["CEO"]},"email":{"type":"string","nullable":true,"title":"Email","description":"Email address of the contact","examples":["john.doe@example.com"]},"phone":{"type":"string","nullable":true,"title":"Phone","description":"Phone number of the contact","examples":["+45 12345678"]},"facebook":{"type":"string","nullable":true,"title":"Facebook","description":"Facebook page of the contact","examples":["https://www.facebook.com/johndoe"]},"twitter":{"type":"string","nullable":true,"title":"Twitter","description":"The Twitter page of the contact","examples":["https://twitter.com/johndoe"]},"linkedin":{"type":"string","nullable":true,"title":"LinkedIn","description":"The LinkedIn page of the contact","examples":["https://www.linkedin.com/in/johndoe"]},"country":{"type":"string","nullable":true,"title":"Country","description":"The country of the contact","examples":["dk"]}},"additionalProperties":false,"type":"object","title":"Person"},"PersonCompany":{"properties":{"companySize":{"$ref":"#/components/schemas/PublicCompanySize","nullable":true,"title":"Company size range","description":"Company size range","examples":["2-10"]},"logo":{"type":"string","nullable":true,"title":"Logo","description":"Logo of the company (URL)","examples":["https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Name of the company","examples":["Dunder Mifflin Paper Company"]},"revenue":{"$ref":"#/components/schemas/Revenue","nullable":true,"title":"Revenue range","description":"Revenue range","examples":["1-10M"]},"employeeCountOcean":{"type":"integer","nullable":true,"title":"Employeecountocean","description":"Number of people working at the company in our database.","examples":[57]},"industries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Industries","description":"Industries of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":[["Audio","Electronics"]]},"technologies":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Technologies","description":"Software technologies used by the company","examples":[["Accesso","Adcash","Atlassian Jira"]]},"fundingRound":{"$ref":"#/components/schemas/FundingRound","nullable":true,"title":"Funding round","description":"Funding round of the company","examples":[{"cbUrl":"https://www.crunchbase.com/funding_round/5c26b0c0","date":"2020-01-01","moneyRaisedInUsd":1000000,"type":"Seed"}]}},"type":"object","title":"PersonCompany"},"PersonCompanyField":{"type":"string","enum":["company.revenue","company.peopleCount","company.industries","company.technologies","company.latestFundingRound"],"title":"PersonCompanyField"},"PersonField":{"type":"string","enum":["id","domain","name","firstName","lastName","country","state","location","linkedinUrl","seniorities","departments","photo","jobTitle","jobTitleEnglish","currentJobDescription","experiences","experiences.domain","experiences.jobTitle","experiences.dateFrom","experiences.dateTo","experiences.description","experiences.linkedinCompanyHandle","summary","skills","email","email.address","updatedAt","connectionsCount","followersCount","headline"],"title":"PersonField"},"PhoneWebhookPerson":{"properties":{"id":{"type":"string","title":"Id","description":"Internal ocean id of the person","examples":["e9447c74eafa8a19"]},"domain":{"type":"string","title":"Domain","description":"Domain of the company the person is working for","examples":["google.com"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the person","examples":["John Doe"]},"firstName":{"type":"string","nullable":true,"title":"Firstname","description":"First name of the person","examples":["John"]},"lastName":{"type":"string","nullable":true,"title":"Lastname","description":"Last name of the person","examples":["Doe"]},"country":{"type":"string","nullable":true,"title":"Country","description":"Country code of the person","examples":["us","dk"]},"state":{"type":"string","nullable":true,"title":"State","description":"State code of the person","examples":["CA","NY"]},"location":{"type":"string","nullable":true,"title":"Location","description":"Location of the person","examples":["Copenhagen, Capital Region, Denmark"]},"linkedinUrl":{"type":"string","nullable":true,"title":"Linkedinurl","description":"Link to the linkedin profile of the person","examples":["https://www.linkedin.com/in/someone"]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"List of seniorities computed from the job title of the person","examples":[["C-Level","Manager"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"List of departments computed from the job title of the person","examples":[["Management","Marketing and Advertising"]]},"photo":{"type":"string","nullable":true,"title":"Photo","description":"Link to the person's profile picture on LinkedIn","examples":["http://media.licdn.com/dms/image/somelink"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["Professeur"]},"jobTitleEnglish":{"type":"string","nullable":true,"title":"Jobtitleenglish","description":"English translation of the person's job title","examples":["Teacher"]},"currentJobDescription":{"type":"string","nullable":true,"title":"Currentjobdescription","description":"Current job description of the person","examples":["Software Engineer specializing in cloud infrastructure"]},"experiences":{"items":{"$ref":"#/components/schemas/Experience"},"type":"array","nullable":true,"title":"Experiences","description":"List of experiences of the person","examples":[[{"dateFrom":"2020-01-01","dateTo":"2021-01-01","description":"Software Engineer specializing in cloud infrastructure","domain":"domain.com","jobTitle":"Software Engineer"}]]},"summary":{"type":"string","nullable":true,"title":"Summary","description":"Summary of the person","examples":["Some text that the person wrote to describe themselves"]},"skills":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Skills","description":"Skills of the person","examples":[["Product Management","Entrepreneurship","Social Media"]]},"phone":{"$ref":"#/components/schemas/public_api__models__person__Phone","nullable":true,"title":"Phone","description":"Phone of the person","examples":[{"numbers":["+4512345678","+33 6 00 00 00 00"],"status":"verified"},{"numbers":["+33600000000","+4512121212"],"status":"notFound"}]},"email":{"$ref":"#/components/schemas/public_api__models__person__Email","nullable":true,"description":"Email of the person","examples":[{"address":"example.jonas@ocean.io","status":"verified"}]},"inferredEmails":{"items":{"type":"string"},"type":"array","title":"Inferredemails","description":"List of inferred email addresses for the person. This is only available for enterprise subscriptions.","examples":[["john.doe@domain.com","j.doe@domain.com"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the person data been updated for the last time","examples":["2022-10-27T12:09:37Z"]},"connectionsCount":{"type":"integer","nullable":true,"title":"Number of connections","description":"Number of LinkedIn connections of the person","examples":[10,500]},"followersCount":{"type":"integer","nullable":true,"title":"Number of followers","description":"Number of LinkedIn followers of the person","examples":[50,1000]},"headline":{"type":"string","nullable":true,"title":"Headline","description":"Headline of the person","examples":["Senior Software Engineer | Tech Lead"]}},"type":"object","required":["id","domain"],"title":"PhoneWebhookPerson"},"ProfileDescriptionFilter":{"properties":{"allOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"All keywords","description":"The LinkedIn profile description must include all of these keywords","examples":[["software engineer"]]},"anyOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Any keyword","description":"The LinkedIn profile description must include at least one of these keywords","examples":[["software engineer"]]},"noneOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"No keywords","description":"The LinkedIn profile description must not include any of these keywords","examples":[["entry-level"]]}},"additionalProperties":false,"type":"object","title":"ProfileDescriptionFilter"},"PublicCompany":{"properties":{"domain":{"type":"string","title":"Domain","description":"Domain of the company, used as a unique identifier","examples":["dundermifflinpaper.com"]},"countries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Countries","description":"List of all countries in which the company operates","examples":[["us","ca"]]},"primaryCountry":{"type":"string","nullable":true,"title":"Primary country","description":"Main country of the company","examples":["us"]},"companySize":{"$ref":"#/components/schemas/PublicCompanySize","nullable":true,"title":"Company size range","description":"Company size range","examples":["2-10"]},"industryCategories":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Industrycategories","description":"Industry categories of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":[["Consumer Electronics","Hardware"]]},"industries":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Industries","description":"Industries of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":[["Audio","Electronics"]]},"linkedinIndustry":{"type":"string","nullable":true,"title":"Linkedinindustry","description":"Linkedin industry of the company<br>Available values can be found at /v2/data-fields endpoint.","examples":["Computer Software"]},"ecommerce":{"type":"boolean","nullable":true,"title":"E-Commerce","description":"True if the company is an e-commerce company","examples":[true]},"keywords":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Keywords","description":"Keywords associated with the company","examples":[["paper","premium copy paper"]]},"employeeCountOcean":{"type":"integer","nullable":true,"title":"Employeecountocean","description":"Number of people working at the company in our database.","examples":[57]},"employeeCountLinkedin":{"type":"integer","nullable":true,"title":"Employeecountlinkedin","description":"Number of people linked to the company page on Linkedin. This number might be higher than `employeeCountOcean` because of private profiles.","examples":[70]},"revenue":{"$ref":"#/components/schemas/Revenue","nullable":true,"title":"Revenue range","description":"Revenue range","examples":["1-10M"]},"yearFounded":{"type":"integer","nullable":true,"title":"Yearfounded","description":"Year the company was founded","examples":[1999]},"description":{"type":"string","nullable":true,"title":"Description","description":"Company's description","examples":["Dunder Mifflin Paper Company, Inc. is a fictional paper and office supplies wholesale company featured in the American television series The Office."]},"emails":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Emails","description":"Emails of the company","examples":[["email1@domain.com","email2@domain.com"]]},"phones":{"items":{"$ref":"#/components/schemas/ContactNumber"},"type":"array","nullable":true,"title":"Phones","description":"Phones of the company","examples":[[{"country":"us","number":"+1 212 456 7890","primary":true},{"country":"ca","number":"+1 250 555 0199"}]]},"logo":{"type":"string","nullable":true,"title":"Logo","description":"Logo of the company (URL)","examples":["https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png"]},"technologies":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Technologies","description":"Software technologies used by the company","examples":[["Accesso","Adcash","Atlassian Jira"]]},"technologyCategories":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Technology categories","description":"Technology categories of the company","examples":[["Security","Analytics","Blogs"]]},"mobileApps":{"items":{"$ref":"#/components/schemas/MobileApp"},"type":"array","nullable":true,"title":"Mobile apps","description":"Mobile apps produced by the company"},"webTraffic":{"$ref":"#/components/schemas/WebTraffic","nullable":true,"description":"Web traffic of the domain","examples":[{"bounceRate":0.5227,"pageViews":2155984,"pagesPerVisit":4.88,"visits":10000}]},"medias":{"$ref":"#/components/schemas/Medias","nullable":true,"title":"Social medias","description":"Social medias of the company"},"name":{"type":"string","nullable":true,"title":"Name","description":"Name of the company","examples":["Dunder Mifflin Paper Company"]},"legalName":{"type":"string","nullable":true,"title":"Legalname","description":"Legal name of the company","examples":["Dunder Mifflin Paper Company, Inc."]},"locations":{"items":{"$ref":"#/components/schemas/public_api__models__company__Location"},"type":"array","nullable":true,"title":"Locations","description":"Locations of the company"},"departmentSizes":{"items":{"$ref":"#/components/schemas/DepartmentSize"},"type":"array","nullable":true,"title":"Department sizes","description":"Number of employees per department","examples":[[{"department":"Accounting and Finance","size":10},{"department":"Sales","size":15}]]},"rootUrl":{"type":"string","nullable":true,"title":"Rooturl","description":"Root url to access the website","examples":["https://dundermifflinpaper.com/"]},"faxes":{"items":{"$ref":"#/components/schemas/ContactNumber"},"type":"array","nullable":true,"title":"Faxes","description":"Faxes of the company","examples":[[{"country":"us","number":"5709045026","primary":true}]]},"impressum":{"$ref":"#/components/schemas/Impressum","nullable":true,"title":"Impressum","description":"Impressum (Imprint) data of the company (only for Germany, Austria, Switzerland)"},"fundingRound":{"$ref":"#/components/schemas/FundingRound","nullable":true,"title":"Funding round","description":"Funding round of the company","examples":[{"cbUrl":"https://www.crunchbase.com/funding_round/orderyoyo-post-ipo-equity--5c26b0c0","date":"2020-01-01","moneyRaisedInUsd":1000000,"type":"Seed"}]},"redirectedFrom":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Redirected from","description":"Urls that redirects to this domain. We provide maximum 10 urls in this field.","examples":[["pol.dk","pressen.nu"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the company data been updated for the last time","examples":["2022-08-22T12:09:37Z"]},"headcountGrowth":{"$ref":"#/components/schemas/Growth","nullable":true,"title":"Headcount growth","description":"Headcount growth of the company","examples":[{"sixMonths":10,"sixMonthsPercentage":0.2,"threeMonths":5,"threeMonthsPercentage":0.1,"twelveMonths":15,"twelveMonthsPercentage":0.3}]},"headcountGrowthPerDepartment":{"items":{"$ref":"#/components/schemas/DepartmentSizesGrowth"},"type":"array","nullable":true,"title":"Headcount growth per department","description":"Headcount growth per department","examples":[[{"department":"Accounting and Finance","growth":{"sixMonths":10,"sixMonthsPercentage":0.2,"threeMonths":5,"threeMonthsPercentage":0.1,"twelveMonths":15,"twelveMonthsPercentage":0.3}}]]}},"type":"object","required":["domain"],"title":"PublicCompany"},"PublicCompanySize":{"type":"string","enum":["0-1","2-10","11-50","51-200","201-500","501-1000","1001-5000","5001-10000","10001-50000","50001-100000","100001-500000","500000+"],"title":"PublicCompanySize"},"PublicCompanyWithRelevance":{"properties":{"company":{"$ref":"#/components/schemas/PublicCompany","title":"Company","description":"Company found in the database"},"relevance":{"type":"string","enum":["A","B","C"],"nullable":true,"title":"Relevance category","description":"Relevance category (A - the most relevant)","examples":["A"]}},"type":"object","required":["company"],"title":"PublicCompanyWithRelevance"},"PublicCompanyWithScore":{"properties":{"company":{"$ref":"#/components/schemas/PublicCompany","title":"Company","description":"Company found in the database"},"score":{"type":"number","maximum":1.0,"minimum":0.0,"nullable":true,"title":"Similarity score","description":"Similarity score used for similarity search","examples":[0.96]}},"type":"object","required":["company"],"title":"PublicCompanyWithScore"},"PublicCompanyWithUniqueId":{"properties":{"company":{"$ref":"#/components/schemas/PublicCompany","nullable":true,"title":"Company","description":"Enriched company"},"uniqueId":{"type":"string","title":"Unique id of the company","description":"A unique identifier provided by the user for a company. This ID will be included in the webhook response together with the enriched company data, allowing the user to match the response to the original request.","examples":["uniqueid"]},"status":{"$ref":"#/components/schemas/MatchStatus","title":"Status","description":"Status of the company enrichment"}},"type":"object","required":["uniqueId","status"],"title":"PublicCompanyWithUniqueId"},"PublicCountryCodeToRegionMapping":{"properties":{"code":{"type":"string","nullable":true,"title":"Region code","description":"Region code in ISO-3166-2 format","examples":["nl-NH"]},"englishName":{"type":"string","nullable":true,"title":"Region name","description":"Region name","examples":["North Holland"]},"localName":{"type":"string","nullable":true,"title":"Region local name","description":"Region local name","examples":["Noord-Holland"]}},"type":"object","title":"PublicCountryCodeToRegionMapping"},"PublicGetDataFieldsResponse":{"properties":{"industries":{"items":{"$ref":"#/components/schemas/PublicIndustries"},"type":"array","title":"Industries","description":"List of industries","examples":[[{"industries":["Advertising Platforms","Biopharma"],"industryCategory":"Administrative Services"}]]},"linkedinIndustries":{"items":{"type":"string"},"type":"array","title":"Linkedin industries","description":"List of Linkedin industries","examples":[["Accounting","Airlines/Aviation","Alternative Dispute Resolution"]]},"technologies":{"items":{"$ref":"#/components/schemas/PublicTechnology"},"type":"array","title":"Technologies","description":"List of technologies","examples":[{"categories":["Chat"],"name":"ChatStack"}]},"regions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PublicCountryCodeToRegionMapping"},"type":"array"},"type":"object","title":"Country regions","description":"List of regions per country","examples":[{"nl":[{"code":"NH","englishName":"North Holland","localName":"Noord-Holland"}]}]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","title":"Seniorities","description":"List of seniorities computed from the job title of the person","examples":[["C-Level","Manager"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","title":"Departments","description":"List of departments computed from the job title of the person","examples":[["Management","Marketing and Advertising"]]}},"type":"object","title":"PublicGetDataFieldsResponse"},"PublicIndustries":{"properties":{"industries":{"items":{"type":"string"},"type":"array","title":"Industries","description":"List of industries","examples":[["Advertising Platforms","Biopharma"]]},"industryCategory":{"type":"string","nullable":true,"title":"Industry category","description":"Industry category name","examples":["Administrative Services"]}},"type":"object","title":"PublicIndustries"},"PublicPerson":{"properties":{"id":{"type":"string","title":"Id","description":"Internal ocean id of the person","examples":["e9447c74eafa8a19"]},"domain":{"type":"string","title":"Domain","description":"Domain of the company the person is working for","examples":["google.com"]},"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the person","examples":["John Doe"]},"firstName":{"type":"string","nullable":true,"title":"Firstname","description":"First name of the person","examples":["John"]},"lastName":{"type":"string","nullable":true,"title":"Lastname","description":"Last name of the person","examples":["Doe"]},"country":{"type":"string","nullable":true,"title":"Country","description":"Country code of the person","examples":["us","dk"]},"state":{"type":"string","nullable":true,"title":"State","description":"State code of the person","examples":["CA","NY"]},"location":{"type":"string","nullable":true,"title":"Location","description":"Location of the person","examples":["Copenhagen, Capital Region, Denmark"]},"linkedinUrl":{"type":"string","nullable":true,"title":"Linkedinurl","description":"Link to the linkedin profile of the person","examples":["https://www.linkedin.com/in/someone"]},"seniorities":{"items":{"$ref":"#/components/schemas/Seniority"},"type":"array","nullable":true,"title":"Seniorities","description":"List of seniorities computed from the job title of the person","examples":[["C-Level","Manager"]]},"departments":{"items":{"$ref":"#/components/schemas/Department"},"type":"array","nullable":true,"title":"Departments","description":"List of departments computed from the job title of the person","examples":[["Management","Marketing and Advertising"]]},"photo":{"type":"string","nullable":true,"title":"Photo","description":"Link to the person's profile picture on LinkedIn","examples":["http://media.licdn.com/dms/image/somelink"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["Professeur"]},"jobTitleEnglish":{"type":"string","nullable":true,"title":"Jobtitleenglish","description":"English translation of the person's job title","examples":["Teacher"]},"currentJobDescription":{"type":"string","nullable":true,"title":"Currentjobdescription","description":"Current job description of the person","examples":["Software Engineer specializing in cloud infrastructure"]},"experiences":{"items":{"$ref":"#/components/schemas/Experience"},"type":"array","nullable":true,"title":"Experiences","description":"List of experiences of the person","examples":[[{"dateFrom":"2020-01-01","dateTo":"2021-01-01","description":"Software Engineer specializing in cloud infrastructure","domain":"domain.com","jobTitle":"Software Engineer"}]]},"summary":{"type":"string","nullable":true,"title":"Summary","description":"Summary of the person","examples":["Some text that the person wrote to describe themselves"]},"skills":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Skills","description":"Skills of the person","examples":[["Product Management","Entrepreneurship","Social Media"]]},"phone":{"$ref":"#/components/schemas/public_api__models__person__Phone","nullable":true,"description":"Phone numbers of the person","examples":[{"numbers":["+4512345678","+33 6 00 00 00 00"],"status":"verified"}]},"email":{"$ref":"#/components/schemas/public_api__models__person__Email","nullable":true,"description":"Email of the person","examples":[{"address":"example.jonas@ocean.io","status":"verified"}]},"inferredEmails":{"items":{"type":"string"},"type":"array","title":"Inferredemails","description":"List of inferred email addresses for the person. This is only available for enterprise subscriptions.","examples":[["john.doe@domain.com","j.doe@domain.com"]]},"updatedAt":{"type":"string","nullable":true,"title":"Updated at","description":"When has the person data been updated for the last time","examples":["2022-10-27T12:09:37Z"]},"connectionsCount":{"type":"integer","nullable":true,"title":"Number of connections","description":"Number of LinkedIn connections of the person","examples":[10,500]},"followersCount":{"type":"integer","nullable":true,"title":"Number of followers","description":"Number of LinkedIn followers of the person","examples":[50,1000]},"headline":{"type":"string","nullable":true,"title":"Headline","description":"Headline of the person","examples":["Senior Software Engineer | Tech Lead"]}},"type":"object","required":["id","domain"],"title":"PublicPerson"},"PublicPersonPreviewBase":{"properties":{"name":{"type":"string","nullable":true,"title":"Name","description":"Full name of the person","examples":["John ***"]},"jobTitle":{"type":"string","nullable":true,"title":"Jobtitle","description":"Job title of the person","examples":["CEO"]}},"type":"object","title":"PublicPersonPreviewBase"},"PublicPersonWithCompanyPreview":{"properties":{"ranking":{"type":"integer","title":"Ranking","description":"Position ranking in the search results (1-based)","examples":[1,2,3]},"person":{"$ref":"#/components/schemas/PublicPersonPreviewBase","title":"Person","description":"Person information"},"company":{"$ref":"#/components/schemas/PublicPreviewCompany","nullable":true,"title":"Company","description":"Company information"}},"type":"object","required":["ranking","person"],"title":"PublicPersonWithCompanyPreview"},"PublicPersonWithUniqueId":{"properties":{"person":{"$ref":"#/components/schemas/PublicPerson","nullable":true,"title":"Person","description":"Enriched person","examples":[{"domain":"domain.com","id":"publicid","inferredEmails":[],"updatedAt":"2022-10-27T12:09:37Z"}]},"uniqueId":{"type":"string","title":"Unique id of the person","description":"A unique identifier provided by the user for a person. This ID will be included in the webhook response together with the enriched person data, allowing the user to match the response to the original request.","examples":["uniqueid"]},"status":{"$ref":"#/components/schemas/MatchStatus","title":"Status","description":"Status of the person enrichment"}},"type":"object","required":["uniqueId","status"],"title":"PublicPersonWithUniqueId"},"PublicPreviewCompany":{"properties":{"name":{"type":"string","title":"Company name","description":"Name of the company","examples":["Google","Apple","Microsoft"]},"logo":{"type":"string","title":"Company logo","description":"URL to the company logo","examples":["https://cdn2.ocean.io/logos/ocean.io/b162ddc061a4ca67e8aacbbf747dc8e62cce7496.png"]},"topIndustries":{"items":{"type":"string"},"type":"array","title":"Top industries","description":"Array of top 3 industries","examples":[["Analytics","B2B","Software"],["Analytics","B2B","Lead Generation"]]},"size":{"type":"string","nullable":true,"title":"Company size","description":"Company size in brackets","examples":["501-1000","1001-5000"]},"description":{"type":"string","title":"Company description","description":"Company description","examples":["B2B Sales and Marketing teams use Ocean.io's prospecting data platform to find accounts and contacts no one else can."]},"primaryCountry":{"type":"string","nullable":true,"title":"Primary country","description":"Primary country code of the company ","examples":["us","gb","dk"]},"primaryRegion":{"type":"string","nullable":true,"title":"Primary region","description":"Primary region code of the company","examples":["CA","UKE","WA"]},"linkedinHandle":{"type":"string","nullable":true,"title":"LinkedIn handle","description":"LinkedIn company handle/username","examples":["zoominfo","ocean-io"]}},"type":"object","required":["name","logo","topIndustries","size","description","primaryCountry","primaryRegion"],"title":"PublicPreviewCompany"},"PublicPreviewCompanyV3":{"properties":{"name":{"type":"string","title":"Company name","description":"Name of the company","examples":["Google","Apple","Microsoft"]},"logo":{"type":"string","title":"Company logo","description":"URL to the company logo","examples":["https://cdn2.ocean.io/logos/ocean.io/b162ddc061a4ca67e8aacbbf747dc8e62cce7496.png"]},"topIndustries":{"items":{"type":"string"},"type":"array","title":"Top industries","description":"Array of top 3 industries","examples":[["Analytics","B2B","Software"],["Analytics","B2B","Lead Generation"]]},"size":{"type":"string","nullable":true,"title":"Company size","description":"Company size in brackets","examples":["501-1000","1001-5000"]},"description":{"type":"string","title":"Company description","description":"Company description","examples":["B2B Sales and Marketing teams use Ocean.io's prospecting data platform to find accounts and contacts no one else can."]},"primaryCountry":{"type":"string","nullable":true,"title":"Primary country","description":"Primary country code of the company ","examples":["us","gb","dk"]},"primaryRegion":{"type":"string","nullable":true,"title":"Primary region","description":"Primary region code of the company","examples":["CA","UKE","WA"]},"linkedinHandle":{"type":"string","nullable":true,"title":"LinkedIn handle","description":"LinkedIn company handle/username","examples":["zoominfo","ocean-io"]}},"type":"object","required":["name","logo","topIndustries","size","description","primaryCountry","primaryRegion"],"title":"PublicPreviewCompanyV3"},"PublicPreviewCompanyV3Result":{"properties":{"ranking":{"type":"integer","title":"Ranking","description":"Position ranking in the search results (1-based)","examples":[1,2,3]},"relevance":{"type":"string","enum":["A","B","C"],"nullable":true,"title":"Relevance category","description":"Relevance category (A - the most relevant)","examples":["A"]},"company":{"$ref":"#/components/schemas/PublicPreviewCompanyV3","title":"Company","description":"Company information"}},"type":"object","required":["ranking","company"],"title":"PublicPreviewCompanyV3Result"},"PublicPreviewSearchCompaniesV3Body":{"properties":{"size":{"type":"integer","maximum":50.0,"minimum":5.0,"title":"Maximum number of results","description":"Number of companies to return. The maximum value is 50 and the minimum is 5","default":50,"examples":[50]},"companiesFilters":{"$ref":"#/components/schemas/CompaniesFiltersV3","nullable":true,"title":"Companies filters","description":"Collection of companies filters to be applied to the search"},"peopleFilters":{"$ref":"#/components/schemas/PeopleFiltersV3","nullable":true,"title":"People filters","description":"Collection of people filters to be applied to the search"}},"additionalProperties":false,"type":"object","title":"PublicPreviewSearchCompaniesV3Body"},"PublicPreviewSearchCompaniesV3Response":{"properties":{"totalHits":{"type":"integer","title":"Total hits","description":"Total number of companies found","examples":[5173]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]},"companies":{"items":{"$ref":"#/components/schemas/PublicPreviewCompanyV3Result"},"type":"array","title":"Companies found","description":"Array of found companies. Returns empty array if no results"}},"additionalProperties":false,"type":"object","required":["totalHits","creditsUsed","companies"],"title":"PublicPreviewSearchCompaniesV3Response"},"PublicRevealEmailBody":{"properties":{"personIds":{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1,"title":"Personids","description":"List of Ocean person ids to fetch the email data for. One email credit will be charged for every verified email found.","examples":[["personId1","personId2"]]},"webhookUrl":{"type":"string","title":"Webhookurl","description":"Url of the webhook the email data should be sent to, when completed.","examples":["https://some-url.com"]}},"additionalProperties":false,"type":"object","required":["personIds","webhookUrl"],"title":"PublicRevealEmailBody"},"PublicRevealEmailResult":{"properties":{"status":{"type":"string","enum":["in progress","webhook sent"],"title":"Status","description":"Status of the request. `\"in progress\"` if any email has to be verified in the background. All the email results are sent to the webhook once they are all done.","examples":["in progress"]}},"type":"object","required":["status"],"title":"PublicRevealEmailResult"},"PublicRevealEmailWebhookResult":{"properties":{"emails":{"items":{"$ref":"#/components/schemas/public_api__models__reveal_emails__Email"},"type":"array","title":"Emails","description":"Email data, sent back in the same order as the input ids.","examples":[[{"address":"email@domain.com","personId":"personId1","status":"verified"},{"address":"example@domain.com","personId":"personId2","status":"guessed"},{"personId":"personId3","status":"notFound"}]]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]}},"type":"object","required":["emails","creditsUsed"],"title":"PublicRevealEmailWebhookResult"},"PublicRevealPhoneBody":{"properties":{"personIds":{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1,"title":"Personids","description":"List of Ocean person ids to fetch the phone data for. One phone credit will be charged for every verified phone found.","examples":[["personId1","personId2"]]},"webhookUrl":{"type":"string","title":"Webhookurl","description":"Url of the webhook the phone data should be sent to, when completed.","examples":["https://some-url.com"]}},"additionalProperties":false,"type":"object","required":["personIds","webhookUrl"],"title":"PublicRevealPhoneBody"},"PublicRevealPhoneResult":{"properties":{"status":{"type":"string","enum":["in progress","webhook sent"],"title":"Status","description":"Status of the request. `\"in progress\"` if any phone has to be verified in the background. All the phone results are sent to the webhook once they are all done.","examples":["in progress"]}},"type":"object","required":["status"],"title":"PublicRevealPhoneResult"},"PublicRevealPhoneWebhookResult":{"properties":{"phones":{"items":{"$ref":"#/components/schemas/public_api__models__reveal_phones__Phone"},"type":"array","title":"Phones","description":"Phone data, sent back in the same order as the input ids.","examples":[[{"numbers":["+4512345678"],"personId":"personId1","status":"verified"},{"numbers":["+33600000000","+4512121212"],"personId":"personId2","status":"verified"},{"personId":"personId3","status":"notFound"}]]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[10.0]}},"type":"object","required":["phones","creditsUsed"],"title":"PublicRevealPhoneWebhookResult"},"PublicSearchCompaniesBodyV1":{"properties":{"size":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Maximum number of results","description":"Number of companies to return. The maximum value is 10,000. To get more than 10,000 results, use `searchAfter`.","default":50,"examples":[10]},"from":{"type":"integer","maximum":10001.0,"minimum":1.0,"title":"Index the returned results start from.","description":"Return companies from number X. Passing 1 will return all the results. Passing 10 will return results from the 10th. Note: `size + from` cannot be higher than 10,001","default":1,"examples":[10]},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Use `searchAfter` returned by the previous request to get the next page","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"companiesFilters":{"$ref":"#/components/schemas/CompaniesFiltersV1","nullable":true,"title":"Companies filters","description":"Collection of companies filters to be applied to the search"},"peopleFilters":{"$ref":"#/components/schemas/PeopleFilters","nullable":true,"title":"People filters","description":"Collection of people filters to be applied to the search, the search results will display companies that have at least one person matching those filters"},"fields":{"items":{"$ref":"#/components/schemas/CompanyField"},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.","examples":[["domain","countries","primaryCountry","companySize","industryCategories","industries","linkedinIndustry","ecommerce","keywords","employeeCountOcean","employeeCountLinkedin","revenue","yearFounded","description","emails","phones","logo","technologies","technologyCategories","mobileApps","webTraffic","medias","name","legalName","locations","departmentSizes","rootUrl","faxes","impressum","fundingRound","updatedAt"]]}},"additionalProperties":false,"type":"object","title":"PublicSearchCompaniesBodyV1"},"PublicSearchCompaniesBodyV3":{"properties":{"size":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Maximum number of results","description":"Number of companies to return. The maximum value is 10,000. To get more than 10,000 results, use `searchAfter`.","default":50,"examples":[10]},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Use `searchAfter` returned by the previous request to get the next page","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"companiesFilters":{"$ref":"#/components/schemas/CompaniesFiltersV3","nullable":true,"title":"Companies filters","description":"Collection of companies filters to be applied to the search"},"peopleFilters":{"$ref":"#/components/schemas/PeopleFiltersV3","nullable":true,"title":"People filters","description":"Collection of people filters to be applied to the search, the search results will display companies that have at least one person matching those filters"},"fields":{"items":{"$ref":"#/components/schemas/CompanyField"},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.","examples":[["domain","countries","primaryCountry","companySize","industryCategories","industries","linkedinIndustry","ecommerce","keywords","employeeCountOcean","employeeCountLinkedin","revenue","yearFounded","description","emails","phones","logo","technologies","technologyCategories","mobileApps","webTraffic","medias","name","legalName","locations","departmentSizes","rootUrl","faxes","impressum","fundingRound","updatedAt"]]}},"additionalProperties":false,"type":"object","title":"PublicSearchCompaniesBodyV3"},"PublicSearchCompaniesResult":{"properties":{"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Used for pagination. Use `searchAfter` returned by this request in the next request to get the next page of search results. If `searchAfter` is not present in the response then there is no next page.","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of results of the search, accessible with pagination.","examples":[32871]},"missingDomains":{"additionalProperties":{"anyOf":[{"type":"string","enum":["missing context vector","missing industries","missing keywords","missing industry categories"]},{"type":"string","enum":["bad content","crawler failed","data gathering started","in progress","invalid domain","other error","robots disallowed","unsupported language","invalid redirect","ssl certificate error"]}]},"type":"object","nullable":true,"title":"Missing domains","description":"Domains from `lookalikeDomains` filter that are either not present in Ocean's database or present but lacking necessary data to perform the search, along with the reason","examples":[{"domain-with-bad-content.com":"bad content","domain-with-missing-context-vector.com":"missing context vector","not-yet-crawled-domain.com":"data gathering started"}]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]},"companies":{"items":{"$ref":"#/components/schemas/PublicCompanyWithScore"},"type":"array","title":"Companies found","description":"Array of found companies. Returns empty array if no results"}},"type":"object","required":["detail","creditsUsed","companies"],"title":"PublicSearchCompaniesResult"},"PublicSearchCompaniesResultWithRelevance":{"properties":{"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Used for pagination. Use `searchAfter` returned by this request in the next request to get the next page of search results. If `searchAfter` is not present in the response then there is no next page.","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of results of the search, accessible with pagination.","examples":[32871]},"missingDomains":{"additionalProperties":{"anyOf":[{"type":"string","enum":["missing context vector","missing industries","missing keywords","missing industry categories"]},{"type":"string","enum":["bad content","crawler failed","data gathering started","in progress","invalid domain","other error","robots disallowed","unsupported language","invalid redirect","ssl certificate error"]}]},"type":"object","nullable":true,"title":"Missing domains","description":"Domains from `lookalikeDomains` filter that are either not present in Ocean's database or present but lacking necessary data to perform the search, along with the reason","examples":[{"domain-with-bad-content.com":"bad content","domain-with-missing-context-vector.com":"missing context vector","not-yet-crawled-domain.com":"data gathering started"}]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]},"companies":{"items":{"$ref":"#/components/schemas/PublicCompanyWithRelevance"},"type":"array","title":"Companies found","description":"Array of found companies. Returns empty array if no results"},"includeDomainsStatuses":{"additionalProperties":{"anyOf":[{"type":"string","enum":["missing context vector","missing industries","missing keywords","missing industry categories"]},{"type":"string","enum":["bad content","crawler failed","data gathering started","in progress","invalid domain","other error","robots disallowed","unsupported language","invalid redirect","ssl certificate error"]}]},"type":"object","nullable":true,"title":"Include domains statuses","description":"Domains from `includeDomains` filter that were not found in the search results, along with the reason","examples":[{"bad-content-domain.com":"bad content","invalid-domain.com":"invalid domain","not-found-domain.com":"other error"}]}},"type":"object","required":["detail","creditsUsed","companies"],"title":"PublicSearchCompaniesResultWithRelevance"},"PublicSearchPeopleBody":{"properties":{"size":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Maximum number of results","description":"Number of people to return. The maximum value is 10,000. To get more than 10,000 results, use `searchAfter`.","default":50,"examples":[10]},"from":{"type":"integer","maximum":10001.0,"minimum":1.0,"title":"Index the returned results start from.","description":"Return people from number X. Passing 1 will return all the results. Passing 10 will return results from the 10th. Note: `size + from` cannot be higher than 10,001","default":1,"examples":[10]},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Use `searchAfter` returned by the previous request to get the next page. Note: this cannot be used together with `onePersonPerDomain` enabled.","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"peopleFilters":{"$ref":"#/components/schemas/PeopleFilters","nullable":true,"title":"People filters","description":"Collection of filters to be applied to the search"},"companiesFilters":{"$ref":"#/components/schemas/CompaniesFiltersV1","nullable":true,"title":"Companies filters","description":"Collection of companies filters, the search results will display people that are associated with those companies"},"revealEmails":{"$ref":"#/components/schemas/RevealEmails","nullable":true,"title":"Reveal emails","examples":[{"includeEmails":true,"webhookUrl":"https://url.com/webhook"}]},"revealPhones":{"$ref":"#/components/schemas/RevealPhones","nullable":true,"title":"Reveal phones","examples":[{"includePhones":true,"webhookUrl":"https://url.com/webhook"}]},"onePersonPerDomain":{"type":"boolean","title":"Onepersonperdomain","description":"Only return one person per company","default":false,"examples":[false]},"peoplePerCompany":{"type":"integer","maximum":5.0,"minimum":1.0,"nullable":true,"title":"People per company","description":"Number of people to return per company. If you want to return all people from a company, don't set this value.","examples":[3,null]}},"additionalProperties":false,"type":"object","title":"PublicSearchPeopleBody"},"PublicSearchPeopleBodyV3":{"properties":{"size":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Maximum number of results","description":"Number of people to return. The maximum value is 10,000.","default":50,"examples":[10]},"peopleFilters":{"$ref":"#/components/schemas/PeopleFiltersV3","nullable":true,"title":"People filters","description":"Collection of filters to be applied to the search"},"companiesFilters":{"$ref":"#/components/schemas/CompaniesFiltersV3","nullable":true,"title":"Companies filters","description":"Collection of companies filters, the search results will display people that are associated with those companies"},"peoplePerCompany":{"type":"integer","maximum":20.0,"minimum":1.0,"nullable":true,"title":"People per company","description":"Number of people to return per company. If you want to return all people from a company, don't set this value.","examples":[3,null]},"jobTitleThreshold":{"type":"number","maximum":1.0,"minimum":0.0,"nullable":true,"title":"Job title threshold","description":"Threshold for job title similarity. The value must be between 0 and 1. Default is 0.8","default":0.8,"examples":[0.8]},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Use `searchAfter` returned by the previous request to get the next page.","examples":["N4IglgdgJgpgHiAXAVgL5A"]},"fields":{"items":{"anyOf":[{"$ref":"#/components/schemas/PersonField"},{"$ref":"#/components/schemas/PersonCompanyField"}]},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Person objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, the following default fields are returned: `id`, `domain`, `name`, `firstName`, `lastName`, `country`, `state`, `location`, `linkedinUrl`, `seniorities`, `departments`, `photo`, `jobTitle`, `jobTitleEnglish`, `currentJobDescription`, `experiences`, `summary`, `skills`, `headline`, `updatedAt`, `connectionsCount`, `followersCount`, `company.revenue`, `company.peopleCount`, `company.industries`, `company.technologies`, `company.latestFundingRound`.","examples":[["id","domain","name","firstName","lastName","country","state","location","linkedinUrl","seniorities","departments","photo","jobTitle","jobTitleEnglish","currentJobDescription","experiences","summary","skills","headline","updatedAt","connectionsCount","followersCount","company.revenue","company.peopleCount","company.industries","company.technologies","company.latestFundingRound"]]}},"additionalProperties":false,"type":"object","title":"PublicSearchPeopleBodyV3"},"PublicSearchPeopleBodyV3PreviewV3":{"properties":{"size":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Maximum number of results","description":"Number of people to return","default":50,"examples":[50]},"peopleFilters":{"$ref":"#/components/schemas/PeopleFiltersV3","nullable":true,"title":"People filters","description":"Collection of filters to be applied to the search"},"companiesFilters":{"$ref":"#/components/schemas/CompaniesFiltersV3","nullable":true,"title":"Companies filters","description":"Collection of companies filters, the search results will display people that are associated with those companies"},"peoplePerCompany":{"type":"integer","maximum":20.0,"minimum":1.0,"nullable":true,"title":"People per company","description":"Number of people to return per company. If you want to return all people from a company, don't set this value.","examples":[3,null]},"jobTitleThreshold":{"type":"number","maximum":1.0,"minimum":0.0,"nullable":true,"title":"Job title threshold","description":"Threshold for job title similarity. The value must be between 0 and 1. Default is 0.8","default":0.8,"examples":[0.8]},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Use `searchAfter` returned by the previous request to get the next page.","examples":["N4IglgdgJgpgHiAXAVgL5A"]},"fields":{"items":{"anyOf":[{"$ref":"#/components/schemas/PersonField"},{"$ref":"#/components/schemas/PersonCompanyField"}]},"type":"array","nullable":true,"title":"Fields","description":"Fields to return in the Person objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, the following default fields are returned: `id`, `domain`, `name`, `firstName`, `lastName`, `country`, `state`, `location`, `linkedinUrl`, `seniorities`, `departments`, `photo`, `jobTitle`, `jobTitleEnglish`, `currentJobDescription`, `experiences`, `summary`, `skills`, `headline`, `updatedAt`, `connectionsCount`, `followersCount`, `company.revenue`, `company.peopleCount`, `company.industries`, `company.technologies`, `company.latestFundingRound`.","examples":[["id","domain","name","firstName","lastName","country","state","location","linkedinUrl","seniorities","departments","photo","jobTitle","jobTitleEnglish","currentJobDescription","experiences","summary","skills","headline","updatedAt","connectionsCount","followersCount","company.revenue","company.peopleCount","company.industries","company.technologies","company.latestFundingRound"]]}},"additionalProperties":false,"type":"object","title":"PublicSearchPeopleBodyV3PreviewV3"},"PublicSearchPeopleEmailWebhookResult":{"properties":{"people":{"items":{"$ref":"#/components/schemas/EmailWebhookPerson"},"type":"array","title":"People"},"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of results of the search, accessible with pagination.","examples":[32871]}},"type":"object","required":["people","detail"],"title":"PublicSearchPeopleEmailWebhookResult"},"PublicSearchPeoplePhoneWebhookResult":{"properties":{"people":{"items":{"$ref":"#/components/schemas/PhoneWebhookPerson"},"type":"array","title":"People"},"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of results of the search, accessible with pagination.","examples":[32871]}},"type":"object","required":["people","detail"],"title":"PublicSearchPeoplePhoneWebhookResult"},"PublicSearchPeopleResult":{"properties":{"people":{"items":{"$ref":"#/components/schemas/PublicPerson"},"type":"array","title":"People"},"searchAfter":{"type":"string","nullable":true,"title":"Search after","description":"Used for pagination. Use `searchAfter` returned by this request in the next request to get the next page of search results. If `searchAfter` is not present in the response then there is no next page.","examples":["NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"]},"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of results of the search, accessible with pagination.","examples":[32871]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]}},"type":"object","required":["people","detail","creditsUsed"],"title":"PublicSearchPeopleResult"},"PublicSearchPeopleResultPreviewV3":{"properties":{"detail":{"type":"string","title":"Detail","description":"Status text","examples":["OK"]},"total":{"type":"integer","nullable":true,"title":"Total","description":"Total number of the available results.","examples":[75]},"redirectMap":{"additionalProperties":{"type":"string"},"type":"object","nullable":true,"title":"Domain redirection mapping","description":"Mapping of original domains passed in filters to their redirected domains.","examples":[{"given_local_domain.uk":"original.com","ikea.nl":"ikea.com"}]},"creditsUsed":{"type":"number","title":"Creditsused","description":"Number of credits charged for this request.","examples":[1.0]},"people":{"items":{"$ref":"#/components/schemas/PublicPersonWithCompanyPreview"},"type":"array","title":"People found","description":"Array of found people. Returns empty array if no results"}},"type":"object","required":["detail","creditsUsed","people"],"title":"PublicSearchPeopleResultPreviewV3"},"PublicTechnology":{"properties":{"name":{"type":"string","nullable":true,"title":"Technology name","description":"The technology name","examples":["ChatStack"]},"categories":{"items":{"type":"string"},"type":"array","title":"Technology categories","description":"Technology categories","examples":[["Chat"]]}},"type":"object","title":"PublicTechnology"},"RevealEmails":{"properties":{"includeEmails":{"type":"boolean","title":"Include emails","description":"Include the emails for all the results. One email credit will be charged for each verified email.","default":false,"examples":[true]},"webhookUrl":{"type":"string","nullable":true,"title":"Webhook url","description":"Only relevant if `includeEmails` is True. Webhook url to get the reveal email results, if any email has to be processed in the background.","examples":["https://url.com/webhook"]}},"additionalProperties":false,"type":"object","title":"RevealEmails"},"RevealPhones":{"properties":{"includePhones":{"type":"boolean","title":"Include phones","description":"Include the phones for all the results. One phone credit will be charged for each verified phone.","default":false,"examples":[true]},"webhookUrl":{"type":"string","nullable":true,"title":"Webhook url","description":"Only relevant if `includePhones` is True. Webhook url to get the reveal phone results, if any phone has to be processed in the background.","examples":["https://url.com/webhook"]}},"additionalProperties":false,"type":"object","title":"RevealPhones"},"Revenue":{"type":"string","enum":["0-1M","1-10M","10-50M","50-100M","100-500M","500-1000M",">1000M"],"title":"Revenue"},"ScoringFeature":{"properties":{"featureName":{"type":"string","title":"Featurename","description":"Feature that contributed to score"},"featureValue":{"type":"string","title":"Featurevalue","description":"Specific value that matched"},"score":{"type":"number","title":"Score","description":"Boost contribution"}},"type":"object","required":["featureName","featureValue","score"],"title":"ScoringFeature"},"Segment":{"properties":{"segmentId":{"type":"integer","title":"Segmentid","description":"Unique id of the segment within the segmentation.","examples":[1]},"name":{"type":"string","title":"Name","description":"Human-readable label describing the segment.","examples":["Enterprise data platforms"]},"domains":{"items":{"type":"string"},"type":"array","title":"Domains","description":"Domains of the companies assigned to this segment.","examples":[["snowflake.com","datadoghq.com"]]},"companyCount":{"type":"integer","title":"Companycount","description":"Number of companies in the segment.","examples":[2]},"traits":{"items":{"$ref":"#/components/schemas/ScoringFeature"},"type":"array","nullable":true,"title":"Traits","description":"Company attributes that most define the segment, each with the matched value and a relative score. Present when the segmentation was run with scoring features."},"crmMetrics":{"$ref":"#/components/schemas/SegmentCrmMetrics","nullable":true,"description":"Deal performance for the segment, from your connected CRM. `null` when CRM metrics aren't available."},"lookalikeCount":{"type":"integer","nullable":true,"title":"Lookalikecount","description":"Estimated number of lookalike companies for this segment.","examples":[1840]}},"type":"object","required":["segmentId","name","domains","companyCount"],"title":"Segment"},"SegmentCrmMetrics":{"properties":{"averageDealValue":{"type":"number","nullable":true,"title":"Averagedealvalue","description":"Average deal value for the segment, from your connected CRM.","examples":[48000]},"averageTimeToClose":{"type":"number","nullable":true,"title":"Averagetimetoclose","description":"Average time to close in days, from your connected CRM.","examples":[64]},"winRate":{"type":"number","nullable":true,"title":"Winrate","description":"Win rate for the segment (0-1), from your connected CRM.","examples":[0.31]},"untouchedCount":{"type":"integer","nullable":true,"title":"Untouchedcount","description":"Companies in the segment you have no CRM activity with yet.","examples":[12]}},"type":"object","required":["averageDealValue","averageTimeToClose","winRate","untouchedCount"],"title":"SegmentCrmMetrics"},"Segmentation":{"properties":{"segmentationId":{"type":"integer","title":"Segmentationid","description":"Unique id of the segmentation.","examples":[12345]},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","title":"Segments","description":"Resulting segments. Empty while `status` is `IN_PROGRESS`."},"status":{"$ref":"#/components/schemas/SegmentationStatus","description":"`IN_PROGRESS` while running, `SUCCESSFUL` when segments are ready, or `FAILED` if it could not be completed.","examples":["SUCCESSFUL"]},"totalAddressableMarket":{"type":"integer","nullable":true,"title":"Totaladdressablemarket","description":"Estimated number of lookalike companies across all segments.","examples":[3200]},"totalUntouched":{"type":"integer","nullable":true,"title":"Totaluntouched","description":"Companies in the addressable market you have no CRM activity with yet.","examples":[27]}},"type":"object","required":["segmentationId","segments","status"],"title":"Segmentation"},"SegmentationFilter":{"properties":{"segmentationId":{"type":"integer","title":"Segmentation ID","description":"ID of a segmentation to search within.","examples":[123]},"segmentId":{"type":"integer","title":"Segment ID","description":"ID of a segment within the segmentation.","examples":[456]},"returnScoringDetails":{"type":"boolean","nullable":true,"title":"Return Scoring Details","description":"If true, returns feature-level breakdown of lead scoring contributions for each company.","examples":[true]}},"additionalProperties":false,"type":"object","required":["segmentationId","segmentId"],"title":"SegmentationFilter"},"SegmentationId":{"properties":{"segmentationId":{"type":"integer","title":"Segmentationid","description":"Unique id of the segmentation. Use it to poll for results with the get segmentation endpoint.","examples":[12345]}},"type":"object","required":["segmentationId"],"title":"SegmentationId"},"SegmentationInput":{"properties":{"domains":{"items":{"type":"string"},"type":"array","title":"Domains","description":"Company domains to segment. Provide a representative set of the companies you want to group, typically your customers or best-fit accounts.","examples":[["stripe.com","twilio.com","datadoghq.com","snowflake.com"]]},"leadScoringFeatures":{"items":{"type":"string","enum":["company_size","industry_categories","industries","linkedin_industry","countries","primary_country","ecommerce","is_small_site","technologies","technology_categories","keywords","year_founded","international_presence","multiple_locations","web_traffic_visits","revenue","headcount_growth_3m","headcount_growth_6m","headcount_growth_12m","headcount_growth_3m_percentage","headcount_growth_6m_percentage","headcount_growth_12m_percentage"]},"type":"array","nullable":true,"title":"Leadscoringfeatures","description":"Company attributes to consider when grouping and scoring companies (for example `industries`, `technologies`, `company_size`). Omit to use the default feature set.","examples":[["industries","technologies","company_size"]]},"numberOfSegmentsMode":{"type":"integer","nullable":true,"title":"Numberofsegmentsmode","description":"Bias toward fewer or more segments. Omit to let the service choose the number that best fits the data."},"positiveDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Positivedomains","description":"Companies that are a good fit. The segmentation leans toward similar companies.","examples":[["stripe.com"]]},"negativeDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Negativedomains","description":"Companies that are a poor fit. The segmentation leans away from similar companies.","examples":[["tinyunknown.io"]]}},"type":"object","required":["domains"],"title":"SegmentationInput"},"SegmentationStatus":{"type":"string","enum":["IN_PROGRESS","SUCCESSFUL","FAILED"],"title":"SegmentationStatus"},"Seniority":{"type":"string","enum":["Owner","Founder","Board Member","C-Level","Partner","VP","Head","Director","Manager","Other"],"title":"Seniority"},"SkillsFilter":{"properties":{"allOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"All skills","description":"The LinkedIn profile skills must include all of these keywords","examples":[["Product Management","Entrepreneurship"]]},"anyOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Any skill","description":"The LinkedIn profile skills must include at least one of these keywords","examples":[["Social Media","Competitive Analysis"]]},"noneOf":{"items":{"type":"string"},"type":"array","nullable":true,"title":"No skills","description":"The LinkedIn profile skills must not include any of these keywords","examples":[["Writing","Project Management"]]}},"additionalProperties":false,"type":"object","title":"SkillsFilter"},"SocialMediasFilterV1":{"properties":{"medias":{"items":{"type":"string","enum":["linkedin","x","facebook","instagram","youtube","xing","tiktok"]},"type":"array","title":"Social medias","description":"Array of the social medias to include"},"mode":{"type":"string","enum":["anyOf","allOf"],"title":"Search mode","description":"[default] anyOf - match at least one of the medias<br>allOf - match all of the medias","default":"anyOf"}},"additionalProperties":false,"type":"object","required":["medias"],"title":"SocialMediasFilterV1"},"SocialMediasFilterV3":{"properties":{"medias":{"$ref":"#/components/schemas/AllAnyNoneFilterSocialMedia","nullable":true,"title":"Social medias","description":"Filter by social media presence"},"minCount":{"type":"integer","maximum":50.0,"minimum":1.0,"nullable":true,"title":"Min count","description":"Return companies that are present in more than `n` social networks"}},"additionalProperties":false,"type":"object","title":"SocialMediasFilterV3"},"State":{"properties":{"country":{"type":"string","minLength":1,"title":"Country code","description":"Alpha-2 ISO 3166 country code","examples":["us","ca"]},"abbreviation":{"type":"string","minLength":1,"title":"State name abbreviation","description":"Valid state abbreviation. List available in the region section there: /v2/data-fields."}},"additionalProperties":false,"type":"object","required":["country","abbreviation"],"title":"State"},"StatusResponse":{"properties":{"status":{"type":"string","title":"Status"}},"type":"object","required":["status"],"title":"StatusResponse"},"TechnologiesFilterV1":{"properties":{"technologies":{"items":{"type":"string"},"type":"array","title":"Technologies","description":"Array of the technologies to include"},"mode":{"type":"string","enum":["anyOf","allOf"],"title":"Search mode","description":"[default] anyOf - match at least one of the technologies<br>allOf - match all of the technologies","default":"anyOf"}},"additionalProperties":false,"type":"object","required":["technologies"],"title":"TechnologiesFilterV1"},"TechnologiesFilterV3":{"properties":{"apps":{"$ref":"#/components/schemas/AllAnyNoneFilter","nullable":true,"title":"Technology apps","description":"Filter by software technologies used by the company. Available values are located at /v2/data-fields endpoint."},"categories":{"$ref":"#/components/schemas/AllAnyNoneFilter","nullable":true,"title":"Technology categories","description":"Filter by software technology categories used by the company. Available values are located at /v2/data-fields endpoint."}},"additionalProperties":false,"type":"object","title":"TechnologiesFilterV3"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WarmupCompaniesBody":{"properties":{"domains":{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1,"title":"Domains","description":"Domains to be checked and added to the database if not present","examples":[["ocean.io","denmark.dk"]]}},"additionalProperties":false,"type":"object","required":["domains"],"title":"WarmupCompaniesBody"},"WarmupCompaniesResult":{"properties":{"successfulDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Successful domains","description":"Domains that are already present in Ocean's database","examples":[["successful-domain-1.com","successful-domain-2.com"]]},"triggeredDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Triggered domains","description":"Domains that are not currently present in Ocean's database. Data gathering process has been triggered for them","examples":[["domain-to-be-crawled-1.com","domain-to-be-crawled-2.com"]]},"ignoredDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Ignored domains","description":"Invalid domains that failed validation process","examples":[["bad-domain-1","bad-domain-2"]]},"missingDomains":{"additionalProperties":{"type":"string","enum":["bad content","crawler failed","data gathering started","in progress","invalid domain","other error","robots disallowed","unsupported language","invalid redirect","ssl certificate error"]},"type":"object","nullable":true,"title":"Missing domains","description":"Domains that are not present in Ocean's database and the reason","examples":[{"missing-domain-1.com":"bad content","missing-domain-2.com":"crawler failed"}]},"dataErrors":{"additionalProperties":{"type":"string","enum":["missing context vector","missing industries","missing keywords","missing industry categories"]},"type":"object","nullable":true,"title":"Domains with data errors","description":"Domains that are present in Ocean's database but lack the necessary data to perform the search, along with the reason","examples":[{"data-errors-domain-1.com":"missing context vector","data-errors-domain-2.com":"missing industry features"}]}},"type":"object","title":"WarmupCompaniesResult"},"WebTraffic":{"properties":{"visits":{"type":"integer","nullable":true,"title":"Total visits for the last available month","description":"Total number of visits of the website for the last available month"},"pageViews":{"type":"integer","nullable":true,"title":"Website views","description":"Number of views of the website for the last available month"},"pagesPerVisit":{"type":"number","nullable":true,"title":"Pages per visit","description":"Average number of pages viewed per visit for the last available month"},"bounceRate":{"type":"number","nullable":true,"title":"Bouncerate","description":"Bounce rate of the domain for the last available month"}},"type":"object","title":"WebTraffic"},"WebTrafficFilter":{"properties":{"visits":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Web traffic visits","description":"Only return companies that have a certain amount of visits. Valid range: 0-100,000,000,000","examples":[{"from":1000,"to":10000}]},"views":{"$ref":"#/components/schemas/FromTo","nullable":true,"title":"Page views","description":"Only return companies that have a certain amount of page views. Valid range: 0-100,000,000,000","examples":[{"from":1000,"to":1000000}]}},"additionalProperties":false,"type":"object","title":"WebTrafficFilter"},"models__autocomplete_companies__AutoCompletionBody":{"properties":{"name":{"type":"string","title":"Auto completion input","description":"Beginning of the name or the domain of a company","examples":["ocea"]},"countryFilters":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Country filters","description":"List of countries to filter for the autocompletion","examples":[["dk","se"]]},"excludeDomains":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Exclude domains","description":"List of domains to exclude from the results","examples":[["ocean.com"]]},"forLookalikeSearch":{"type":"boolean","title":"For lookalike search","description":"When `false`, returns all matching companies without domain validation or status filters. WARNING: Do not set this parameter to `false` if the autocomplete results will be used as input for a lookalike search.","default":true}},"additionalProperties":false,"type":"object","required":["name"],"title":"AutoCompletionBody"},"models__autocomplete_companies__AutoCompletionResult":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/AutoCompletionCompany"},"type":"array","title":"Companies found","description":"Array of found companies. Returns empty array if no results"}},"additionalProperties":false,"type":"object","required":["companies"],"title":"AutoCompletionResult"},"models__autocomplete_job_title__AutoCompletionBody":{"properties":{"query":{"type":"string","maxLength":100,"minLength":1,"title":"Autocomplete request for job title","description":"Beginning of the job title","examples":["developer"]},"limit":{"type":"integer","maximum":15.0,"minimum":1.0,"title":"Limit","description":"Number of job titles to return. Default is 5 if not specified, maximum is 15.","default":5,"examples":[5]}},"additionalProperties":false,"type":"object","required":["query"],"title":"AutoCompletionBody"},"models__autocomplete_job_title__AutoCompletionResult":{"properties":{"jobTitles":{"items":{"type":"string"},"type":"array","title":"Job titles found","description":"Array of found job titles. Returns empty array if no results","examples":["Software Engineer","Senior Software Engineer"]}},"additionalProperties":false,"type":"object","required":["jobTitles"],"title":"AutoCompletionResult"},"models__autocomplete_keyword__AutoCompletionBody":{"properties":{"query":{"type":"string","title":"Autocomplete request for keywords","description":"Beginning of the keyword","examples":["softw"]},"limit":{"type":"integer","maximum":15.0,"minimum":1.0,"title":"Limit","description":"Number of keywords to return. Default is 5 if not specified, maximum is 15.","default":5,"examples":[5]}},"additionalProperties":false,"type":"object","required":["query"],"title":"AutoCompletionBody"},"models__autocomplete_keyword__AutoCompletionResult":{"properties":{"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords found","description":"Array of found keywords. Returns empty array if no results","examples":["software","software development"]}},"additionalProperties":false,"type":"object","required":["keywords"],"title":"AutoCompletionResult"},"models__autocomplete_locations__AutoCompletionBody":{"properties":{"query":{"type":"string","title":"Autocomplete request for location","description":"Beginning of the location","examples":["londo"]},"limit":{"type":"integer","maximum":15.0,"minimum":1.0,"title":"Limit","description":"Number of locations to return. Default is 5 if not specified, maximum is 15.","default":5,"examples":[5]},"locationType":{"$ref":"#/components/schemas/LocationSearchType","title":"Location type","description":"Type of entities to search locations for. Use 'people' to include non-standard locations like 'San Francisco Bay Area'.","default":"companies","examples":["companies"]}},"additionalProperties":false,"type":"object","required":["query"],"title":"AutoCompletionBody"},"models__autocomplete_locations__AutoCompletionResult":{"properties":{"locations":{"items":{"$ref":"#/components/schemas/models__autocomplete_locations__Location"},"type":"array","title":"Locations found","description":"Array of found locations with metadata. Returns empty array if no results"}},"additionalProperties":false,"type":"object","required":["locations"],"title":"AutoCompletionResult"},"models__autocomplete_locations__Location":{"properties":{"countryCode":{"type":"string","title":"Country code","description":"ISO country code","examples":["us"]},"filterCode":{"type":"string","title":"Filter code","description":"Code used for filtering locations","examples":["us-CA"]},"name":{"type":"string","title":"Location name","description":"English name of the location","examples":["California"]},"parentCode":{"type":"string","title":"Parent code","description":"Code of the parent location","examples":["us"]},"parentName":{"type":"string","title":"Parent name","description":"Name of the parent location","examples":["United States"]},"type":{"$ref":"#/components/schemas/LocationType","title":"Location type","description":"Type of location: 1-country, 2-region, 3-municipality, 4-city","examples":["2-region"]}},"additionalProperties":false,"type":"object","required":["countryCode","filterCode","name","parentCode","parentName","type"],"title":"Location"},"models__autocomplete_skills__AutoCompletionBody":{"properties":{"query":{"type":"string","title":"Autocomplete request for skills","description":"Beginning of the skill name","examples":["python"]},"limit":{"type":"integer","maximum":15.0,"minimum":1.0,"title":"Limit","description":"Number of skills to return. Default is 5 if not specified, maximum is 15.","default":5,"examples":[5]}},"additionalProperties":false,"type":"object","required":["query"],"title":"AutoCompletionBody"},"models__autocomplete_skills__AutoCompletionResult":{"properties":{"skills":{"items":{"type":"string"},"type":"array","title":"Skills found","description":"Array of found skills. Returns empty array if no results","examples":["Python","Python Programming","Python Django"]}},"additionalProperties":false,"type":"object","required":["skills"],"title":"AutoCompletionResult"},"public_api__models__company__Location":{"properties":{"primary":{"type":"boolean","title":"Primary location","description":"True if the location is the headquarter of the company","default":false,"examples":[true,false]},"latitude":{"type":"number","nullable":true,"title":"Latitude","description":"Latitude of the location","examples":[43.6471]},"longitude":{"type":"number","nullable":true,"title":"Longitude","description":"Longitude of the location","examples":[-79.3971]},"country":{"type":"string","nullable":true,"title":"Country code","description":"Country code of the location","examples":["us"]},"locality":{"type":"string","nullable":true,"title":"Locality/City","description":"Locality (city) of the location","examples":["Scranton"]},"region":{"type":"string","nullable":true,"title":"Region","description":"Region of the location. Available abbreviation values are located at /v2/data-fields endpoint (region section)","examples":["Lackawanna County"]},"postalCode":{"type":"string","nullable":true,"title":"Postal code","description":"Postal code of the location","examples":["18505"]},"streetAddress":{"type":"string","nullable":true,"title":"Street address","description":"Street address of the location","examples":["Scranton Business Park, 1725 Slough Ave Suit 200"]},"state":{"type":"string","nullable":true,"title":"State","description":"Abbreviation of the location (if applicable). Available abbreviation values are located at /v2/data-fields endpoint (region section). Deprecated, please use `region` instead","examples":["pa"],"deprecated":true},"regionCode":{"type":"string","nullable":true,"title":"Region code","description":"Region code of the location","examples":["PA"]}},"type":"object","title":"Location"},"public_api__models__person__Email":{"properties":{"address":{"type":"string","nullable":true,"title":"Address","description":"Email address","examples":["name@gmail.com"]},"status":{"type":"string","enum":["verified","guessed","catchAll","notFound"],"title":"Status","description":"Status of the address: verified, catchAll or guessed"}},"type":"object","required":["address","status"],"title":"Email"},"public_api__models__person__Phone":{"properties":{"numbers":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Numbers","description":"Phone numbers","examples":[["+4512345678","+33 6 00 00 00 00"]]},"status":{"type":"string","enum":["verified","notFound","inProgress"],"title":"Status","description":"Status of the phone numbers: verified or not found"}},"type":"object","required":["numbers","status"],"title":"Phone"},"public_api__models__reveal_emails__Email":{"properties":{"address":{"type":"string","nullable":true,"title":"Address","description":"Email address","examples":["name@gmail.com"]},"status":{"type":"string","enum":["verified","guessed","catchAll","notFound"],"title":"Status","description":"Status of the address: verified, catchAll or guessed"},"personId":{"type":"string","title":"Personid","description":"Ocean ID of the person","examples":["personId"]}},"type":"object","required":["address","status","personId"],"title":"Email"},"public_api__models__reveal_phones__Phone":{"properties":{"numbers":{"items":{"type":"string"},"type":"array","nullable":true,"title":"Numbers","description":"Phone numbers","examples":[["+4512345678","+33 6 00 00 00 00"]]},"status":{"type":"string","enum":["verified","notFound","inProgress"],"title":"Status","description":"Status of the phone numbers: verified or not found"},"personId":{"type":"string","title":"Personid","description":"Ocean ID of the person","examples":["personId"]}},"type":"object","required":["numbers","status","personId"],"title":"Phone"},"RelevanceToThreshold":{"title":"RelevanceToThreshold","enum":[0.66,0.53,0],"x-enum-varnames":["A","B","C"]}}}}