Skip to main content
GET
List tasks

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

source
string

Filter by who raised the task (comma-separated). Values: ai_check, manual, ehr. Omit to receive all of them. ehr tasks are mirrored from the connected EHR by an inbound sweep, so a practice's first sweep can publish thousands at once, and they carry the MIRROR time in createdAt (see ehrCreatedAt for the EHR's own) — which puts them at the head of the default createdAt DESC page. If you page a fixed number of pages and prune local rows you did not see, pin this to ai_check,manual rather than letting a sweep push your own tasks off the end. Supplying the parameter with NO values — ?source= or ?source=, — is a 400, not an empty filter.

Example:

"ai_check,manual"

status
string

Filter by task status (comma-separated)

Example:

"not_started,in_progress"

noteId
string

Filter by note ID (UUID)

Example:

"3cc73cb6-9c59-403c-a910-8af6c5693b25"

providerId
string

Filter by assigned provider ID (UUID)

Example:

"d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a"

patientId
string

Filter by patient ID (UUID). Matches tasks anchored to one of that patient's VISITS, and tasks anchored to the patient directly — the anchor ehr tasks usually carry. NOT exhaustive: a task anchored to a bill, claim or appointment also belongs to a patient and is NOT returned here, while it does appear in the unfiltered list. So this filter narrows, it does not enumerate a patient's tasks.

Example:

"8de03039-3a9e-417a-b2b3-a8b8df183631"

dateFrom
string

Filter tasks created on or after this date (ISO 8601)

Example:

"2025-01-01"

dateTo
string

Filter tasks created on or before this date (ISO 8601)

Example:

"2025-12-31"

sortBy
enum<string>

Sort field

Available options:
createdAt,
updatedAt,
status
Example:

"createdAt"

sortOrder
enum<string>

Sort direction

Available options:
asc,
desc
Example:

"desc"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required