Skip to main content
POST
companies.signal-rule.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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-rule.create or a row of companies.signal-rules.list.

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

Response

The result

groupName
string
required

Your signal group's display name.

name
string
required

Your signal rule's display name.

question
string
required

The company question being checked; may mention people from public sources.

importance
enum<string>
required

Company-signal importance. Exclude disqualifies companies; high helps find suggested accounts.

Available options:
exclude,
low,
normal,
high