Resources
Tasks
Tasks track work to be done. They can be standalone or linked to a project, contact, or contractor, and assigned to one or more workspace users.
/v1/tasksCreate a task
Creates a new task. A task can link to a contact or a contractor, but not both. Assigning the task to a user sends them a notification email.
Body parameters
| Name | Type | Description |
|---|---|---|
| task_namerequired | string | Title of the task. Required. |
| description | string | Free-text description. |
| priority | enum | One of: Urgent, High, Medium, Low, Anytime. Defaults to Medium. |
| status | enum | One of: To Do, In Progress, In Review, Done, Blocked, Cancelled. Defaults to To Do. |
| due_date | string | YYYY-MM-DD date the task is due. |
| project_id | uuid | Link the task to an opportunity or project. |
| contact_id | uuid | Link the task to a contact. Mutually exclusive with contractor_id. |
| contractor_id | uuid | Link the task to a contractor. Mutually exclusive with contact_id. |
| assigned_to | uuid[] | Array of workspace user UUIDs to assign. Each will receive a notification email. |
| tags | string[] | Array of tag strings. |
Returns
HTTP 201 Created with the full task object.
/v1/tasksList tasks
Returns tasks in your workspace, most recently created first. Each row has the task name, status, priority, due date, linked project, contact or contractor (project_id, contact_id, account_id for a contractor) and assignees.
Query parameters
| Name | Type | Description |
|---|---|---|
| q | string | Free-text search across task_name. |
| limit | number | Max records to return. 1–100. Default 25. |
/v1/tasks/{id}Retrieve a task
Returns the full task object, or 404 when it is not in your workspace.
/v1/tasks/{id}Update or complete a task
Send only the fields you want to change. Set status to Doneto mark the task complete. The key's owner needs permission to edit tasks.
Body parameters
| Name | Type | Description |
|---|---|---|
| task_name | string | New title. Cannot be empty. |
| description | string | null | New description. Null clears it. |
| priority | enum | One of: Urgent, High, Medium, Low, Anytime. |
| status | enum | One of: To Do, In Progress, In Review, Done, Blocked, Cancelled. Done is the same as Mark Complete in the app. |
| due_date | string | null | YYYY-MM-DD. Null clears the due date. |
| assigned_to | uuid[] | Replaces the assignees. Newly added users receive a notification email. |
| tags | string[] | Replaces the tags. |
Returns
HTTP 200 OK with the updated task object.