Skip to main content
POST
Preview matching companies

Authorizations

Authorization
string
header
required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Body

application/json
filter
object | null

The filters to apply to the company search

semantic
object | null

The semantic query used to find relevant companies

lookalike
object | null

The seed companies used to find lookalike companies

Response

OK

items
object[]
required

The companies included in the preview

total
integer<int32>
required

The total number of matching companies accessible under the current plan

scores
object | null

Ranking scores by company ID for lookalike previews, including ranking penalties. Scores are not probabilities.

interpretation
object | null

How the semantic query was interpreted. Present for semantic queries with autoFilter enabled.