Skip to content

Count Company Search Variants

POST
/search/companies/count-variants

How many companies each filter set matches: the zero-results “without this filter” counts. No rows, no credits.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Count how many records several filter sets match. Nothing is returned but counts.

object
variants
required

Any number is accepted: the first 16 are counted and the keys of the rest come back in skipped.

Array<object>
>= 1 items

One filter set to count: the search as it would run, in the public field vocabulary.

object
filters

The filter conditions (AND logic).

Array<object>

A single filter condition.

object
field
required

Field name to filter on (e.g., ‘job_title’, ‘country’, ‘industry’)

string
operator
required

Filter operator

string
Allowed values: any_of contains all_of none_of is_empty is_not_empty between exists
value

Filter values

Array
key
required

Your name for this variant, e.g. the chip left out.

string
>= 1 characters <= 128 characters

Responses

200

Successful Response

object
data
required

Match counts per variant key.

object
at_least

Keys whose count is a lower bound (show 10,000+).

Array<string>
counts
required

Variant key to match count; null when it failed or timed out.

object
key
additional properties
Any of:
integer
skipped

Keys not counted: over the variant, condition or value limit.

Array<string>
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string