API Reference

Tasks

Tasks are units of work with assignees, statuses, deadlines, and optional project links. Partner responses expose UUIDs; numeric foreign keys on the task root are stripped.

Last updated 2026-06-21

The Tasks API provides full CRUD for tasks in a workspace. Create tasks with a required `type`, assign them to people, link them to projects, and filter list results with rich query parameters.

Updates use PATCH (not PUT). The partner endpoint is JSON-only — multipart attachments are not supported. Default list visibility includes `firm-team` and `team-only` tasks; pass `visibility=firm-only` to include firm-only rows such as system-generated INTERNAL_TASK records.

Key concepts

Required type on create

Every create request must include `type` — the task type identifier for your workspace (for example INTERNAL_TASK).

UUID-resolvable foreign keys

Optional FK fields (`assigneeId`, `statusId`, `projectId`, and others) accept either a UUID or a workspace-scoped numeric id. Prefer UUIDs from list responses.

Visibility

List defaults to firm-team and team-only tasks. Retrieve firm-only tasks by passing `visibility=firm-only` on get and list when needed.

The task object

Core fields returned on task records. Nested assignee, status, and project objects expose UUIDs.

Attributes

iduuid

Task identifier (UUID).

namestring

Task title.

typestring

Task type identifier. Required on create.

descriptionstring

Task details.

prioritystring

Priority level (for example low, medium, high).

deadlinedate

Due date (YYYY-MM-DD).

customIdstring

Optional external reference id.

visibilityenum

Visibility scope. INTERNAL_TASK rows are always created as firm-only.

One of: firm-team, team-only, firm-only

assigneeobject

Assigned workspace user, or null.

projectobject

Linked project, or null.

tagsarray

Tags attached to the task.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example

{
  "id": "22334455-6677-8899-aabb-ccddeeff0011",
  "name": "Review wireframes",
  "type": "INTERNAL_TASK",
  "description": "Review and approve wireframes before development.",
  "priority": "medium",
  "deadline": "2026-04-15",
  "customId": "TASK-1042",
  "visibility": "firm-team",
  "assignee": {
    "uuid": "f1a2b3c4-d5e6-4789-a012-3456789abcde",
    "firstName": "Jane",
    "lastName": "Smith"
  },
  "project": {
    "uuid": "11223344-5566-7788-99aa-bbccddeeff00",
    "name": "Website Redesign"
  },
  "tags": [],
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-28T14:22:30.000Z"
}

Legacy filters stripped

The list filters `clients`, `openTaskOnly`, and `isForClosing` are always removed server-side on partner routes.

Recent changes

2026-06-21

Complete Partner API reference

Documented all remaining API reference groups: Chart of Accounts, Vendors, Products & Services, Recurring Invoice Templates, Credit Memos, Bills, Journal Entries, Tags, People, Projects, Tasks, Time Entries, Expense Receipts, Reports, and Workspace Stats. Added missing invoice endpoints (audit log, attachments, credit application, remove transaction) and group overviews for Invoices and Transactions.