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

# Show a list of patientFormPdfTemplates

`GET /patientFormPdfTemplates`

## Request

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

## Query parameters

- `name` string
- `fileUpload` string
- `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 patientFormPdfTemplates

- object
  - `response` PatientFormPdfTemplateResponse[], 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.
    - `name` string: name of the pdf form template
    - `fileUpload` string: ID of the uploaded source PDF this template's fields are positioned against
    - `pages` integer: number of pages in the source PDF
    - `fields` object[]: fields placed on the source PDF
      - `page` integer, required: 0-indexed page number within the source PDF this field is placed on
      - `type` 'text' | 'paragraph-text' | 'signature' | 'checkbox' | 'date' | 'number' | 'initials', required: type of the pdf form template field
      - `x` number, required: fraction (0-1) of the page width, measured from the left edge
      - `y` number, required: fraction (0-1) of the page height, measured from the top edge
      - `width` number, required: fraction (0-1) of the page width
      - `height` number, required: fraction (0-1) of the page height
      - `mappingField` string: when set, this field auto-fills from the matching PatientFormMappingFields concept instead of being filled in manually
      - `label` string: custom field label, used for manual fill when mappingField is not set
      - `placeholderText` string: patient-facing guidance text shown inside the field, distinct from the internal label
      - `required` boolean: whether the patient must fill this field in before submitting
      - `readOnly` boolean: whether this field is rendered read-only (auto-filled/informational, not editable by the patient) at fill-time
      - `defaultValue` string: default value pre-filled for this field, regardless of type
      - `minLength` integer: minimum number of characters accepted. Only meaningful for the text field types (text, paragraph-text)
      - `maxLength` integer: maximum number of characters accepted. Only meaningful for the text field types (text, paragraph-text)
      - `minValue` number: minimum numeric value accepted. Only meaningful when type is number
      - `maxValue` number: maximum numeric value accepted. Only meaningful when type is number
      - `dateRange` 'any' | 'future' | 'past': restricts which dates are accepted. Only meaningful when type is date
      - `textAlign` 'left' | 'center' | 'right': horizontal alignment of the text drawn into this field. Ignored by checkbox, which draws a mark rather than text. Treated as left when omitted
      - `fontSize` number: point size of the text drawn into this field. Ignored by checkbox; when omitted the renderer's own default size is used
      - `tags` string[]: free-form labels staff attach to a field for their own organization. Purely descriptive - never rendered in the fill UI or the produced PDF
  - `page` integer, required
  - `size` integer, required

## Other responses

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

## Changes

- **2026-10-17** `f19aeba84a26`: 2 warning, 7 info
  - added the new `initials` enum value to the `response/items/fields/items/type` response property for the response status `200`
  - added the new `paragraph-text` enum value to the `response/items/fields/items/type` response property for the response status `200`
  - added the optional property `response/items/fields/items/fontSize` to the response with the `200` status
  - added the optional property `response/items/fields/items/maxValue` to the response with the `200` status
  - …5 more
- **2026-08-23** `d3c75c2a2f1d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lumahealth/apis/rest-service/changes/patientFormPdfTemplates/get.md)

---

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