Skip to main content
Get a single patient-form
curl --request GET \
  --url https://api.splose.com/v1/patient-forms/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "submittedAt": "1990:01:01 12:20:52",
  "patientId": 1,
  "organisationId": 1,
  "appointmentId": 1,
  "templateId": 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",
  "status": "Completed",
  "archived": false,
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required
Required range: x > 0
Example:

1

Response

200 - application/json

Object with patient-form data.

​
id
integer
required

Patient Form Id

Required range: x > 0
Example:

1

​
submittedAt
required

Submitted time in YYYY:MM:DD HH:mm:ss format

Example:

"1990:01:01 12:20:52"

​
patientId
integer
required

Patient id

Required range: x > 0
Example:

1

​
organisationId
integer
required

Organisation id

Required range: x > 0
Example:

1

​
appointmentId
integer | null
required

Appointment id

Required range: x > 0
Example:

1

​
templateId
integer | null
required

Template id

Required range: x > 0
Example:

1

​
title
string

Form Title

Example:

"Form Title"

​
uuid
string<uuid>

uuid

Example:

"e2753e11-22a2-4886-be76-df5113632f0d"

​
brandingColor
string | null

Branding color

Example:

"blue"

​
headerImage
string | null

Link of the image

Example:

"https://sampleImage.com"

​
content
string

Content of form

Example:

"[{\"title\":\"Section title\",\"questions\":[{\"type\":\"Paragraph\",\"title\":\"Paragraph title\",\"answerText\":\"\"}]}]}]"

​
submittedMessage
string | null

Submitted message

Example:

"Message"

​
status
enum<string>

Status

Available options:
Incomplete,
In progress,
Completed
Example:

"Completed"

​
archived
boolean | null
default:false

Whether the patient form has been archived

​
createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

​
updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"