Skip to main content
GET
/
api
/
v1
/
leads
List leads
curl --request GET \
  --url https://app.vorel.ai/api/v1/leads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {},
      "status": "new",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "intent": "<string>",
      "timeline": "<string>",
      "qualification_score": 50,
      "source": "<string>"
    }
  ],
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "has_more": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.vorel.ai/llms.txt

Use this file to discover all available pages before exploring further.

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