API referenceTasks and demand
Get a task
One task, including the plant or explant it is linked to.
GET
https://app.xplantpro.com/Scope
read:tasksPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | The record's id. |
Example
curl https://app.xplantpro.com/api/v1/tasks/4e9a1c7b-2d3f-4b5a-9c8d-6e7f8a9b0c1d \
-H "Authorization: Bearer $XPLANT_API_KEY"Response
200 with { "ok": true, "data": … }. data holds the result.
| 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 | — |
{
"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",
"entity_link": null
}
}| 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. |
404 | NOT_FOUND | No task with this id exists in the key's workspace, or id is not a well-formed id. |
429 | RATE_LIMIT_EXCEEDED | Too many requests for this key, device token or workspace. Wait Retry-After seconds. |
500 | TASK_QUERY_FAILED | The task could not be read. Retry later. |
Branch on code, never on the error text. See Errors.
Create a task
Adds a task to the workspace. Set priority, priority_rank and assigned_to in the same call so a scheduler can place work in one request. Order set this way counts as automatic, so a later hand-reorder in the app takes precedence over your next sync.
Update a task
Changes only the fields you send. Move a task along the board with workflow_status; complete it with "done".