Skip to main content
GET
List Tasks

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
status
enum<string>[] | null

Filter by task status(es)

Available options:
OPEN,
IN_PROGRESS,
COMPLETED,
CANCELLED
priority
enum<string>[] | null

Filter by task priority(ies)

Available options:
URGENT,
HIGH,
NORMAL,
LOW
assignee_id
string | null

Filter by assignee provider ID

team_id
string | null

Filter by assigned team ID

patient_id
string | null

Filter by linked patient ID

patient_scope
enum<string> | null

Filter to patient-specific tasks (a patient is assigned) or ops tasks (no patient) Separates patient-specific work (a patient is assigned) from ops work (none).

Available options:
PATIENT_SPECIFIC,
OPS
creator_id
string | null

Filter by task creator ID

subscriber_id
string | null

Filter by subscriber provider ID

location_ids
string[] | null

Filter to tasks at these locations. Tasks with no location are always included.

call_id
string | null

Filter by call linked through an alert

start_date_from
string<date-time> | null

Filter tasks with start_date >= this value

start_date_to
string<date-time> | null

Filter tasks with start_date <= this value

due_date_from
string<date-time> | null

Filter tasks with due_date >= this value

due_date_to
string<date-time> | null

Filter tasks with due_date <= this value

include_future
boolean
default:false

Include tasks with start_date in the future

search
string | null

Search in task title and description

Response

Successful Response

data
TaskSummary · object[]
required
total
integer
required