Get Lead | BookedIn Documentation

curl https://api.bookedin.ai/api/v1/leads/lead_id \
     -H "X-API-Key: <apiKey>"

{
  "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"
}

Retrieve a specific lead by ID.

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)

Path parameters

lead_idstringRequired

Query parameters

includestringOptional

Comma-separated additional data to include. Supported: execution_logs

Response

Lead details

idstring

Unique lead identifier

business_idstring

Business this lead belongs to

contactobject

Lead contact information

sourceenum

How this lead was created

metamap from strings to any

Custom metadata fields. Store any additional data about the lead.

dataobject

Lead status and scoring data

pipeline_idstring

Pipeline this lead is assigned to

pipeline_stageobject

Current pipeline stage information

created_atdatetime

Errors

404

Not Found Error