tasks

List tasks in a clinic

Lists tasks with pagination and optional filters. Tasks linked to a client are only returned when the integration is authorized to read that client; unauthorized tasks are excluded from both the results and meta.totalCount.

title and description are unstructured clinical free text and may contain PHI.

get/tasks

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/tasks
  • Auth: none declared

Query parameters

assigneeIdsstring[]

Filter by one or more assignee user IDs.

creatorIdsstring[]

Filter by one or more creator user IDs.

patientIdsstring[]

Filter by one or more linked client IDs.

statusesTaskStatus[]

Filter by one or more task statuses.

prioritiesTaskPriority[]

Filter by one or more task priorities.

dueStartDatestring date
Example:2024-01-01

Only return tasks due on or after this date. Tasks with no due date are excluded when either due date filter is set.

dueEndDatestring date
Example:2024-01-31

Only return tasks due on or before this date.

createdStartTimestring date-time
Example:2024-01-01T00:00:00Z

Only return tasks created at or after this ISO 8601 timestamp.

createdEndTimestring date-time
Example:2024-01-31T23:59:59Z

Only return tasks created at or before this ISO 8601 timestamp.

sort'activity_newest' | 'activity_oldest' | 'created_newest' | 'created_oldest' | 'due_latest' | 'due_earliest' | 'priority_highest' | 'priority_lowest' | 'client_az' | 'client_za'

How to order the results. Defaults to newest created first.

limitinteger

How many tasks to return at one time (max 20).

offsetinteger

How many tasks to skip before returning results. Use for pagination.

Response

success

Example response

{
  "meta": {
    "count": 1,
    "totalCount": 10
  },
  "tasks": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "title": "Call the pharmacy",
      "description": "Confirm the refill went through.",
      "assigneeId": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
      "dueDate": "2024-01-31",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-02T00:00:00Z",
      "statusUpdatedAt": "2024-01-02T00:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.