Skip to main content
POST
companies.signal-suggestions.filter

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by companies.signal-group.create or a row of companies.signal-groups.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
field
enum<string>
required

Country, US state or industry filter.

Available options:
country,
state,
industry
operation
enum<string>
required

Include or exclude the supplied values.

Available options:
include,
exclude
values
string[]
required

Exact codes or industry names from the corresponding catalogue, up to 100.

Required array length: 1 - 100 elements
Required string length: 1 - 256

Response

The result

minEmployees
integer
required

Minimum employee bound; 0 is the service's default.

Required range: 0 <= x <= 9007199254740991
maxEmployees
integer
required

Maximum employee bound; 0 is the service's default.

Required range: 0 <= x <= 9007199254740991
includeCountries
string[]

Included country codes.

excludeCountries
string[]

Excluded country codes.

includeStates
string[]

Included US state codes.

excludeStates
string[]

Excluded US state codes.

includeIndustries
string[]

Included industries.

excludeIndustries
string[]

Excluded industries.