---
title: "Get patient form"
method: GET
path: "/patient_forms/{id}"
tags: ["Patient Form"]
---

# Get patient form

`GET /patient_forms/{id}`

## Path parameters

- `id` string, int64, required

## Query parameters

- `q[]` string[]

## Response `200`

Successful operation

- PatientForm
  - `archived_at` string, date-time, nullable
  - `attendee` object
    - `links` object
      - `self` string, uri
  - `booking` object
    - `links` object
      - `self` string, uri
  - `business` object
    - `links` object
      - `self` string, uri
  - `completed_at` string, date-time, nullable
  - `content` object, nullable
    - `sections` object[]
      - `name` string, nullable
      - `description` string, nullable
      - `questions` union[]
        - union
          - PatientFormQuestionText
            - `answer` string
            - `name` string, required
            - `required` boolean
            - `type` 'text', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field' | 'emergency_contact' | 'medicare_number' | 'medicare_reference_number' | 'occupation'
          - PatientFormQuestionParagraph
            - `answer` string
            - `name` string, required
            - `required` boolean
            - `type` 'paragraph', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormQuestionAddress
            - `answer` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'address', nullable, required
            - `patient_field_connection` 'address', required
          - PatientFormQuestionDate
            - `answer` string, date
            - `name` string, required
            - `required` boolean
            - `type` 'date', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field' | 'date_of_birth'
          - PatientFormQuestionEmail
            - `answer` string
            - `name` string, required
            - `required` boolean
            - `type` 'email', nullable, required
            - `patient_field_connection` 'email', required
          - PatientFormQuestionPhone
            - `answer` object[]
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'phone', nullable, required
            - `patient_field_connection` 'phone', required
          - PatientFormQuestionPronouns
            - `answer` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'pronouns', nullable, required
            - `patient_field_connection` 'pronouns', required
          - PatientFormQuestionSignature
            - `signature_id` string, int64
            - `name` string, required
            - `required` boolean
            - `type` 'signature', nullable, required
            - `signature` string — A data URI representing an SVG image, with a maximum dimension of 500x500px.
          - PatientFormQuestionCheckboxes
            - `answers` object[]
              - …
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'checkboxes', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormQuestionRadiobuttons
            - `answers` object[]
              - …
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'radiobuttons', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormQuestionSelect
            - `answer` string
            - `options` string[], required
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'select', nullable, required
            - `patient_field_connection` 'gender_identity' | 'sex', required
          - PatientFormQuestionFullName
            - `answer` object
              - …
            - `options` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'full_name', nullable, required
            - `patient_field_connection` 'full_name', required
  - `created_at` string, date-time
  - `edited_at` string, date-time, nullable
  - `email_to_patient_on_completion` boolean, nullable
  - `expired` boolean, nullable
  - `expires_at` string, date-time, nullable
  - `id` string, int64
  - `links` object
    - `self` string, uri
  - `name` string
  - `patient` object
    - `links` object
      - `self` string, uri
  - `patient_form_template` object
    - `links` object
      - `self` string, uri
  - `restricted_to_practitioner` boolean, nullable
  - `signatures` object, nullable
    - `links` object
      - `self` string, uri
  - `updated_at` string, date-time
  - `url` string, uri, nullable

---

[API](https://skmtc.net/cliniko/apis/cliniko-api.md) · [All operations](https://skmtc.net/cliniko/apis/cliniko-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cliniko/cliniko-api/versions/c129a555ff44/schema)