{
"workflow": "company_peers",
"workbook_name": "LegalTech Players",
"permalink": "harvey-128b",
"advanced_settings": {
"detailed_query": "",
"companies": [],
"company_type": "all",
"geography": ["Worldwide"],
"employee_count": [],
"funding_stage": [],
"total_funding_include_blanks": true
}
}
{
"workflow": "company_peers",
"workbook_name": "LegalTech Players",
"permalink": "harvey-128b",
"advanced_settings": {
"detailed_query": "AI-powered legal research and drafting platforms",
"companies": [],
"company_type": "private",
"geography": ["USA", "GBR"],
"employee_count": ["51-100", "101-250"],
"funding_stage": ["Series A", "Series B"],
"total_funding": {
"from": 1000000,
"to": 50000000
},
"total_funding_include_blanks": false
}
}
{
"report_id": 117253
}
Discovery
Competitor List
POST
/
api
/
workflow_manager
/
start
/
{
"workflow": "company_peers",
"workbook_name": "LegalTech Players",
"permalink": "harvey-128b",
"advanced_settings": {
"detailed_query": "",
"companies": [],
"company_type": "all",
"geography": ["Worldwide"],
"employee_count": [],
"funding_stage": [],
"total_funding_include_blanks": true
}
}
{
"workflow": "company_peers",
"workbook_name": "LegalTech Players",
"permalink": "harvey-128b",
"advanced_settings": {
"detailed_query": "AI-powered legal research and drafting platforms",
"companies": [],
"company_type": "private",
"geography": ["USA", "GBR"],
"employee_count": ["51-100", "101-250"],
"funding_stage": ["Series A", "Series B"],
"total_funding": {
"from": 1000000,
"to": 50000000
},
"total_funding_include_blanks": false
}
}
{
"report_id": 117253
}
Overview
The Competitor List API generates a long list of companies similar to a given company, enriched with structured data. You can refine the output with a detailed query, sample companies, geography, company type, employee count, funding stage, financial filters, and more. Competitor List runs as a workflow. Setworkflow to company_peers in the request body to start one. The request returns a report_id, which you then use to track completion and export the results.
Endpoint Details
- Method: POST
- Endpoint:
/api/workflow_manager/start/
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
Header Parameters
Body Parameters
Name of the workbook that will hold the generated competitor list (e.g.
"LegalTech Players")Permalink or complete URL of the company whose peers need to be found (e.g.
"harvey-128b" OR "https://www.harvey.ai/")Filter parameters object. All filters live inside
advanced_settings. Include the object in every request, and send empty values ("", []) for any filter you do not want to apply.Permalinks of representative companies or their complete URLs to anchor the competitor search.
Geographic scope. Pass
["Worldwide"] for no geographic restriction, or a list of ISO country codes (e.g. ["USA", "GBR"]).Filter by employee headcount range. Pass an empty array to include all headcounts.Supported array values:
1-10, 11-50, 51-100, 101-250, 251-500, 501-1000, 1001-5000, 5001-10000, 10000+Filter by funding stage (e.g.
"Series A", "Series B"). Pass an empty array to include all stages.Supported array values: Non-Equity Assistance, Angel round, Pre-seed, Seed, Series A, Series B, Series C, Series D, Series E, Series F, Series G, Series H, Series I, Series J, Corporate-Funded, Debt-Funded, Private equity round, OthersWhen
true, companies with no reported total funding are included in the results alongside companies that match the total_funding range.{
"workflow": "company_peers",
"workbook_name": "LegalTech Players",
"permalink": "harvey-128b",
"advanced_settings": {
"detailed_query": "",
"companies": [],
"company_type": "all",
"geography": ["Worldwide"],
"employee_count": [],
"funding_stage": [],
"total_funding_include_blanks": true
}
}
{
"workflow": "company_peers",
"workbook_name": "LegalTech Players",
"permalink": "harvey-128b",
"advanced_settings": {
"detailed_query": "AI-powered legal research and drafting platforms",
"companies": [],
"company_type": "private",
"geography": ["USA", "GBR"],
"employee_count": ["51-100", "101-250"],
"funding_stage": ["Series A", "Series B"],
"total_funding": {
"from": 1000000,
"to": 50000000
},
"total_funding_include_blanks": false
}
}
Response
A successful response returns areport_id that identifies the competitor list report.
Successful Response Fields
Unique identifier for the report created by this request. Use it to track completion and to download the results (see below).
{
"report_id": 117253
}
Tracking Completion and Exporting Results
Competitor List generation is asynchronous. After you receive areport_id:
- Use
/api/assets/get_notebook_status/to track completion of the report. - Once the report is complete, use
/api/assets/download_report/to export the results.