---
title: "Show a list of patientFormTemplates"
method: GET
path: "/patientFormTemplates"
tags: ["patientFormTemplates"]
---

# Show a list of patientFormTemplates

`GET /patientFormTemplates`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/patientFormTemplates`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/patientFormTemplates/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `source` 'system' | 'user'
- `externalId` string
- `description` string
- `type` 'pre-qualification' | 'intake' | 'feedback' | 'ccda'
- `active` boolean
- `url` string
- `tag` string
- `integratorMapping` string
- `calculation` string
- `finalDispositionCalculation` string
- `schedulerRequestInterceptor` string
- `schedulerResponseInterceptor` string
- `htmlPdfTemplateHeader` string
- `htmlPdfTemplateBody` string
- `htmlPdfTemplateFooter` string
- `lumabot` string
- `sendToDirectMessageEmail` string
- `lumaBotFlow` 'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback'
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

Returns a list of patientFormTemplates

- object
  - `response` PatientFormTemplateResponse[], required
    - `_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 patient form template
    - `externalId` object: externalId of the patient form template
      - `source` 'docusign' | 'hellosign' | 'surveymonkey' | 'luma'
      - `id` string
    - `title` string: title of the patient form template
    - `description` string: description of the patient form template
    - `insurance` object: insurance of the patient form template
      - `enabled` boolean
      - `id` string
    - `reminder` object: reminder of the patient form template
      - `enabled` boolean
      - `id` string
    - `type` 'pre-qualification' | 'intake' | 'feedback' | 'ccda': type of the patient form template
    - `active` boolean: describes if the patient form template is active
    - `url` string: url of the patient form template
    - `tag` string: tag of the patient form template which is used to build the squiggly
    - `template` object: template of the patient form template
      - `version` string
      - `welcomeScreens` object[]
        - `id` string
        - `template` string
        - `title` string
        - `properties` object
          - `template` string
          - `actionLabel` string
      - `items` object[]
        - `id` string
        - `type` string
        - `squiggly` string
        - `title` string
        - `redirectType` string
        - `validations` object
          - `required` boolean
        - `properties` object
          - `addToAppointment` boolean
          - `showCustomAction` boolean
          - `includeNoneOfAboveChoice` boolean
          - `allowOtherChoice` boolean
          - `scoringEnabled` boolean
          - `visibility` string
          - `allowMultipleSelection` boolean
          - `showDescription` boolean
          - `answers` object
            - `id` string
            - `redirectType` string
    - `integratorMapping` string: integratorMapping of the patient form template
    - `calculation` string: calculation of the patient form template
    - `finalDispositionCalculation` string: finalDispositionCalculation of the patient form template
    - `schedulerRequestInterceptor` string: schedulerRequestInterceptor of the patient form template
    - `schedulerResponseInterceptor` string: schedulerResponseInterceptor of the patient form template
    - `htmlPdfTemplateHeader` string: htmlPdfTemplateHeader of the patient form template
    - `htmlPdfTemplateBody` string: htmlPdfTemplateBody of the patient form template
    - `htmlPdfTemplateFooter` string: htmlPdfTemplateFooter of the patient form template
    - `lumabot` boolean: lumabot of the patient form template
    - `sendToDirectMessageEmail` boolean: sendToDirectMessageEmail of the patient form template
    - `lumaBotFlow` 'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback': lumaBotFlow of the patient form template
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope
- `default`: unexpected error

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)