Skip to main content
GET
List contact predictive scores

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Query Parameters

segment_label
string

Filter to one health segment (champion, high_value_engaged, engaged, new, passive, at_risk, dormant, lost).

sort
string

Sort column; prefix with - for descending (default -churn_risk).

limit
integer

Page size (1-100, default 25).

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor from a previous page's meta.

Response

200 - application/json

A page of scored contacts in data; the next cursor and any degraded flag are in meta.

data
object[]
meta
object