
## `GET /tasks`

Purpose:

- return a paginated list of tasks

Notes:

- resolves image and file URLs in the returned task data

## `POST /task/`

Purpose:

- create a task through the SDK-facing integration flow

Important behavior:

- adapts IDs into enum or database-backed objects where needed
- triggers notifications and task-related side effects

## `PATCH /task/{id}`

Purpose:

- update an existing task

Important behavior:

- supports status, priority, and site-related conversions
- may trigger notification hooks or downstream side effects

## Integration guidance

- treat task endpoints as command-style APIs
- document which system or workflow owns the task updates
- test enum and ID mappings carefully when integrating from external systems


Reference the task query, create, and update endpoints used by SDK-driven task workflows.

Tasks API


## `POST /task/`

Use this endpoint to create a task in Zira from an external integration flow.

## Authentication

```http
x-api-key: <your-api-key>
Content-Type: application/json
```

See [API Authentication](/developers/api-reference/api-authentication) for how to create a key.

## Request body

Send the task fields needed to create a task in the integration context.

```json
{
  "name": "Replace inlet filter on Line 1",
  "siteId": "1512",
  "typeId": "1",
  "priorityId": "10",
  "statusId": "5",
  "toChannelId": "45187",
  "description": "Differential pressure above threshold for two shifts."
}
```

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | Task name. |
| `siteId` | string | yes | Site the task belongs to. |
| `typeId` | string | yes | Task type. `"1"` for a manual task, `"3"` for a task about a data source. Send it explicitly — leaving it out makes the request fail asking for `deviceId`. |
| `deviceId` | string | no | Data source the task is about. Required when `typeId` is `"3"`, and not allowed when `typeId` is `"1"`. |
| `priorityId` | string | no | Priority — `5` Low, `10` Medium, `15` High. An unrecognised value is silently ignored. |
| `statusId` | string | no | Status. Defaults to `"5"` (To Do). Omit the key rather than sending `null`. |
| `description` | string | no | Plain-text task description. |
| `dueDate` | string | no | When the task is due. |
| `assigneeId` | string | no | User to assign the task to. |
| `toChannelId` | string | no | Channel the task’s feed post is created in. |
| `fileIds` | string[] | no | Files to attach to the task. |
| `formattedDescription` | object[] | no | Rich-text description as an array of nodes. A plain HTML string is rejected — use `description` for plain text. |
| `timeSpentMandatory` | boolean | no | Require time to be logged before the task can be completed. |
| `noInitialComment` | boolean | no | Set true to skip the automatic opening comment. Omit it rather than sending false. |

## Response

`200 OK`

Returns the new task’s ID as a bare number under `data`. The created task is not echoed back — call `GET /tasks` if you need the full record.

```json
{
  "data": 9901
}
```

| Field | Type | Description |
| --- | --- | --- |
| `data` | number | ID of the newly created task. It comes back as a number, while `GET /tasks` returns task IDs as strings — convert before comparing. |

### Good to know

- Send `typeId` explicitly. Leave it out and the request fails asking for `deviceId`; send `typeId: "1"` and `deviceId` must be omitted; send `typeId: "3"` and `deviceId` is required.
- Creating a task also creates a feed post for it in the target channel and adds an opening comment. Send `noInitialComment: true` to skip the comment.
- Assignees and followers are always notified — there is no way to create a task silently.
- The body is strict: any field not listed above is rejected with `400`. That includes `imageIds`, `mentions`, `hashtags` and `ctas`, which belong to posts rather than tasks.
- All IDs must be quoted strings. `siteId: 15` as a number is a `400`; so are `"0"` and `""`.
- `statusId` defaults to `"5"` (To Do) and `typeId` to `"1"`. Sending an explicit `null` for either is rejected — omit the key instead.
- An ID that does not exist — an unknown priority, status or site — is accepted and then quietly ignored, so the task is created without that field set. Check your IDs.
- Do not add a query string to this request; it interferes with body validation and produces a misleading `400`.

## Errors

Failures return a JSON body with a `message` and an `internalErrorCode`, at the status shown below. Whenever the underlying error carries structured detail — which every schema-validation failure does — the body is replaced with a generic `Internal server error.` / `02-001` pair while the real status code is kept. Branch on the HTTP status and on `internalErrorCode`; never parse the message text.

