/lead_search/companies/search

POST /api/lead_search/companies/search

Price: 200 credits

Find companies matching a free-text description of what they do.

How to use it

Call this only when the user asks for a list of companies by a description of what they do; for a company name, industry or size use `/linkedin/search/companies` instead. Describe the companies wanted in plain words in `query`, in any language; every company returned was checked against that description, so do not re-filter them yourself. Put geography and headcount in `country` and `size` when you know them as codes. Companies come best match first; ask for as many as you need in `count`, up to 2000. Run one search per list and read more of it by repeating the same call with a larger `count`, not by rewording the query. The response warning (the `X-Warning` header) names the criteria the search cannot filter on, so verify those yourself before relying on them, and says when more companies match than one search holds: narrow the query to reach them.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string — Free-text description of the companies wanted, in any language. (default: ""; examples: "Find LinkedIn automation tools for outreach", "Anbieter von Lohnabrechnung für Remote-Teams"; maxLength: 2000)
• country array — HQ countries as ISO 3166-1 alpha-2 codes. (default: []; examples: ["US","GB"])
• size array — Employee count ranges. (default: []; one of: "1", "2-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001"; examples: ["11-50","51-200"])
• exclude_domains array — Company domains to leave out of the results. (default: []; examples: ["hubspot.com","lemlist.com"])
• count integer required — Max number of companies to return, best matches first. (min: 1; max: 2000)

Response

• @type string (default: "LeadSearchCompany")
• rank integer required
• urn string required
• name string required
• domain string nullable
• linkedin_url string nullable
• what_it_does string nullable
• why_matched string nullable
• country string nullable
• size string nullable
• employee_count integer nullable
• industry string nullable
• short_description string nullable
• founded_year integer nullable
• last_funding_type string nullable
• last_funding_at integer nullable
• competitor_names array (default: [])

Errors

• 422 — The query is empty or cannot be processed, or count is outside 1..2000. Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No company matched the description. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.