Getting Started
Leads
Documents
Analytics
const leadId = '4ef30123-90c2-4dc0-bd28-b43eee8664ea';
const options = {
method: 'GET',
headers: {
'x-api-key': '<your-api-key>',
},
};
fetch(`https://api-v2.getomni.ai/api/v1/leads/${leadId}/checklist`, options)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
[
{
"id": "2490cb41-4e65-47bc-a662-54e05ac8133d",
"name": "Business Information",
"items": [
{
"id": "a61b8be3-5f89-413b-b0eb-454a569bb06b",
"checklistItemId": "5f71c15b-0022-4b72-b1bf-daf7a76486f5",
"value": "Lexi",
"status": "COMPLETED",
"checklistItem": {
"id": "5f71c15b-0022-4b72-b1bf-daf7a76486f5",
"code": "BUSINESS_NAME",
"label": "Business Name",
"fieldType": "TEXT",
"isRequired": true
}
},
{
"id": "d78cbb58-5a6e-4fc3-8622-b783b3211b3f",
"checklistItemId": "2f791c62-6a04-4d29-b7fa-477b777800f6",
"value": null,
"status": "TODO",
"checklistItem": {
"id": "2f791c62-6a04-4d29-b7fa-477b777800f6",
"code": "EIN",
"label": "EIN",
"fieldType": "EIN",
"isRequired": true
}
}
]
}
]
Leads
Get Lead Checklist
Fetch the checklist for a specific lead
GET
/
api
/
v1
/
leads
/
{leadId}
/
checklist
const leadId = '4ef30123-90c2-4dc0-bd28-b43eee8664ea';
const options = {
method: 'GET',
headers: {
'x-api-key': '<your-api-key>',
},
};
fetch(`https://api-v2.getomni.ai/api/v1/leads/${leadId}/checklist`, options)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
[
{
"id": "2490cb41-4e65-47bc-a662-54e05ac8133d",
"name": "Business Information",
"items": [
{
"id": "a61b8be3-5f89-413b-b0eb-454a569bb06b",
"checklistItemId": "5f71c15b-0022-4b72-b1bf-daf7a76486f5",
"value": "Lexi",
"status": "COMPLETED",
"checklistItem": {
"id": "5f71c15b-0022-4b72-b1bf-daf7a76486f5",
"code": "BUSINESS_NAME",
"label": "Business Name",
"fieldType": "TEXT",
"isRequired": true
}
},
{
"id": "d78cbb58-5a6e-4fc3-8622-b783b3211b3f",
"checklistItemId": "2f791c62-6a04-4d29-b7fa-477b777800f6",
"value": null,
"status": "TODO",
"checklistItem": {
"id": "2f791c62-6a04-4d29-b7fa-477b777800f6",
"code": "EIN",
"label": "EIN",
"fieldType": "EIN",
"isRequired": true
}
}
]
}
]
This endpoint fetches the checklist for a specific lead, including all checklist groups, items, and their current status.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.
Path Parameters
The unique identifier of the lead
Response
Array of checklist groups
Show checklist groups
Show checklist groups
Checklist group ID
Checklist group name
Array of checklist items in this group
Show items
Show items
Unique identifier for the checklist item entry
ID of the checklist item definition
Current value for this checklist item (can be string, number, or null)
Array of alternate values for this checklist item (can be null)
Validation error message if validation failed
Status of the checklist item (e.g., “COMPLETED”, “TODO”)
Details about the checklist item definition
Show checklistItem
Show checklistItem
Unique identifier for the checklist item definition
Code identifier for the checklist item
Display label for the checklist item
Field type (e.g., “TEXT”, “NUMBER”, “EMAIL”, “PHONE”, “ADDRESS”, “EIN”, “BANK_STATEMENT”, “TOOL”)
Whether this item is required
Help text displayed to users for this checklist item
Client-specific instructions for this checklist item
Array of documents associated with this checklist item (only present for document-type items)
Show documents
Show documents
Unique identifier for the document
Original filename of the document
MIME type of the document (e.g., “application/pdf”, “image/jpeg”)
File size in bytes
Pre-signed URL for accessing the document
Document metadata including processing status
Show metadata
Show metadata
Status of the extraction (e.g., “completed”)
Whether the document passed overall validation
Detailed validation result for the document
Show validationResult
Show validationResult
Additional notes about the validation
Whether the document passed overall validation
const leadId = '4ef30123-90c2-4dc0-bd28-b43eee8664ea';
const options = {
method: 'GET',
headers: {
'x-api-key': '<your-api-key>',
},
};
fetch(`https://api-v2.getomni.ai/api/v1/leads/${leadId}/checklist`, options)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
[
{
"id": "2490cb41-4e65-47bc-a662-54e05ac8133d",
"name": "Business Information",
"items": [
{
"id": "a61b8be3-5f89-413b-b0eb-454a569bb06b",
"checklistItemId": "5f71c15b-0022-4b72-b1bf-daf7a76486f5",
"value": "Lexi",
"status": "COMPLETED",
"checklistItem": {
"id": "5f71c15b-0022-4b72-b1bf-daf7a76486f5",
"code": "BUSINESS_NAME",
"label": "Business Name",
"fieldType": "TEXT",
"isRequired": true
}
},
{
"id": "d78cbb58-5a6e-4fc3-8622-b783b3211b3f",
"checklistItemId": "2f791c62-6a04-4d29-b7fa-477b777800f6",
"value": null,
"status": "TODO",
"checklistItem": {
"id": "2f791c62-6a04-4d29-b7fa-477b777800f6",
"code": "EIN",
"label": "EIN",
"fieldType": "EIN",
"isRequired": true
}
}
]
}
]
⌘I