Leads

List Leads

List leads with search, filtering, and pagination.

GET
/leads
AuthorizationBearer <token>

API key authentication. Use format: Bearer kejue_...

In: header

Query Parameters

page?integer
Default1
page_size?integer
Default20
Rangevalue <= 100
search?string

Search by name, email, or phone number

status?string
priority?string

Priority level for the lead.

Value in"low" | "medium" | "high"
sort_by?string
Default"created_at"
sort_order?string
Default"desc"
Value in"asc" | "desc"

Response Body

application/json

curl -X GET "https://api.kejue.co/api/v1/leads"
{
  "leads": [
    {
      "id": 54321,
      "business_id": "string",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "phone_number": "+15551234567",
      "country": "US",
      "timezone": "America/New_York",
      "whatsapp_number": "string",
      "language": "english",
      "status": "pending",
      "lead_source": "api",
      "contact_attempts": 0,
      "notes": "Notes here",
      "priority": "medium",
      "metadata": {},
      "last_called_at": "2019-08-24T14:15:22Z",
      "last_messaged_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "retry_count": 0
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5,
    "has_next": true,
    "has_prev": false
  }
}
Empty

Last updated on