```json
{
  "message": "Internal server error.",
  "internalErrorCode": "02-001"
}
```

| Status | Meaning |
| --- | --- |
| `400` | The request failed validation — a missing required field, a field the schema does not allow, an unparseable body, a value out of range, or a malformed `lastValue`. |
| `401` | The API key resolved to a user context that is not allowed to read or write the record you asked for. |
| `403` | The `x-api-key` header is missing or is not a recognised key. API Gateway rejects the call before the endpoint runs, so the body is only `{"message":"Forbidden"}`. |
| `409` | The write conflicts with an existing record, or it references a record that does not exist. |
| `429` | The API key exceeded the rate limit or quota on its usage plan. Also returned by API Gateway rather than the endpoint. |
| `500` | Unexpected server error, or the database returned no result where one was required. |


Add Task


## `GET /tasks`

Use this endpoint to browse or sync tasks. Results are paged with a cursor, and you can narrow them by site, status, priority, assignee or type.

## Authentication

```http
x-api-key: <your-api-key>
```

See [API Authentication](/developers/api-reference/api-authentication) for how to create a key.

## Query parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | number | no | Page size. Always send it, so that a missing `lastValue` reliably means you have reached the end. |
| `lastValue` | string | no | Cursor for the next page. Pass the `lastValue` from the previous response back verbatim. |
| `textSearch` | string | no | Free-text search over task names. Keep sending the same `textSearch` while paging through its results. |
| `sortDesc` | boolean | no | Reverse the sort order. |
| `siteIds` | string | no | Comma-separated site IDs to filter by, e.g. `1512,1513`. |
| `statusIds` | string | no | Comma-separated status IDs to filter by, e.g. `5,15`. |
| `priorityIds` | string | no | Comma-separated priority IDs to filter by — `5` Low, `10` Medium, `15` High. |
| `assigneeIds` | string | no | Comma-separated user IDs to filter by assignee. |
| `typeIds` | string | no | Comma-separated task type IDs to filter by. |

## Response

`200 OK`

Returns a page of task objects in `data`, with an opaque `lastValue` cursor beside it. Each task carries its status, site, priority and assignee as small `{ id, name }` objects, and the assignee is expanded with their name, email and avatar URLs.

```json
{
  "data": [
    {
      "id": "9901",
      "name": "Replace inlet filter on Line 1",
      "description": "Differential pressure above threshold for two shifts.",
      "dueDate": "2026-01-20",
      "doneDate": null,
      "progressDate": null,
      "timeSpent": "@ 0",
      "formatedTimeSpent": "0h:0m",
      "timeToRespond": null,
      "timeToResolve": null,
      "timeToDueDate": "6d:0h:0m",
      "assignee": {
        "id": "318",
        "firstName": "Alex",
        "lastName": "Rivera",
        "name": "Alex Rivera",
        "image": {
          "id": "20514",
          "url": "https://prod-images-zira.s3.us-west-2.amazonaws.com/<hash>?X-Amz-Expires=604800&X-Amz-Signature=<signature>&x-id=GetObject",
          "thumbnailUrl": "https://prod-images-zira.s3.us-west-2.amazonaws.com/<hash>_thumbnail?X-Amz-Expires=604800&X-Amz-Signature=<signature>&x-id=GetObject"
        },
        "channelId": "3024",
        "username": "alex.rivera@example.com",
        "email": "alex.rivera@example.com"
      },
      "status": {
        "id": "5",
        "name": "To Do"
      },
      "site": {
        "id": "1512",
        "name": "Fresno Plant",
        "channelId": "45187"
      },
      "system": null,
      "device": null,
      "priority": {
        "id": "10",
        "name": "Medium"
      },
      "type": {
        "id": "1",
        "name": "Manual"
      },
      "auditInfo": {
        "createdBy": {
          "id": "318"
        },
        "createdDate": "2026-01-14T09:15:00.000000Z",
        "lastModifiedBy": {
          "id": "318"
        },
        "lastModifiedDate": "2026-01-14T09:15:00.000000Z"
      },
      "timeSpentMandatory": false,
      "resolution": null,
      "resolutionDescription": null,
      "cost": null,
      "estimatedTime": null,
      "postId": 240873,
      "hashtags": null
    }
  ],
  "lastValue": "eyJhdWRpdEluZm8uY3JlYXRlZERhdGUiOiIyMDI2LTAxLTE0VDA5OjE1OjAwWiIsImlkIjoiOTkwMSJ9"
}
```

