OCocean
Enrich

Enrich companies

Changed on

Match companies with our database and enrich it with additional information.

Webhook result: Documentation

post/v2/enrich/companies

Request

  • Base URL
    https://api.ocean.io
  • URL
    https://api.ocean.io/v2/enrich/companies
  • Auth
    none declared

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

companyDataMappingobject required

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.

webhookUrlstring required

Url of the webhook the enriched companies should be sent to, when completed.

fieldsCompanyField[] nullable

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.

Example request

{
  "webhookUrl": "https://some-url.com",
  "fields": [
    "domain",
    "countries",
    "primaryCountry",
    "companySize",
    "industryCategories",
    "industries",
    "linkedinIndustry",
    "ecommerce",
    "keywords",
    "employeeCountOcean",
    "employeeCountLinkedin",
    "revenue",
    "yearFounded",
    "description",
    "emails",
    "phones",
    "logo",
    "technologies",
    "technologyCategories",
    "mobileApps",
    "webTraffic",
    "jobPostingsCount",
    "buyingSignals",
    "medias",
    "name",
    "legalName",
    "locations",
    "departmentSizes",
    "rootUrl",
    "faxes",
    "impressum",
    "fundingRound",
    "updatedAt"
  ]
}

Response

Successful Response

status'in progress' required

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.

Example response

{
  "status": "in progress"
}

Changes

  • 82337760de72Revision changes
    • info

      added the non-success response with the status

  • e2fea9198213Revision changes
    • info

      added the new buyingSignals enum value to the request property ///

    • info

      added the new buyingSignals enum value to the request property /