Skip to main content
GET
Get Custom Signals

Authorizations

Authorization
string
header
required

API key authentication. Include as Bearer token in Authorization header.

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
limit
integer
default:20

Number of results per page (maximum 100)

Required range: 1 <= x <= 100
include_total
boolean
default:true

false skips the full-cohort count: pagination.totalCount and totalPages come back null and the page is faster.

count
boolean
default:false

Return only the total count that matches the filters (data is empty). Free of charge.

type
string

Definition slug(s), comma-separated. Omitted = every definition. Find slugs with GET /signals/custom/definitions. A malformed slug is a 400; an unknown but well-formed slug matches nothing.

keyword
string

Search phrase that found the post (partial match)

min_confidence
number

Extractor confidence floor, 0 to 1

Required range: 0 <= x <= 1

Free-text search across headline, summary and company name

dateFrom
string<date>

Filter signals from this date (ISO 8601: YYYY-MM-DD), on occurredAt

dateTo
string<date>

Filter signals up to this date (ISO 8601: YYYY-MM-DD), on occurredAt

date_preset
enum<string>

Relative date shorthand — takes precedence over dateFrom/dateTo

Available options:
today,
yesterday,
last_7d,
last_14d,
last_30d,
last_60d,
last_90d,
last_6m,
last_1y,
last_2y,
last_3y,
last_5y,
all_time,
this_week,
this_month,
this_quarter,
this_year,
last_week,
last_month,
last_quarter,
last_year
countries
string

Company HQ allowlist: comma-separated ISO codes, names or regions (EU, DACH, …)

exclude_countries
string

Company HQ denylist: comma-separated names or codes. Unknown HQ is kept.

subcategories
string

Comma-separated subcategory IDs

company_domain
string

Recommended. Company website domain (single or comma-separated up to 50). Strict match; scheme, www. and trailing slash are ignored.

company_linkedin_url
string

Recommended. LinkedIn company URL. Strict match.

company_name
string

Exact, case-insensitive company name. Prefer the URL identifiers.

sort_by
enum<string>
default:occurred_at

Sort field

Available options:
occurred_at,
discovered_at,
confidence
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
filter_version
enum<integer>

Filter compatibility version. Omit for current behaviour; 1 freezes legacy matching; 2 enables strict country validation.

Available options:
1,
2

Response

Successful response with custom signals

success
boolean
data
object[]
pagination
object
meta
object