List Tasks

get

https://patient-api.portals.care/tasks

Retrieve tasks related to the patient or CRM workflows.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

To retrieve a list of tasks for the patient, you can use this endpoint with a GET request. You will need to authenticate by providing the user's JWT in the Authorization header. Optionally, provide the unique organization ID in the request header. You can also use a variety of optional query parameters to filter the list, such as by type or status.

Query Params

showClosed

string

enum

Defaults to false

A boolean flag to indicate whether to include closed tasks in the response. By default, only open tasks are returned.

Allowed:

type

string

Filters tasks by a specific type.

owner

string

Filters tasks by the assigned owner.

status

string

Filters tasks by their current status.

description

string

Filters tasks by a keyword in their description.

tags

string

Filters tasks by a specific tag. Multiple tags can be provided as a comma-separated list.

createdAt

date-time

Filters tasks by their creation date. The value should be an ISO 8601 formatted date string to specify a date range (e.g., 2025-01-01T00:00:00Z).

updatedAt

date-time

Filters tasks by their last update date. The value should be an ISO 8601 formatted date string.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200