# List tasks

> The workspace's tasks, earliest due first. Filter by board column or assignee; with neither, you get the whole queue a page at a time.

Source: https://docs.xplantpro.com/docs/api/tasks/list-tasks

`GET https://app.xplantpro.com/api/v1/tasks`

- Required scope: `read:tasks`
- Credentials: workspace API key (`xpk_`)
- Idempotency-Key: ignored on this endpoint

A task's due date changes when it is rescheduled, so a task rescheduled while you page through the list can move between pages: it may appear twice, or not at all. Tasks due at the same moment keep a fixed order.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `"backlog"` \| `"todo"` \| `"in_progress"` \| `"waiting_blocked"` \| `"review"` \| `"done"` | No | Only tasks in this board column. |
| `assigned_to` | string (uuid) | No | Only tasks assigned to this workspace member (user id). |
| `limit` | integer | No | Page size. Values above 200 are capped at 200. Default `50`. From 1 to 200. |
| `offset` | integer | No | Number of records to skip. Prefer `cursor` where a list offers it: an offset shifts when records are added ahead of it. Default `0`. At least 0. |
| `cursor` | string | No | Continue from the previous page: pass its `meta.next_cursor` unchanged, with the same filters. Treat it as opaque. Not combinable with `offset`. Up to 2048 characters. |

## Example

**curl**

```bash
curl "https://app.xplantpro.com/api/v1/tasks?status=todo&limit=50" \
  -H "Authorization: Bearer $XPLANT_API_KEY"
```

**JavaScript**

```js
import { XPlantClient } from "@shmaplex/xplant-sdk";

const client = new XPlantClient({ apiKey: process.env.XPLANT_API_KEY });

const tasks = await client.tasks.list({ status: "todo", limit: 50 });
```

**Python**

```python
import os
import requests

resp = requests.get(
    "https://app.xplantpro.com/api/v1/tasks",
    headers={"Authorization": f"Bearer {os.environ['XPLANT_API_KEY']}"},
    params={"status": "todo", "limit": 50},
    timeout=10,
)
body = resp.json()
if not body["ok"]:
    raise RuntimeError(f"{resp.status_code} {body['code']}: {body['error']}")
tasks = body["data"]
```

## Response

`200` with `{ "ok": true, "data": … }`. `data` is an array. To get the next page, pass `meta.next_cursor` back as `cursor`; it is `null` on the last page. See [Pagination](https://docs.xplantpro.com/docs/pagination.md).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes | — |
| `title` | string | Yes | — |
| `status` | string | Yes | Board column: `backlog`, `todo`, `in_progress`, `waiting_blocked`, `review`, `done`. |
| `due_date` | string \| null | Yes | ISO 8601 timestamp. |
| `assigned_to` | string \| null | Yes | User id of the workspace member the task is assigned to. |
| `priority` | string \| null | Yes | — |
| `priority_rank` | number \| null | Yes | Queue position. Lower sorts first; null means the priority label decides. |
| `priority_source` | string | Yes | Where the current order came from: `default`, `auto`, `manual`. `manual` means a person placed the task, and automated writes leave it where it is unless they send `release: true`. |
| `category` | string \| null | Yes | — |
| `created_at` | string \| null | Yes | — |
| `entity_link` | object \| null | No | The plant or explant the task is about. Returned when you create, fetch or update one task; lists leave it out. |
| `entity_link.entity_type` | `"plant"` \| `"explant"` | Yes | — |
| `entity_link.entity_id` | string (uuid) | Yes | — |

```json title="Response"
{
  "ok": true,
  "data": [
    {
      "id": "5b0f6f3e-2c1a-4d8e-9f47-0a6c3e1b7d22",
      "title": "Transfer the Alocasia line onto fresh medium",
      "status": "todo",
      "due_date": "2026-10-02T09:00:00.000Z",
      "assigned_to": "0d7e4b9a-6f21-4c3e-8a5b-2e9f1c7d4a60",
      "priority": "high",
      "priority_rank": 1.5,
      "priority_source": "auto",
      "category": "transfer",
      "created_at": "2026-09-25T14:12:03.000Z"
    }
  ]
}
```

The envelope can also carry `meta`:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `next_cursor` | string \| null | Yes | Pass as `cursor` to fetch the next page. `null` means this is the last page. |

| Response header | Meaning |
| --- | --- |
| `X-Request-Id` | Identifies this request. Include it when you contact support. |

## Errors

| Status | Code | When |
| --- | --- | --- |
| `401` | `UNAUTHORIZED` | The key is missing, malformed or revoked, or its owner is no longer a member of the workspace. |
| `402` | `PAID_PLAN_REQUIRED` | The workspace's plan does not include the API. The full API is included with xPlant+ Teams and Enterprise; on Hobby and Pro Lab, keys can connect devices only. |
| `403` | `FORBIDDEN` | The key lacks a scope this operation requires, or its owner's current role in the workspace cannot use it — a key never does more than its owner can in xPlant. `error` names the scope, and for a role, the role it needs. |
| `403` | `DEVICE_TOKEN_NOT_ACCEPTED` | A device token was sent; this operation needs a workspace API key. |
| `422` | `VALIDATION_ERROR` | Both `cursor` and `offset` were sent; use one. |
| `422` | `INVALID_CURSOR` | The cursor is malformed, or came from a different list or different filters. Start again without it. |
| `429` | `RATE_LIMIT_EXCEEDED` | Too many requests for this key, device token or workspace. Wait `Retry-After` seconds. |
| `500` | `TASK_QUERY_FAILED` | The tasks could not be read. Retry later. |

Branch on `code`, never on the `error` text. See [Errors](https://docs.xplantpro.com/docs/errors.md).