Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Patient Form

Get patient form

get/patient_forms/{id}

Path parameters

idstring int64 required

Query parameters

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

ValueFormat
archived_atdate-time

Response

Successful operation

archived_atstring date-time nullable
completed_atstring date-time nullable
created_atstring date-time
edited_atstring date-time nullable
email_to_patient_on_completionboolean nullable
expiredboolean nullable
expires_atstring date-time nullable
idstring int64
namestring
restricted_to_practitionerboolean nullable
updated_atstring date-time
urlstring uri nullable

Example response

{
  "attendee": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees/1"
    }
  },
  "booking": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/bookings/1"
    }
  },
  "business": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/businesses/1"
    }
  },
  "content": {
    "sections": [
      {
        "questions": [
          {
            "custom_field_token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patient_forms/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "patient_form_template": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
    }
  },
  "signatures": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_forms/1/signatures/112233"
    }
  }
}