Skip to main content
POST
List leads with their source mention

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.

Body

application/json
stage
string

Lead stage to filter to, for example new.

location_id
string

Business id to filter to.

include_archived
boolean

Include archived leads.

limit
integer

Maximum rows to return.

sort
string

Sort axis.

skip
integer

Rows to skip, for paging.

days
integer

Only leads detected within this many days.

Response

Success.

The response is of type object.