List leads
Filter by status to read one pipeline stage. Note that status holds a stage
key, not a display name — fetch the keys from
GET /v1/lead-stages rather than
hard-coding "won", which tenants rename.
Authorizations
Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.
Keys are scoped. A key needs conversations:send to send, conversations:read to
read threads and messages, templates:read to list templates, and channels:read
to list channels. A key missing the scope for an endpoint gets 403.
The CRM endpoints use the same resource:action form: leads:read, leads:create,
leads:update, leads:delete, customers:read, customers:create,
customers:update, customers:delete, customers:manage.
Several resources have no scope of their own and borrow one:
Grant only what the integration needs — a key that only sends notifications should
hold conversations:send and nothing else.
Your workspace UUID. Required on every request in addition to x-api-key.
It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.
Query Parameters
Stage key.
urgent, high, medium, low Free text over name, email, and company.
x >= 1x >= 1Wins over page when supplied. Page by rows-already-held when reading a board:
a lead leaving a stage mid-read shifts a page-numbered window and skips a row.
x >= 0
