Tasks

Update, reassign, or mark a task done

Edits a task and/or ticks it. A `done` boolean marks the task done/undone; `title`, `detail`, `projectId`, and `assigneeId` edit the task (reassign is just an `assigneeId` change). Field edits apply first, then the done flip, so one call can reassign and mark done together.

PATCH
/tasks/{id}

Edits a task and/or ticks it. A done boolean marks the task done/undone; title, detail, projectId, and assigneeId edit the task (reassign is just an assigneeId change). Field edits apply first, then the done flip, so one call can reassign and mark done together.

Authorization

x-api-key<token>

The per-tenant API key, copied from Settings → API & integrations. Sent as the x-api-key request header. The key is tenant-scoped and acts with Admin-equivalent, tenant-wide access.

In: header

Path Parameters

id*string

Resource id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields optional. done ticks/unticks the task; the other fields edit it (reassign by setting assigneeId). Both may be sent together.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "title": "string",  "detail": "string",  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",  "projectName": "string",  "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",  "assigneeName": "string",  "done": true,  "doneAt": "2019-08-24T14:15:22Z",  "doneBy": "string",  "createdAt": "2019-08-24T14:15:22Z"}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "read_only",    "message": "Your subscription is inactive. This action is read-only."  }}
{  "error": {    "code": "not_found",    "message": "Not found."  }}
{  "error": {    "code": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}

List tasks GET

Lists the tenant's tasks, paginated, with optional filters.

Create a user POST

Creates a tenant user (Admin or Site Crew) with an initial password and at least one project assignment, and returns the created user plus the credentials to share with them (there is no credentials email in v1). The email must be unique among active users in the tenant.