Skip to main content
GET
List leads

Authorizations

Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Query Parameters

limit
integer
default:25

Max rows per page. Server caps at 100.

Required range: 1 <= x <= 100
cursor
string<uuid>

Cursor from a prior page response. Omit for the first page.

stale_for_days
integer

When set, scopes the result to qualified leads whose conversation last_message_at is older than now() - <stale_for_days> days (or NULL). Range 1–365. Returns 400 outside that range.

Required range: 1 <= x <= 365

Response

Page of leads.

data
object[]
required
next_cursor
string<uuid> | null
required
has_more
boolean
required