Enrich Companies (start)

Quota limitation

This endpoint will only accept as many organizations to enrich as there is company enrichment and search quota available

Starts bulk enriching the provided list of company domains and returns an enrichment ID. The enrichment will run asynchronously, and can take somewhere between 15 and 60 seconds, depending on the amount of companies to be processed.
In order to retrieve the enrichment results, send a request to endpoint GET /v1/organizations/enrichments/bulk/:id.

POST
/v1/organizations/enrichments/bulk

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

Companies to be enriched

domainsDeprecatedarray<string>

Deprecated: Use Organizations instead, which allows providing an external ID together with the domain

nameRequiredstring

Name for the new list that will created to store the results

organizationsarray<object>

List of organizations to enrich (maximum 500)

curl -X POST "https://api.surfe.com/v1/organizations/enrichments/bulk" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "domains": [
      "surfe.com",
      "apple.com",
      "microsoft.com"
    ],
    "name": "My list name",
    "organizations": [
      {
        "domain": "surfe.com",
        "externalID": "external-id"
      }
    ]
  }'

Enrichment ID

{
  "id": "enrichment-id"
}