| Field | Type | Description |
| --- | --- | --- |
| `data` | array (nullable) | A page of tasks. `null` — not an empty array — when nothing matched. |
| `data[].id` | string | Task ID, as a string. |
| `data[].name` | string | Task title. |
| `data[].description` | string (nullable) | Plain-text description. |
| `data[].dueDate` | string (nullable) | Due date, as `YYYY-MM-DD`. |
| `data[].doneDate` | string (nullable) | When the task was completed. `null` while it is still open. |
| `data[].timeSpent` | string | Raw accumulated time. `formatedTimeSpent` is the display form, e.g. `2h:15m`. |
| `data[].timeToResolve` | string (nullable) | How long the task took to close, e.g. `19d:8h:27m`. `null` until it is done. |
| `data[].assignee` | object (nullable) | The assigned user, expanded with `name`, `email`, `channelId` and an `image` holding ready-to-use `url` and `thumbnailUrl`. |
| `data[].status` | object | `{ id, name }`, e.g. `To Do`, `On Hold`, `Done`. |
| `data[].site` | object | `{ id, name, channelId }` for the site that owns the task. |
| `data[].priority` | object (nullable) | `{ id, name }` — `5` Low, `10` Medium, `15` High. |
| `data[].type` | object | `{ id, name }` — `1` Manual, `3` for a task tied to a data source. |
| `data[].device` | object (nullable) | The data source the task is about, when it has one. |
| `data[].auditInfo` | object | `createdBy`, `createdDate`, `lastModifiedBy`, `lastModifiedDate`. |
| `data[].postId` | number | ID of the feed post Zira created for this task. A number, while `id` is a string. |
| `lastValue` | string | Opaque cursor for the next page. Pass it back as `?lastValue=…`. |

### Good to know

- Tasks carry a long tail of optional fields that are `null` on most installations — `taskType2`, `department`, `workCenter`, `attr1`–`attr3`, `assignee2`–`assignee4`, `category`, `application`. They are omitted from the example above but do appear in the payload.
- New fields get added to tasks over time, so parse defensively rather than rejecting unknown keys.
- IDs are strings, except `postId`, which is a number. Convert before comparing.
- Image and file URLs are pre-signed and time-limited — fetch them soon after reading, and re-request the task rather than storing them.
- Do not treat the presence of `lastValue` as proof that more data exists. Keep paging until `data` comes back `null`, or until you receive fewer rows than the `limit` you asked for.
- An empty page is `{"data": null}`, not `{"data": []}`.

## Errors

Failures return a JSON body with a `message` and an `internalErrorCode`, at the status shown below. Whenever the underlying error carries structured detail — which every schema-validation failure does — the body is replaced with a generic `Internal server error.` / `02-001` pair while the real status code is kept. Branch on the HTTP status and on `internalErrorCode`; never parse the message text.

```json
{
  "message": "Internal server error.",
  "internalErrorCode": "02-001"
}
```

| Status | Meaning |
| --- | --- |
| `400` | The request failed validation — a missing required field, a field the schema does not allow, an unparseable body, a value out of range, or a malformed `lastValue`. |
| `401` | The API key resolved to a user context that is not allowed to read or write the record you asked for. |
| `403` | The `x-api-key` header is missing or is not a recognised key. API Gateway rejects the call before the endpoint runs, so the body is only `{"message":"Forbidden"}`. |
| `409` | The write conflicts with an existing record, or it references a record that does not exist. |
| `429` | The API key exceeded the rate limit or quota on its usage plan. Also returned by API Gateway rather than the endpoint. |
| `500` | Unexpected server error, or the database returned no result where one was required. |


List tasks the API key can see, a page at a time.

Tasks API

.css-z7wgtv{padding-left:6px;padding-right:6px;padding-top:2.8px;padding-bottom:2.8px;border-radius:4px;font-size:0.875em;font-family:ui-monospace,SFMono-Regular,SFMono-Regular,Consolas,monospace;background-color:rgba(0, 0, 0, 0.04);border:1px solid;border-color:rgba(0,0,0,0.12);}GET /tasks

POST /task/

PATCH /task/{id}

Integration guidance

`GET /tasks`

`POST /task/`

`PATCH /task/{id}`