Skip to main content
POST
Search Companies via Query

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required

Natural language query to search for companies.

webhookUrl
string<uri>

Optional. Your webhook URL to receive the result of the company search operations. If not provided, you can poll the GET /v1/jobs/{jobId} endpoint.

limit
integer

Maximum number of companies to return (up to 1000).

Required range: x <= 1000
name
string

A readable name for your enrichment job.

enrichments
object

Optional enrichments to perform for each discovered company. See the Company Enrichments guide for detailed descriptions and example responses for each type.

queries
string[]

Response

Request accepted. The search and enrichment are in progress.

message
string
Example:

"Company search job successfully created and is being processed."

enrichment_id
string<uuid>