Get Lead Checklist

Fetch the checklist for a specific lead

This endpoint fetches the checklist for a specific lead, including all checklist groups, items, and their current status.

Path Parameters

leadId · string · required

The unique identifier of the lead

Response

checklist groups · array

Array of checklist groups

Show checklist groups

id · string

Checklist group ID

name · string

Checklist group name

items · array

Array of checklist items in this group

Show items

id · string

Unique identifier for the checklist item entry

checklistItemId · string

ID of the checklist item definition

value · string|number

Current value for this checklist item (can be string, number, or null)

alternateValues · array

Array of alternate values for this checklist item (can be null)

validationError · string

Validation error message if validation failed

status · string

Status of the checklist item (e.g., “COMPLETED”, “TODO”)

checklistItem · object

Details about the checklist item definition

Show checklistItem

id · string

Unique identifier for the checklist item definition

code · string

Code identifier for the checklist item

label · string

Display label for the checklist item

fieldType · string

Field type (e.g., “TEXT”, “NUMBER”, “EMAIL”, “PHONE”, “ADDRESS”, “EIN”, “BANK_STATEMENT”, “TOOL”)

isRequired · boolean

Whether this item is required

helpText · string

Help text displayed to users for this checklist item

clientInstructions · string

Client-specific instructions for this checklist item

toolConfig · object

Tool configuration for tool-type checklist items

Show toolConfig

toolType · string

Type of tool (e.g., “deep_research”)

instructions · string

Instructions for the tool

config · object

Additional configuration for the tool

documents · array

Array of documents associated with this checklist item (only present for document-type items)

Show documents

id · string

Unique identifier for the document

filename · string

Original filename of the document

mimeType · string

MIME type of the document (e.g., “application/pdf”, “image/jpeg”)

size · number

File size in bytes

url · string

Pre-signed URL for accessing the document

metadata · object

Document metadata including processing status

Show metadata

extractionStatus · string

Status of the extraction (e.g., “completed”)

overallValid · boolean

Whether the document passed overall validation

validationResult · object

Detailed validation result for the document

Show validationResult

otherNotes · string

Additional notes about the validation

overallValid · boolean

Whether the document passed overall validation

validationResults · array

Array of individual validation rule results

Show validationResults

isValid · boolean

Whether this validation rule passed

ruleName · string

Name of the validation rule

isValidReason · string

Reason explaining why the rule passed or failed

Node.js

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

200

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