Skip to main content
GET
/
api
/
v1
/
leads
const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<your-api-key>',
  },
};

fetch('https://api-v2.getomni.ai/api/v1/leads', options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

[
  {
    "id": "4ef30123-90c2-4dc0-bd28-b43eee8664ea",
    "name": "+14155099231",
    "email": null,
    "phoneNumber": "4155099231",
    "businessName": "Lexi",
    "status": "IN_PROGRESS",
    "activitySummary": "• Multiple documents submitted; some failed validation, checklist updated",
    "completedChecklistItems": 2,
    "totalChecklistItems": 6,
    "tags": ["VIP", "priority-1"],
    "nextFollowUp": {
      "id": "372de835-c8cd-4791-abf6-485c679d31e5",
      "type": "FOLLOW_UP_MESSAGE",
      "status": "PENDING",
      "scheduledAt": "2025-10-15T16:00:00.000Z",
      "summary": "Request missing documents"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.getomni.ai/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint fetches all leads in your workspace.

​
Query Parameters

​
tags
string
Filter leads by tag. Pass a comma-separated list (?tags=vip,priority-1) or repeat the parameter (?tags=vip&tags=priority-1). Matching is case-insensitive.

​
Response

​
leads
array
Array of lead objects
​
id
string
Unique identifier for the lead
​
name
string
Lead name
​
email
string
Lead email address
​
phoneNumber
string
Lead phone number
​
businessName
string
Business name
​
status
string
Lead status (e.g., “IN_PROGRESS”)
​
activitySummary
string
Summary of recent activity
​
completedChecklistItems
number
Number of completed checklist items
​
totalChecklistItems
number
Total number of checklist items
​
tags
string[]
Tag names attached to the lead, sorted alphabetically. Empty array when none.
​
nextFollowUp
object
Information about the next scheduled follow-up
const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<your-api-key>',
  },
};

fetch('https://api-v2.getomni.ai/api/v1/leads', options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

[
  {
    "id": "4ef30123-90c2-4dc0-bd28-b43eee8664ea",
    "name": "+14155099231",
    "email": null,
    "phoneNumber": "4155099231",
    "businessName": "Lexi",
    "status": "IN_PROGRESS",
    "activitySummary": "• Multiple documents submitted; some failed validation, checklist updated",
    "completedChecklistItems": 2,
    "totalChecklistItems": 6,
    "tags": ["VIP", "priority-1"],
    "nextFollowUp": {
      "id": "372de835-c8cd-4791-abf6-485c679d31e5",
      "type": "FOLLOW_UP_MESSAGE",
      "status": "PENDING",
      "scheduledAt": "2025-10-15T16:00:00.000Z",
      "summary": "Request missing documents"
    }
  }
]