Overview
The Company Enrichment API delivers structured data for one or more companies across sections such as firmographics, products, funding, headcount, and more. Optionally, you can customize the output by specifying which sections to include and defining custom fields with your own prompts. Returns request_id as a response.
Endpoint Details
Method: POST
Endpoint: /api/enterprise/company/enrich/
Authentication requirements
Include a valid JWT token in your request header
If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.
Request
Request Parameters
JWT token obtained from the Authentication request
Body Parameters
List of permalinks/ URLs of the companies to enrich E.g. "tesla-motors", "stripe" OR "https://tesla.com"
Sections of data to include in the enrichment. Supported values: firmographics, products, headcount, funding, public_company_financials, uk_private_company_financials, acquisitions, investments, website_traffic Default: all
List of custom fields to compute for each company
parameters.custom_fields[].field_name
Name of the custom field. Required if custom_fields is used.
parameters.custom_fields[].type
Data type of the field (e.g. text). Supported values: text. Required if custom_fields is used.
parameters.custom_fields[].prompt
Prompt used to generate the custom field value. Required if custom_fields is used.
Example Body
{
"companies" : [ "tesla-motors" , "stripe" ],
"sections" : [ "firmographics" , "products" , "funding" ],
"parameters" : {
"custom_fields" : [
{
"field_name" : "AI Readiness" ,
"type" : "text" ,
"prompt" : "Rate this company's AI readiness on a scale of 1-10 with reasoning"
}
]
}
}
Response
Successful response will include the request_id along with its status
Successful Response Fields
Request ID of the initiated request
JavaScript - Fetch
Python
cURL
Go
Java
const myHeaders = new Headers ();
myHeaders . append ( "Authorization" , "Bearer Token" );
myHeaders . append ( "Content-Type" , "application/json" );
const raw = JSON . stringify ({
"companies" : [
"tesla-motors" ,
"stripe"
],
"sections" : [
"firmographics" ,
"products" ,
"funding"
]
});
const requestOptions = {
method: "POST" ,
headers: myHeaders ,
body: raw ,
redirect: "follow"
};
fetch ( "{{path}}/api/enterprise/company/enrich/" , requestOptions )
. then (( response ) => response . text ())
. then (( result ) => console . log ( result ))
. catch (( error ) => console . error ( error ));
{
"request_id" : "931643e9-b6c7-45d4-9ba9-bd3b534221e7" ,
"status" : "PENDING"
}