Skip to main content
GET
https://api-v2.getomni.ai
/
api
/
v1
/
leads
/
:leadId
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(
  "https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5",
  options
)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "lead": {
    "id": "a9d0a790-201b-47e9-84ed-cc7eed1270c5",
    "activitySummary": null,
    "assigneeType": "HUMAN_AGENT",
    "businessName": "Pacific Coast Container Haulers",
    "createdAt": "2026-01-30T02:00:00.000Z",
    "deletedAt": null,
    "didOptOut": false,
    "email": "john@example.com",
    "emailVerifiedAt": "2026-01-30T02:00:00.000Z",
    "externalLeadId": null,
    "externalPortalLink": null,
    "firstName": "John",
    "isTest": false,
    "lastName": "Doe",
    "phoneNumber": "+16782319992",
    "phoneVerifiedAt": null,
    "source": "api",
    "submittedAt": null,
    "updatedAt": "2026-01-30T02:00:00.000Z",
    "website": null,
    "workspaceId": "ws-123"
  },
  "status": "IN_PROGRESS",
  "checklistItems": [
    {
      "id": "group-id",
      "name": "Business Information",
      "conditions": null,
      "items": [
        {
          "id": "lci-1",
          "checklistItemId": "ci-1",
          "value": "Pacific Coast Container Haulers",
          "status": "COMPLETED",
          "itemOverride": null,
          "checklistItem": {
            "id": "ci-1",
            "code": "business_name",
            "label": "Business Name",
            "fieldType": "TEXT",
            "isRequired": true,
            "conditions": null
          }
        }
      ]
    }
  ],
  "documents": [],
  "actionLogs": [
    {
      "id": "log-1",
      "type": "API_ACTIVITY",
      "status": "COMPLETED",
      "summary": "Lead created",
      "createdAt": "2026-01-30T02:00:00.000Z"
    }
  ],
  "matchingLeads": [],
  "lastAction": null,
  "nextFollowUp": null,
  "nextDraft": null
}
This endpoint returns a single lead by ID along with its full checklist, documents, action logs, matching leads, and scheduling state. The response is the same standardized shape used by the create and update endpoints.

​
Authentication

Requires the x-api-key header with a valid workspace API key.

​
Path Parameters

​
leadId
string
required
The Omni lead ID to retrieve.

​
Response

​
lead
object
The lead record. Includes: id, activitySummary, assigneeType, businessName, createdAt, deletedAt, didOptOut, email, emailVerifiedAt, externalLeadId, externalPortalLink, firstName, isTest, lastName, phoneNumber, phoneVerifiedAt, source, submittedAt, updatedAt, website, workspaceId.
​
status
string
Computed lead status. One of: IN_PROGRESS, COMPLETED, REVIEW, OPTED_OUT.
​
checklistItems
array
Full checklist for the lead, grouped by checklist group. Each group includes id, name, conditions, and an items array. Each item includes id, checklistItemId, value, status, itemOverride, and a nested checklistItem with code, label, fieldType, conditions, validationRules, etc. File-type items include a documents array with presigned URLs.
​
documents
array
All documents uploaded for this lead, with presigned download URLs.
​
actionLogs
array
Recent action logs for the lead (up to 100), enriched with tool info, messages, and document presigned URLs.
​
matchingLeads
array
Leads that share the same phone number or email (empty for test leads).
​
lastAction
object
The most recent completed outbound message or follow-up action log, including associated tool calls.
​
nextFollowUp
object
The next pending follow-up message action log, if any.
​
nextDraft
object
The next message awaiting approval, if any.
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(
  "https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5",
  options
)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "lead": {
    "id": "a9d0a790-201b-47e9-84ed-cc7eed1270c5",
    "activitySummary": null,
    "assigneeType": "HUMAN_AGENT",
    "businessName": "Pacific Coast Container Haulers",
    "createdAt": "2026-01-30T02:00:00.000Z",
    "deletedAt": null,
    "didOptOut": false,
    "email": "john@example.com",
    "emailVerifiedAt": "2026-01-30T02:00:00.000Z",
    "externalLeadId": null,
    "externalPortalLink": null,
    "firstName": "John",
    "isTest": false,
    "lastName": "Doe",
    "phoneNumber": "+16782319992",
    "phoneVerifiedAt": null,
    "source": "api",
    "submittedAt": null,
    "updatedAt": "2026-01-30T02:00:00.000Z",
    "website": null,
    "workspaceId": "ws-123"
  },
  "status": "IN_PROGRESS",
  "checklistItems": [
    {
      "id": "group-id",
      "name": "Business Information",
      "conditions": null,
      "items": [
        {
          "id": "lci-1",
          "checklistItemId": "ci-1",
          "value": "Pacific Coast Container Haulers",
          "status": "COMPLETED",
          "itemOverride": null,
          "checklistItem": {
            "id": "ci-1",
            "code": "business_name",
            "label": "Business Name",
            "fieldType": "TEXT",
            "isRequired": true,
            "conditions": null
          }
        }
      ]
    }
  ],
  "documents": [],
  "actionLogs": [
    {
      "id": "log-1",
      "type": "API_ACTIVITY",
      "status": "COMPLETED",
      "summary": "Lead created",
      "createdAt": "2026-01-30T02:00:00.000Z"
    }
  ],
  "matchingLeads": [],
  "lastAction": null,
  "nextFollowUp": null,
  "nextDraft": null
}