Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
patient-form

Get a paged array of patient-forms

Get a paged array of patient-forms

get/patient-forms

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

patientIdnumber nullable

Patient id

Example:1
templateIdnumber nullable

Template id

Example:1

Response

A paged array of patient-forms

Example response

{
  "data": [
    {
      "id": 1,
      "title": "Form Title",
      "uuid": "e2753e11-22a2-4886-be76-df5113632f0d",
      "brandingColor": "blue",
      "headerImage": "https://sampleImage.com",
      "content": "[{\"title\":\"Section title\",\"questions\":[{\"type\":\"Paragraph\",\"title\":\"Paragraph title\",\"answerText\":\"\"}]}]}]",
      "submittedMessage": "Message",
      "patientId": 1,
      "organisationId": 1,
      "appointmentId": 1,
      "status": "Completed",
      "templateId": 1
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}