List and Filter Leads — 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.

Return your organization’s leads in a cursor-paginated response. The query parameters narrow the result by status, channel, and last-activity range, so you can surface exactly the pipeline segment your integration needs.

Endpoint

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

Query Parameters

string

Filter by the lead’s current status. The set is closed: new, contacted, qualified, appointment, proposal, incubating, won, lost. A value outside that list returns 422, not an empty result.

string

Return the leads that have accumulated this channel. The set is closed: typeform, mercadolibre, whatsapp, custom, manual, odoo. A value outside that list returns 422, not an empty result.

string

Return only leads whose last_activity_at is at or after this timestamp. The bound is inclusive. An ISO 8601 date-time string, e.g. 2024-01-15T00:00:00Z. It filters on last activity, not on creation date.

string

Return only leads whose last_activity_at is at or before this timestamp. The bound is inclusive. An ISO 8601 date-time string, e.g. 2024-01-31T23:59:59Z. It filters on last activity, not on creation date.

string

Pagination cursor returned as next_cursor by the previous response. Omit it to start from the first page. The value is opaque: do not parse or construct it.

integer

default:"20"

Maximum number of leads per page. An integer between 1 and 100.

There are no filters by score, by catalogue vehicle, or by free text: the six parameters above are the only ones the endpoint accepts.

Example Request

cURL

curl 'https://platform-api.deltalead.ai/v1/leads?status=qualified&channel=whatsapp&last_activity_after=2024-03-01T00:00:00Z&limit=20' \
  -H "Authorization: Bearer dl_live_YOUR_KEY"

Response

A successful request returns HTTP 200 OK with the data array and the two pagination fields at the root.

200 OK

{
  "data": [
    {
      "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": [],
      "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
    },
    {
      "id": "lead_def456",
      "organization_id": "org_00112233",
      "status": "new",
      "source": "mercadolibre",
      "score": 0,
      "contact": {
        "first_name": "Carlos",
        "last_name": "Méndez",
        "email": null,
        "phone": "+5215512345678",
        "display_name": "Carlos Méndez"
      },
      "channels": ["mercadolibre"],
      "interested_vehicles": [],
      "tags": [],
      "assigned_to": null,
      "notes": [],
      "ai_summary": null,
      "ai_summary_status": "not_requested",
      "metadata": {},
      "last_activity_at": "2024-03-10T17:01:55Z",
      "created_at": "2024-03-10T16:48:10Z",
      "updated_at": "2024-03-10T17:01:55Z",
      "expire_at": null
    }
  ],
  "next_cursor": "cursor_eyJpZCI6ImxlYWRfZGVmNDU2In0",
  "has_more": true
}

Response Fields

array

Leads matching the applied filters, most recent first. Each element has exactly the same shape Get Lead returns, field for field.

string | null

Pass this value as the cursor parameter to fetch the next page. null when has_more is false.

boolean

true if additional pages of results exist.

The response carries no total: counting one requires a second query over the same filter on every page. To walk the whole result, paginate until has_more is false.

For an incremental sync, combine last_activity_after with a stored cursor: fetch once with last_activity_after set to your last sync timestamp, then follow next_cursor until the result is exhausted. Because it filters on last activity rather than creation, the sync also picks up older leads that moved again.

Overview

Leads

Webhooks

List and Filter Leads — DeltaLead REST API Endpoint

Endpoint

Query Parameters

Example Request

Response

Response Fields

​Endpoint

​Query Parameters

​Example Request

​Response

​Response Fields

Endpoint

Query Parameters

Example Request

Response

Response Fields