Skip to main content
GET
Who is at risk of leaving

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

clubId
integer

Only the people of this club.

signal
enum<string>
default:all

Only the people with this signal.

Available options:
all,
at_risk,
declining
limit
integer
default:100

How many rows a page holds.

Required range: 1 <= x <= 500
offset
integer
default:0

How many rows to skip.

Required range: x >= 0

Response

The report, with a page of its people

asOf
string<date>
totals
object
thresholds
object

The organization's own rules for its At Risk and Declining smart tags.

tags
object[]
signals
object

Which signals the organization has switched on.

rowsScope
enum<string>

The scope the rows need: without it rows and total are null and the figures come alone.

Available options:
contacts:read
total
integer | null

Every row, across all pages; null when the rows are withheld.

limit
integer
offset
integer
rows
object[] | null