Fetch One Lead by ID — DeltaLead REST API Endpoint

The REST API is in early access and is enabled per account on request. API keys are not yet issued from the dashboard. To request access, contact your account executive.

Fetch the full detail of a lead by its identifier. Use this endpoint to display a lead inside your own tooling, sync a record to an external CRM, or read the latest state before taking an action.

Endpoint

GET https://platform-api.deltalead.ai/v1/leads/{id}

Path Parameters

string

required

The unique identifier of the lead. Lead IDs are prefixed with lead_, e.g. lead_abc123. You can obtain them from List Leads or from webhook payloads.

Example Request

cURL

curl https://platform-api.deltalead.ai/v1/leads/lead_abc123 \
  -H "Authorization: Bearer dl_live_YOUR_KEY"

Response

A successful request returns HTTP 200 OK with the full lead object. It is the same shape each element of List Leads returns.

200 OK

{
  "id": "lead_abc123",
  "organization_id": "org_00112233",
  "status": "qualified",
  "source": "landing-page",
  "score": 87,
  "contact": {
    "first_name": "María",
    "last_name": "García",
    "email": "maria@example.com",
    "phone": "+5491155551234",
    "display_name": "María García"
  },
  "channels": ["whatsapp", "custom"],
  "interested_vehicles": ["veh_9f2c41"],
  "tags": ["financiacion"],
  "assigned_to": "user_xyz789",
  "notes": [
    {
      "id": "note_4d7e21",
      "body": "Consultó por financiación a 36 cuotas.",
      "author_id": "user_xyz789",
      "source": "manual",
      "created_at": "2024-03-10T15:02:11Z",
      "updated_at": "2024-03-10T15:02:11Z"
    }
  ],
  "ai_summary": "Consulta por una Hilux SRX 2024 con financiación a 36 cuotas. Pidió que la contacten por la tarde.",
  "ai_summary_status": "completed",
  "metadata": {
    "crm_id": "CRM-88213",
    "utm_campaign": "hilux-marzo"
  },
  "last_activity_at": "2024-03-11T09:05:33Z",
  "created_at": "2024-03-10T14:22:00Z",
  "updated_at": "2024-03-11T09:05:33Z",
  "expire_at": null
}

Response Fields

string

Unique identifier for the lead, prefixed with lead_.

string

Identifier of the organization (dealership) that owns the lead.

string

Current status within the pipeline. One of new, contacted, qualified, appointment, proposal, incubating, won, lost.

string

Origin label reported by the system that generated the lead, e.g. landing-page. It is free text, always present, and does not replace channels.

integer

Qualification score assigned by DeltaLead. An unqualified lead scores 0.

object | null

Contact details for the person. Name, email, and phone live here, never at the root of the lead. null on a lead that has no contact details associated yet.

string | null

Given name.

string | null

Family name.

string | null

Email address. null if unknown.

string | null

Phone number, normally in E.164 format. null if unknown.

string

Display name, composed from first_name and last_name when none was provided.

array of string

Channels the lead has communicated through. It is an array because a lead accumulates them. Possible values: typeform, mercadolibre, whatsapp, custom, manual, odoo.

array of string

IDs of the catalogue vehicles the lead asked about. They are identifiers only — resolve them against the catalogue for the vehicle data. The shape is identical in List Leads.

array of string

Tags applied to the lead by your team.

string | null

ID of the salesperson the lead is assigned to. null if unassigned.

array of object

Notes on the lead, oldest first. Always an array of objects.

string

Identifier of the note.

string

Note text.

string

ID of the person or process that wrote the note.

string

Origin of the note. One of manual, typeform, legacy, ai_agent, custom_webhook.

string

ISO 8601 timestamp of when the note was created.

string | null

ISO 8601 timestamp of the last edit to the note. null if the note was never edited.

string | null

AI Summary of the conversation. null while ai_summary_status is anything other than completed.

string

State of the AI Summary. One of not_requested, pending, completed, failed.

object

The metadata object your integration sent to the Custom Webhook, promoted to the root of the lead and returned verbatim. This is the field that lets you confirm your own payload made it through intact, and re-associate the lead with the record in your source system. {} on a lead that arrived without metadata.

string | null

ISO 8601 timestamp of the last interaction recorded for this lead. null on a lead that has recorded none yet. This is the field last_activity_after and last_activity_before filter on.

string

ISO 8601 timestamp of when the lead was created.

string

ISO 8601 timestamp of the most recent change to any field on the lead.

string | null

ISO 8601 timestamp at which the lead deletes itself. Always null on a live lead — live leads never expire. On a lead created with a dl_sandbox_ key it carries the automatic purge date, so a sandbox lead that disappears is honouring the documented contract, not going missing.

Errors

404 — Lead not found

Returned when no lead with that id exists in your organization.

404 Not Found

{
  "status": "error",
  "detail": "lead_not_found"
}

An ID belonging to another organization also returns 404. Branch on the detail identifier, never on the text — see Errors.

Overview

Leads

Webhooks

Fetch One Lead by ID — DeltaLead REST API Endpoint

Endpoint

Path Parameters

Example Request

Response

Response Fields

Errors

​Endpoint

​Path Parameters

​Example Request

​Response

​Response Fields

​Errors

Endpoint

Path Parameters

Example Request

Response

Response Fields

Errors