curl --request GET \
  --url https://api.splose.com/v1/patient-forms \
  --header 'Authorization: Bearer <token>'
{
  "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",
      "submittedAt": "1990:01:01 12:20:52",
      "patientId": 1,
      "organisationId": 1,
      "appointmentId": 1,
      "status": "Completed",
      "templateId": 1,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
id_gt
integer | null

The starting object id of the next page

Example:

200

​
id_lt
integer | null

The starting object id of the previous page

Example:

100

​
update_gt

Search for objects updated after this date time

Example:

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

​
update_lt

Search for objects updated before this date time

Example:

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

​
include_archived
enum<string> | null
default:false

Whether archived objects should be retrieved, default is false

Available options:
true,
false
​
patientId
number | null

Patient id

Example:

1

​
templateId
number | null

Template id

Example:

1

Response

200 - application/json
A paged array of patient-forms
​
data
object[]
required
​
links
object
required
Get a single screenerGet a single patient-form