---
title: "Get a paged array of patient-forms"
method: GET
path: "/patient-forms"
tags: ["patient-form"]
---

# Get a paged array of patient-forms

`GET /patient-forms`

Get a paged array of patient-forms

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `patientId` number, nullable — Patient id
- `templateId` number, nullable — Template id

## Response `200`

A paged array of patient-forms

- object
  - `data` object[], required
    - `id` integer, required — Patient Form Id
    - `title` string — Form Title
    - `uuid` string, uuid — uuid
    - `brandingColor` string, nullable — Branding color
    - `headerImage` string, nullable — Link of the image
    - `content` string — Content of form
    - `submittedMessage` string, nullable — Submitted message
    - `submittedAt` union, required — Submitted time in YYYY:MM:DD HH:mm:ss format
      - string
      - string
      - unknown
    - `patientId` integer, required — Patient id
    - `organisationId` integer, required — Organisation id
    - `appointmentId` integer, nullable, required — Appointment id
    - `status` 'Incomplete' | 'In progress' | 'Completed' — Status
    - `templateId` integer, nullable, required — Template id
    - `archived` boolean, nullable — Whether the patient form has been archived
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

[API](https://skmtc.dev/splose/apis/splose-public-api.md) · [All operations](https://skmtc.dev/splose/apis/splose-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/splose/splose-public-api/revisions/648d60075f00/schema)