List 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));

import requests

url = "https://api-v2.getomni.ai/api/v1/leads"
headers = {
    "x-api-key": "<your-api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

curl --request GET \
  --url https://api-v2.getomni.ai/api/v1/leads \
  --header 'x-api-key: <your-api-key>'

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

GET

api

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));

import requests

url = "https://api-v2.getomni.ai/api/v1/leads"
headers = {
    "x-api-key": "<your-api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

curl --request GET \
  --url https://api-v2.getomni.ai/api/v1/leads \
  --header 'x-api-key: <your-api-key>'

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

This endpoint fetches all leads in your workspace.

Query Parameters

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.

string

Hide leads that carry any of the supplied tags. Pass a comma-separated list (?excludeTags=archived,do-not-contact) or repeat the parameter (?excludeTags=archived&excludeTags=do-not-contact). Matching is case-insensitive.

Response

array

Array of lead objects

string

Unique identifier for the lead

string

Lead name

string

Lead email address

string

Lead phone number

string

Business name

string

Lead status (e.g., “IN_PROGRESS”)

string

Summary of recent activity

number

Number of completed checklist items

number

Total number of checklist items

string[]

Tag names attached to the lead, sorted alphabetically. Empty array when none.

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));

import requests

url = "https://api-v2.getomni.ai/api/v1/leads"
headers = {
    "x-api-key": "<your-api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

curl --request GET \
  --url https://api-v2.getomni.ai/api/v1/leads \
  --header 'x-api-key: <your-api-key>'

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

API Introduction Get Lead

Getting Started

Leads

Documents

Spreads

Artifacts

Analytics

Webhooks

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response