Skip to main content
GET
List leads

Authorizations

Authorization
string
header
required

An agent key (rpk_...) created in Settings → API & MCP, sent as Authorization: Bearer rpk_.... Bearer only: a cookie session can never drive this API. An OAuth 2.1 access token obtained from the same host works identically and lands on the same ceiling.

Headers

X-Workspace-Id
string

Which workspace to read. Omit it and you get the account’s home workspace, which on an agency account is often not where the live businesses are. A workspace this credential cannot read is refused with 403 rather than quietly answered from the default.

Query Parameters

q
string

JSON filter object, for example {"needs_response":true}.

sort_by
string

Field to sort on.

limit
integer

Maximum rows to return.

skip
integer

Rows to skip, for paging.

Response

Matching leads.

id
string

Unique id.

mention_id
string
tracker_id
string
location_id
string
intent_score
number
intent_reason
string
stage
enum<string>
Available options:
new,
contacted,
qualified,
won,
lost
stage_changed_at
string
notes
string
assigned_to
string
lost_reason
string
first_name
string
last_name
string
phone
string
email
string
suburb
string
postcode
string
source
string
is_archived
boolean
archived_at
string
seen_at
string
stale_post
boolean

Internal visibility flag, NOT a client notification: the source post was already older than LEAD_STALE_POST_FLAG_DAYS (default 30) when we discovered it. Stamped once at dispatch time by lib/notificationChannels.js and never recomputed — the fact worth keeping is 'the post was already this old when we found it', which a live now-minus-posted_at would lose as the lead ages on the board. ~2/day in practice, almost all Reddit threads that are topically correct but commercially dead.

stale_post_age_days
number

Age of the source post in days at the moment the lead was dispatched. Set alongside stale_post. Deepest observed: 5,408 days (a 2011 r/australia thread).