Skip to main content
GET
List leads

Authorizations

x-api-key
string
header
required

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.

X-Tenant-Id
string
header
required

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

status
string

Stage key.

assigned_to_user_id
string<uuid>
source
string
priority
enum<string>
Available options:
urgent,
high,
medium,
low

Free text over name, email, and company.

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: x >= 1
offset
integer

Wins 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.

Required range: x >= 0

Response

One page of leads.

data
object[]
required
total
integer
required
page
integer
required
limit
integer
required
totalPages
integer
required
hasMore
boolean
required