Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
screener

Get a paged array of screeners

Get a paged array of screeners

get/screeners

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

string
OR
string
OR
{"stackTrail":"paths:/screeners:get:parameters:5:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}
string
OR
string
OR
{"stackTrail":"paths:/screeners:get:parameters:6:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}
isAccepted'true' | 'false' nullable

Is the screener accepted or rejected

Example:true
isTriaging'true' | 'false' nullable

Is the screener item active or closed

Example:true
formIdsnumber[] nullable
screenerTagsstring[] nullable

Response

A paged array of screeners

Example response

{
  "data": [
    {
      "id": 1,
      "patientId": 14,
      "triaging": true,
      "formId": 1,
      "screenerTags": [
        "High",
        "Medium",
        "Low"
      ]
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}