Enrich Companies

Endpoint

This endpoint returns an array of company object model. The company is identified by id or linkedInUrl.

• URL: https://api.profileapi.com/2024-03-01/companies/enrich
• HTTP Method: POST

Request

Parameters

To enrich companies, specify either ids, linkedInUrls, or namesWebsites.

Ids (Option A)

• Key: ids
• Data Type: Array of <string>
• Description: An array of universally unique identifier (UUID) compliant with RFC 4122 specification, used to uniquely identify entities in the system. Presented without hyphens.
• Example: ["9e6a55b258ef11edb8780242ac120002"]

LinkedIn URLs (Option B)

• Key: linkedInUrls
• Data Type: Array of <string>
• Description: URL to a LinkedIn profile.
• Format: https://linkedin.com/company/[handle]
• Example: [ "https://linkedin.com/company/acme" ]

Names and Websites (Option C)

• Key: namesWebsites
• Data Type: Array of <object>
• Description: An array of company objects with name and website
• Example:

[
  {
    "name": "Acme Corporation",
    "website": "https://acme.com"
  },
  {
    "name": "Example Inc",
    "website": "https://example.com"
  }
]

Each object in the array contains:

• name (string, required): Company name
• website (url, required): A link to the company's website, formatted according to RFC 3986 guidelines

important

You must provide exactly one of the following options: Option A (ids), Option B (linkedInUrls), or Option C (namesWebsites). There is a maximum of 100 items for any of the options.

Fields To Return

• Key: fieldsToReturn
• Data Type: string
• Description: The fields to return
• Options:

Name	Default	Credits Per Company	Description
basic	true	1	Basic company information such as company Name, Website, Links, Headquarters Locations
premium	false	4	Premium company information to include AI generated traits

Please refer to company object model for a list of basic vs premium fields.

Example

{
  "ids": ["9e6a55b258ef11edb8780242ac120002"],
  "fieldsToReturn": "premium"
}

{
  "linkedInUrls": ["https://linkedin.com/company/acme"],
  "fieldsToReturn": "premium"
}

{
  "namesWebsites": [
    {
      "name": "Acme Corporation",
      "website": "https://acme.com"
    },
    {
      "name": "Example Inc",
      "website": "https://example.com"
    }
  ],
  "fieldsToReturn": "premium"
}

info

You will only be charged a credit on success. If we don't find the company, you will not be charged.

Response

The response includes an array of company object model.

Example

{
  "data": {
    "results": [
      {
        "id": "9e6a55b258ef11edb8780242ac120002",
        "name": "Acme Corporation",
        "logoUrl": "https://d1hbpr09pwz0sk.cloudfront.net/logo_url/607a654e",
        "headcount": 35,
        "stockSymbol": "ACME",
        "website": "https://acmecorp.com",
        "angellistUrl": "https://angel.co/acmecorp",
        "crunchbaseUrl": "https://www.crunchbase.com/organization/acmecorp",
        "facebookUrl": "https://facebook.com/acmecorp",
        "githubUrl": "https://github.com/acmecorp",
        "linkedInUrl": "https://linkedin.com/company/acmecorp",
        "xUrl": "https://twitter.com/acmecorp",
        "youtubeUrl": "https://youtube.com/user/acmecorp",
        "industry": "Technology",
        "niche": "Cloud Computing",
        "unitedStatesHeadquartersStateCodes": ["CA"],
        "unitedStatesHeadquartersCities": ["San Francisco"],
        "unitedStatesHeadquartersRegions": ["East Coast"],
        "headquartersCountryCodes": ["US"],
        "headquartersWorldRegions": ["North America"],
        "traits": [
          {
            "key": "aboutComplianceCCPA",
            "isActive": true
          },
          {
            "key": "aboutComplianceGDPR",
            "isActive": false
          },
          {
            "key": "businessModelTypeSubscription",
            "isActive": true
          },
          {
            "key": "businessModelB2B",
            "isActive": true
          }
        ]
      }
    ],
    "pagination": {
      "nextStart": [
        {
          "id": "9e6a55b258ef11edb8780242ac121233",
          "score": 0.92
        }
      ]
    }
  }
}