List Leads | BookedIn Documentation

import requests
url = "https://api.bookedin.ai/api/v1/leads"
headers = {"X-API-Key": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "items": [
    {
      "id": "lead_xyz789",
      "business_id": "string",
      "contact": {
        "name": {
          "first": "John",
          "last": "Smith"
        },
        "email": "john@example.com",
        "number": "+15551234567",
        "timezone": "America/New_York"
      },
      "source": "API",
      "meta": {
        "company": "Acme Corp",
        "industry": "Technology",
        "employees": 50
      },
      "data": {
        "objective_met": false,
        "history_summary": "No history summary yet",
        "lead_score": 1,
        "can_followup": true
      },
      "pipeline_id": "string",
      "pipeline_stage": {
        "current_stage": "string",
        "current_stage_name": "string",
        "entered_at": "2024-01-15T09:30:00Z"
      },
      "created_at": "2024-01-15T09:30:00Z"
    }
  ],
  "total": 1
}

Retrieve leads with optional filtering and search.

Authentication

X-API-Keystring

Your API key from Dashboard → Settings → API Keys

Your API key from [Dashboard → Settings → API Keys](https://dashboard.bookedin.ai/settings)

Query parameters

skipintegerOptionalDefaults to 0

Pagination offset

limitintegerOptionalDefaults to 100

Results per page

searchstringOptional

Search in name, email, and phone

sourcestringOptional

Filter by lead source (API, LIST, SMS, etc.)

emailstringOptional

Filter by exact email address

phonestringOptional

Filter by phone number

objective_metbooleanOptional

Filter by objective completion status

lead_score_rangeenumOptional

Filter by score range (hot: 70-100, warm: 30-69, cold: 10-29)

Allowed values:

Response

Paginated list of leads

itemslist of objects or null

totalinteger or null

Total matching leads