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

1-based page number

perPage
integer | null

Rows per page

sortBy
string | null

Sort field

sortDirection
string | null

Sort direction: asc or desc

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
assigneeId
string | null

Filter by assignee provider ID

teamId
string | null

Filter by assigned team ID

patientId
string | null

Filter by linked patient ID

patientScope
enum<string> | null

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

Available options:
PATIENT_SPECIFIC,
OPS
creatorId
string | null

Filter by task creator ID

subscriberId
string | null

Filter by subscriber provider ID

locationIds
string[] | null

Filter to tasks at exactly these non-null locations

includeUnassigned
boolean
default:false

Include tasks with no location

callId
string | null

Filter by linked call ID

startDateFrom
string<date-time> | null

Filter tasks with start_date >= this value

startDateTo
string<date-time> | null

Filter tasks with start_date <= this value

dueDateFrom
string<date-time> | null

Filter tasks with due_date >= this value

dueDateTo
string<date-time> | null

Filter tasks with due_date <= this value

includeFuture
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