List stages
Every stage one plant or explant has been through, newest first — where it is now and how it got there. Send exactly one of plant_id or explant_id.
https://app.xplantpro.com/read:transfersStage names are your lab's own, so expect the keys from your workspace's stage list rather than a fixed set.
The list is ordered by entered_on, which can be corrected after the fact: a stage whose date is changed while you page through can move between pages. Stages entered on the same day keep a fixed order.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
plant_id | string (uuid) | No | The plant whose stage history to read. Send exactly one of plant_id or explant_id. |
explant_id | string (uuid) | No | The explant whose stage history to read. |
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 "https://app.xplantpro.com/api/v1/stages?plant_id=0b8e2f4c-6a1d-4c3e-9f7a-2d5b8c1e4a90" \
-H "Authorization: Bearer $XPLANT_API_KEY"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.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | — |
entity_type | "plant" | "explant" | Yes | Whether the stage belongs to a plant or an explant. |
entity_id | string (uuid) | Yes | The plant's or explant's id. |
stage | string | Yes | The stage, usually as a key from your lab's stage list such as multiplication. Records made by older tools can carry the stage's display name instead, such as Multiplication. |
status | string | Yes | active for the stage the plant or explant is in now, completed for one it has moved on from. Stages can also be failed or archived. |
entered_on | string | null | Yes | When it entered this stage, as an ISO 8601 timestamp. |
completed_at | string | null | Yes | When it moved on from this stage. Null while the stage is current. |
room_id | string | null (uuid) | Yes | The room it was in for this stage, when one was recorded. |
notes | string | null | Yes | — |
created_at | string | null | Yes | — |
{
"ok": true,
"data": [
{
"id": "6e5d4c3b-2a19-4807-96a5-b4c3d2e1f0a9",
"entity_type": "explant",
"entity_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"stage": "multiplication",
"status": "active",
"entered_on": "2026-09-24T00:00:00+00:00",
"completed_at": null,
"room_id": null,
"notes": "Shoot clusters forming well on the Alocasia line.",
"created_at": "2026-09-24T08:41:17.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. |
404 | NOT_FOUND | The plant or explant is not in this workspace. |
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. |
422 | VALIDATION_ERROR | Neither or both of plant_id and explant_id were sent. |
429 | RATE_LIMIT_EXCEEDED | Too many requests for this key, device token or workspace. Wait Retry-After seconds. |
500 | STAGE_QUERY_FAILED | The stage history could not be read. Retry later. |
Branch on code, never on the error text. See Errors.
Update an explant
Changes only the fields you send. Send null to clear an optional one.
Advance a stage
Moves a plant or explant into a new stage in one call: the stage it is in now is marked completed, the new one is recorded, and it becomes the current stage. Send exactly one of plant_id or explant_id.