> ## 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.

# 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

<ParamField path="leadId" type="string" required>
  The unique identifier of the lead
</ParamField>

## Response

<ResponseField name="checklist groups" type="array">
  Array of checklist groups

  <Expandable title="checklist groups">
    <ResponseField name="id" type="string">
      Checklist group ID
    </ResponseField>

    <ResponseField name="name" type="string">
      Checklist group name
    </ResponseField>

    <ResponseField name="items" type="array">
      Array of checklist items in this group

      <Expandable title="items">
        <ResponseField name="id" type="string">
          Unique identifier for the checklist item entry
        </ResponseField>

        <ResponseField name="checklistItemId" type="string">
          ID of the checklist item definition
        </ResponseField>

        <ResponseField name="value" type="string|number" nullable>
          Current value for this checklist item (can be string, number, or null)
        </ResponseField>

        <ResponseField name="alternateValues" type="array" nullable>
          Array of alternate values for this checklist item (can be null)
        </ResponseField>

        <ResponseField name="validationError" type="string" nullable>
          Validation error message if validation failed
        </ResponseField>

        <ResponseField name="status" type="string">
          Status of the checklist item (e.g., "COMPLETED", "TODO")
        </ResponseField>

        <ResponseField name="checklistItem" type="object">
          Details about the checklist item definition

          <Expandable title="checklistItem">
            <ResponseField name="id" type="string">
              Unique identifier for the checklist item definition
            </ResponseField>

            <ResponseField name="code" type="string">
              Code identifier for the checklist item
            </ResponseField>

            <ResponseField name="label" type="string">
              Display label for the checklist item
            </ResponseField>

            <ResponseField name="fieldType" type="string">
              Field type (e.g., "TEXT", "NUMBER", "EMAIL", "PHONE", "ADDRESS", "EIN", "BANK\_STATEMENT", "TOOL")
            </ResponseField>

            <ResponseField name="isRequired" type="boolean">
              Whether this item is required
            </ResponseField>

            <ResponseField name="helpText" type="string">
              Help text displayed to users for this checklist item
            </ResponseField>

            <ResponseField name="clientInstructions" type="string" nullable>
              Client-specific instructions for this checklist item
            </ResponseField>

            <ResponseField name="toolConfig" type="object" nullable>
              Tool configuration for tool-type checklist items

              <Expandable title="toolConfig">
                <ResponseField name="toolType" type="string">
                  Type of tool (e.g., "deep\_research")
                </ResponseField>

                <ResponseField name="instructions" type="string">
                  Instructions for the tool
                </ResponseField>

                <ResponseField name="config" type="object">
                  Additional configuration for the tool
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="documents" type="array" nullable>
          Array of documents associated with this checklist item (only present for document-type items)

          <Expandable title="documents">
            <ResponseField name="id" type="string">
              Unique identifier for the document
            </ResponseField>

            <ResponseField name="filename" type="string">
              Original filename of the document
            </ResponseField>

            <ResponseField name="mimeType" type="string">
              MIME type of the document (e.g., "application/pdf", "image/jpeg")
            </ResponseField>

            <ResponseField name="size" type="number">
              File size in bytes
            </ResponseField>

            <ResponseField name="url" type="string">
              Pre-signed URL for accessing the document
            </ResponseField>

            <ResponseField name="metadata" type="object">
              Document metadata including processing status

              <Expandable title="metadata">
                <ResponseField name="extractionStatus" type="string">
                  Status of the extraction (e.g., "completed")
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="overallValid" type="boolean">
              Whether the document passed overall validation
            </ResponseField>

            <ResponseField name="validationResult" type="object" nullable>
              Detailed validation result for the document

              <Expandable title="validationResult">
                <ResponseField name="otherNotes" type="string">
                  Additional notes about the validation
                </ResponseField>

                <ResponseField name="overallValid" type="boolean">
                  Whether the document passed overall validation
                </ResponseField>

                <ResponseField name="validationResults" type="array">
                  Array of individual validation rule results

                  <Expandable title="validationResults">
                    <ResponseField name="isValid" type="boolean">
                      Whether this validation rule passed
                    </ResponseField>

                    <ResponseField name="ruleName" type="string">
                      Name of the validation rule
                    </ResponseField>

                    <ResponseField name="isValidReason" type="string">
                      Reason explaining why the rule passed or failed
                    </ResponseField>
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```javascript Node.js theme={null}
  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));
  ```

  ```python Python theme={null}
  import requests

  lead_id = '4ef30123-90c2-4dc0-bd28-b43eee8664ea'
  url = f"https://api-v2.getomni.ai/api/v1/leads/{lead_id}/checklist"
  headers = {
      "x-api-key": "<your-api-key>"
  }

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

  ```bash cURL theme={null}
  curl --request GET \
    --url https://api-v2.getomni.ai/api/v1/leads/4ef30123-90c2-4dc0-bd28-b43eee8664ea/checklist \
    --header 'x-api-key: <your-api-key>'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "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
          }
        }
      ]
    }
  ]
  ```
</ResponseExample>