Tasks

Create a task

Create an operational to-do on a project, optionally assigned to a crew member.

POST
/tasks

Create an operational to-do on a project, optionally assigned to a crew member.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/tasks" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"  }'
{  "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": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}

Sign up an agent-driven tenant POST

**Unauthenticated.** Creates a new **active** Free tenant and an active Admin and returns the tenant **API key immediately** (deferred verification) — the agent can start using FOREMAN right away, without waiting for the human to click an email. A "set your password / confirm your email" link is emailed to the human so they can later log into the browser dashboard, but it gates nothing programmatic. **Rate-limited per client IP** (the only unauthenticated write surface) — over the cap returns `429`. A duplicate email returns the same generic message with no key (so the surface can't probe for registered accounts).

Delete a task DELETE

Hard-deletes the task (tasks are operational, not audit-bearing).