---
title: "Get lumabotFlowTemplate by id"
method: GET
path: "/lumabotFlowTemplates/{lumabotFlowTemplateId}"
tags: ["lumabotFlowTemplates"]
---

# Get lumabotFlowTemplate by id

`GET /lumabotFlowTemplates/{lumabotFlowTemplateId}`

## Path parameters

- `lumabotFlowTemplateId` string, required

## Response `200`

LumabotFlowTemplate

- LumabotFlowTemplateResponse — A Lumabot flow template is a reusable definition for a conversational chatbot flow made up of ordered question and answer items such as text, dropdown, scheduler, or medication search steps. Templates can be system provided or created by a user and are cloned or referenced to build actual Lumabot flows shown to patients, supporting features like scoring, staff notifications, scheduler request and response interception, and mapping collected answers into a format that EHR or scheduling integrators can consume. This response schema returns the stored template record including its ownership, audit fields such as createdBy and updatedBy, and its active status, in addition to the template body itself.
  - `_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.
  - `source` 'system' | 'user' — source of the lumabot flow template
  - `title` string — title of the lumabot flow template
  - `description` string — description of the lumabot flow template
  - `active` boolean — describes if the lumabot flow template is active
  - `url` string — url of the lumabot flow template
  - `tag` string — tag of the lumabot flow template which is used to build the squiggly
  - `template` object — template of the lumabot flow template
    - `items` object[]
      - `id` string
      - `type` '2FA' | 'address' | 'availability_details' | 'date' | 'dropdown' | 'email' | 'jump' | 'manage_appointment' | 'medication_search' | 'multiple_choice' | 'pharmacy_search' | 'phone_number' | 'scheduler' | 'ssn' | 'template_welcome' | 'template' | 'text' | 'yes_no' | 'zipcode'
      - `squiggly` string
      - `title` string
      - `redirectType` 'none' | 'goTo' | 'goToFlow' | 'goToPrevious' | 'isFinal' | 'externalUrl' | 'scheduler'
      - `redirectValue` string
      - `validations` object
        - `required` boolean
      - `properties` object
        - `template` string
        - `visibility` string
        - `notifyStaff` boolean — notify staff when a question is answered
        - `sendToHub` boolean — send the answers to hub when a question is answered
        - `scoringEnabled` boolean
        - `params` object
        - `answers` object
          - `id` string
          - `redirectType` 'none' | 'goTo' | 'goToFlow' | 'goToPrevious' | 'isFinal' | 'externalUrl' | 'scheduler'
          - `redirectValue` string
          - `label` string
          - `score` number
          - `locales` object — A map-object whose keys may be any of these language codes `es` or `pt`
            - `es` object
              - …
            - `pt` object
              - …
          - `disable` boolean
          - `properties` object
            - `params` object
  - `schedulerRequestInterceptor` string — schedulerRequestInterceptor of the lumabot flow template
  - `schedulerResponseInterceptor` string — schedulerResponseInterceptor of the lumabot flow template
  - `flowType` 'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback' | 'error' | 'no-availabilities' | 'regular' — type of the lumabot flow template
  - `facilities` string[] — list of facility ids the flow template is associated with

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