---
title: "Get checklist template by id"
method: GET
path: "/checklistTemplates/{checklistTemplateId}"
tags: ["checklistTemplates"]
---

# Get checklist template by id

`GET /checklistTemplates/{checklistTemplateId}`

## Path parameters

- `checklistTemplateId` string, required

## Response `200`

ChecklistTemplate

- ChecklistTemplateResponse — A ChecklistTemplate is the reusable, staff-configured blueprint defining required pre-visit tasks, their category and expiration rules, and the conditions under which they apply (such as a specific appointment type, facility, or provider). Checklists are built from a template, but the resulting checklist is a snapshot copy; changes to the template require an explicit recreation job to resync already-created checklists.
  - `_id` string — Luma's internal ID of an object.
  - `user` string — The ID of the root account user.
  - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
  - `createdBy` string — The ID of the user who created this object.
  - `updatedBy` string — The ID of the user who updated this object.
  - `createdAt` string, date-time — The date/time when this object was created.
  - `updatedAt` string, date-time — The date/time when this object was updated.
  - `name` string — Name of the checklist template.
  - `enabled` boolean — Whether this template is active and usable to build new checklists.
  - `type` 'appointment' — The kind of template.
  - `tag` string — Merge-tag identifier for this template, auto-generated if not provided.
  - `items` object[] — The tasks generated checklists will include.
    - `name` object — Localized name of this item, keyed by language code.
    - `ref` 'patient-form-template' — Type of resource this item's `refId` points to.
    - `refId` string — ID of the PatientFormTemplate that fulfills this item.
    - `category` 'intake' | 'demographics' | 'consent' | 'insurance' | 'payment' — The category this item belongs to. Kept in sync with the linked PatientFormTemplate's category.
    - `expiration` object — When items generated from this template item expire. Either `value`+`unit`, or `cron`, but not both.
      - `value` integer
      - `unit` 'days' | 'weeks' | 'months' | 'years'
      - `cron` string
    - `filters` ChecklistTemplateFilter[] — Item-level conditions controlling when this item is included.
      - `path` string — The field path being compared, for example a facility, provider, or appointment type identifier.
      - `value` string — The value to compare the field at `path` against.
      - `comparision` 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'ne' | 'regex' | 'js' — How `path` and `value` are compared.
      - `options` string — Additional options for the comparison, such as regex flags.
    - `defaultStatus` 'not-ready' | 'pending' | 'in-progress' | 'skipped' | 'completed' — Default status assigned to items generated from this template item.
  - `filters` ChecklistTemplateFilter[] — Template-level conditions controlling when this template applies, such as specific appointment types, facilities, or providers.
    - `path` string — The field path being compared, for example a facility, provider, or appointment type identifier.
    - `value` string — The value to compare the field at `path` against.
    - `comparision` 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'ne' | 'regex' | 'js' — How `path` and `value` are compared.
    - `options` string — Additional options for the comparison, such as regex flags.
  - `checklistTemplateFilter` object
    - `path` string — The field path being compared, for example a facility, provider, or appointment type identifier.
    - `value` string — The value to compare the field at `path` against.
    - `comparision` 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'ne' | 'regex' | 'js' — How `path` and `value` are compared.
    - `options` string — Additional options for the comparison, such as regex flags.

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope

---

[API](https://skmtc.net/lumahealth/apis/rest-service.md) · [All operations](https://skmtc.net/lumahealth/apis/rest-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lumahealth/rest-service/revisions/d3c75c2a2f1d/schema)