Skip to main content
POST
/
v1
/
companies
/
insights
Get Company Insights
curl --request POST \
  --url https://api.preceptai.co.uk/v1/companies/insights \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookUrl": "https://your-site.com/webhook",
  "companies": [
    {
      "companyWebsite": "https://www.preceptai.co.uk",
      "customData": {
        "id": "12345"
      }
    },
    {
      "companyWebsite": "mywebsite.com",
      "companyLinkedin": "https://www.linkedin.com/company/mywebsite",
      "customData": {
        "id": "12345",
        "crm_id": "01234"
      }
    },
    {
      "companyLinkedin": "https://www.linkedin.com/company/samplecompany"
    },
    {
      "companyName": "Amazon",
      "companySocialUrl": "https://www.x.com/amazon"
    }
  ],
  "queries": [
    "What is their tech stack?",
    "Do they use HubSpot?"
  ],
  "enrichments": {
    "type": "decision_makers",
    "departments": [
      "engineering",
      "sales"
    ],
    "jobTitles": [
      "Software Engineer"
    ],
    "includeContactDetails": true,
    "limit": 10
  }
}
'
{
  "message": "Company enrichment requests accepted and are being processed.",
  "enrichment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
webhookUrl
string<uri>
required

The URL where the enrichment results will be sent via a POST request.

companies
object[]
required

An array of company objects to enrich. You can process multiple companies in a single request. You must provide either the company website or LinkedIn URL. If providing a social URL, you must also include the company's name.

queries
string[]

A list of natural language questions to ask about the company.

enrichments
object

An optional object to specify the desired enrichments.

Response

Request accepted. The enrichment is in progress. The response will vary based on whether all companies could be processed.

message
string
Example:

"Company enrichment requests accepted and are being processed."

enrichment_id
string<uuid>