Enrich Company

Endpoint

This endpoint returns company object model. The company is identified by the company id, website or linkedInUrl. Only 1 company is returned through this endpoints.

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

Request

Parameters

To enrich a company, specify one of the following identifiers id, website, or linkedinUrl.

Id

• Key: id
• Data Type: uuid
• Description: A universally unique identifier (UUID) compliant with RFC 4122 specification, used to uniquely identify entities in the system. Presented without hyphens.
• Example: 9e6a55b258ef11edb8780242ac120002

Website

• Key: website
• Data Type: url
• Description: A link to the company's website, formatted according to RFC 3986 guidelines.
• Example: https://acme.com

LinkedIn URL

• Key: linkedInUrl
• Data Type: url
• Premium: false
• Description: URL to a LinkedIn profile.
• Format: https://linkedin.com/company/[handle]
• Example: https://linkedin.com/company/acme

Fields To Return

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

Name	Default	Credits	Description
basic	true	1	Basic company information such as company Name, Website, Links, Headquarters Locations
premium	false	4	Premium company information such as Website Elements, Niches, Funding, Website Traffic and more

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

important

Only one of the identifiers is allowed.

Example

{ 
  "id": "9e6a55b258ef11edb8780242ac120002",
  "fieldsToReturn": "premium"
}

Response

The response includes a company object model.

Example

{
  "data": {  
    "id": "9e6a55b258ef11edb8780242ac120002",
    "name": "Acme Corporation",
    "logoUrl": "https://d1hbpr09pwz0sk.cloudfront.net/logo_url/607a654e",
    "headcount": 35,
    "operatingStatus": "Active",
    "purposeCategory": "For Profile",
    "stockSymbol": "ACME",
    "foundedAt": 2015,
    "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": [
      "NY"
    ],
    "headquartersCountryCodes": [
      "US"
    ],
    "unitedStatesHeadquartersRegions": [
      "East Coast"
    ],
    "headquartersWorldRegions": [
      "North America"
    ],
    "websiteExternalDomainCategories": [
      "Solar Energy"
    ],
    "websiteExternalDomains": [
      "https://solarenergy.com"
    ],
    "websitePages": ["Products", "Pricing"],
    "websiteHomePageTopics": [
      "Commercial Solar Projects",
      "Concentrated Solar Power (CSP)"
    ],
    "websitePricingPageTopics": [
      "Subscription",
      "Enterprise"
    ],
    "websiteTrafficGlobalRank": 1005234,
    "fundingAmount": 5000000,
    "fundingLastRoundAt": "2021-05-20",
    "spendingItTotalAmount": 2500000
  }
}