v2

latestOpenAPI 3.1.02026-07-262653151.5 KB

companies

Search for companies ids

Search for companies ids using the ElasticSearch Query DSL format

post/v3/companies/search

Headers

x-authenticate-teamstring

Partner accounts only. When present, the request is executed in the context of the specified child team (use the team_id returned by Create Team). When omitted, the request runs as the team that owns the API key.

Request body

queryobject required

Search query in the ElasticSearch Query DSL format. Find mapping here

limitinteger

Limit the number of results. If you want to use stable_pagination this parameter must be set to 1000

pagination_tokenstring

Pagination token received in the previous response

stable_paginationboolean

When set to true, ensures that pagination results remain consistent, even if the underlying data changes during retrieval. This is useful for retrieving large result sets reliably across multiple requests

Example request

{
  "query": {
    "match": {
      "company_info.industry": {
        "query": "Financial Services"
      }
    }
  }
}

Response

A list of company ids matching provided query

idsstring[] required

List of company ids

total_countinteger required

Total number of companies matching the query

pagination_tokenstring

Pagination token for the next request