Skip to main content
POST
Search for companies ids
The Search Companies endpoint searches the internal database of Companies using OpenSearch DSL. See OpenSearch Mapping for available fields. Replace "query" with your OpenSearch DSL query and set the x-api-key header. Search returns up to 1000 results per page. Pagination works the same as the Search Profiles endpoint.
Response example
For query examples, see Search endpoint examples.

Partner teams

Partners can execute a request in the context of a child team by passing the child team’s ID in the x-authenticate-team header:
  • With the header β€” the search runs in the context of the child team.
  • Without the header β€” the search runs in the context of the team that owns the API key (default).
The child_team_id is returned when you create a child team.
Example request
Migrating from v2? v3 uses snake_case for all field names. The v2 equivalents were paginationToken and totalCount. See the Migrating to v3 guide.

Authorizations

x-api-key
string
header
required

Headers

x-authenticate-team
string

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.

Body

application/json
query
object
required

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

Example:
limit
integer
default:100

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

Required range: 0 <= x <= 1000
pagination_token
string

Pagination token received in the previous response

stable_pagination
boolean
default:false

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

Response

A list of company ids matching provided query

ids
string<uuid>[]
required

List of company ids

total_count
integer
required

Total number of companies matching the query

pagination_token
string

Pagination token for the next request