Skip to main content
POST

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. Set workflow 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

string
required
JWT token obtained from the Authentication request

Body Parameters

string
required
The workflow to run. Must be "company_peers" for Competitor List.
string
required
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/")
object
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.
string
A more descriptive query to refine the search scope.
string[]
Permalinks of representative companies or their complete URLs to anchor the competitor search.
string[]
Geographic scope. Pass ["Worldwide"] for no geographic restriction, or a list of ISO country codes (e.g. ["USA", "GBR"]).
string
Type of company to include. Accepted values: "private", "public", "all"
string[]
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+
object
Filter by company founding year.
integer
Minimum founding year (inclusive), e.g. 2010
integer
Maximum founding year (inclusive), e.g. 2020
string[]
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, Others
object
Filter by total funding amount raised (in USD).
number
Minimum total funding in USD, e.g. 1000000
number
Maximum total funding in USD, e.g. 50000000
boolean
When true, companies with no reported total funding are included in the results alongside companies that match the total_funding range.
object
Filter by last funding round amount (in USD).
number
Minimum last funding round in USD, e.g. 500000
number
Maximum last funding round in USD, e.g. 20000000
object
Filter by annual revenue (in USD).
number
Minimum annual revenue in USD, e.g. 500000
number
Maximum annual revenue in USD, e.g. 10000000
object
Filter by EBITDA (in USD).
number
Minimum EBITDA in USD
number
Maximum EBITDA in USD
object
Filter by net income (in USD).
number
Minimum net income in USD
number
Maximum net income in USD
object
Filter by EV/EBITDA multiple.
number
Minimum EV/EBITDA multiple
number
Maximum EV/EBITDA multiple

Response

A successful response returns a report_id that identifies the competitor list report.

Successful Response Fields

integer
Unique identifier for the report created by this request. Use it to track completion and to download the results (see below).

Tracking Completion and Exporting Results

Competitor List generation is asynchronous. After you receive a report_id:
  1. Use /api/assets/get_notebook_status/ to track completion of the report.
  2. Once the report is complete, use /api/assets/download_report/ to export the results.