# List explants

> The workspace's explants, newest first, a page at a time. Pass externalId to find the one culture filed under your own identifier instead; the answer is still a list, with that explant or nothing, and meta.next_cursor is always null.

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

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

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

The SDK takes `external_id`; the query parameter is `externalId`.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `externalId` | string | No | Your own identifier for a culture, matched ignoring case against the identifier you gave it, then its batch number, then its label. Returns that one explant, or an empty list; paging does not apply. |
| `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/explants?externalId=LINE-0412" \
  -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 explants = await client.explants.list({ external_id: "LINE-0412" });

// Or resolve one of your own codes straight to a record (or null):
const batch = await client.explants.findByExternalId("LINE-0412");
```

**Python**

```python
import os
import requests

resp = requests.get(
    "https://app.xplantpro.com/api/v1/explants",
    headers={"Authorization": f"Bearer {os.environ['XPLANT_API_KEY']}"},
    params={"externalId": "LINE-0412"},
    timeout=10,
)
body = resp.json()
if not body["ok"]:
    raise RuntimeError(f"{resp.status_code} {body['code']}: {body['error']}")
explants = 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 | — |
| `label` | string \| null | Yes | The culture's label — the name the lab knows it by. |
| `external_id` | string \| null | Yes | Your identifier for the culture: the `external_id` you gave it, otherwise its batch number, otherwise its label. Null when it has none of these. |
| `status` | string | Yes | Where the culture stands, usually one of `active`, `establishing`, `growing`, `needs_subculture`, `quarantined`, `senescing`, `discarded`, `retired`, `lost`. |
| `plant_id` | string \| null | Yes | The plant the explant was taken from, when one is recorded. |
| `workspace_id` | string \| null | Yes | The workspace the explant belongs to. |
| `initial_count` | integer \| null | Yes | The count recorded when the culture was started. |
| `current_count` | integer \| null | Yes | The culture's count as last recorded. |
| `created_at` | string \| null | Yes | ISO 8601 timestamp. |
| `custom_fields` | object | Yes | The lab's own fields for this record, keyed by each field's key as set up in the lab's settings. Values are text, numbers, `true` or `false`, or dates written as `YYYY-MM-DD`; a field left blank is absent or `null`. Empty when the lab has set up no fields. |

```json title="Response"
{
  "ok": true,
  "data": [
    {
      "id": "b7e4a2c9-1f3d-4e8b-8a6c-5d2f9e1b7c34",
      "label": "Zebrina line A",
      "external_id": "LINE-0412-A",
      "status": "establishing",
      "plant_id": "8c3f2d1a-6b4e-4f7a-9d2c-1e5b7a9c3f60",
      "workspace_id": "3a9e7c21-5d4b-4c8f-a1e6-9b2d0f4c7e13",
      "initial_count": null,
      "current_count": null,
      "created_at": "2026-09-25T10:05:00.000Z",
      "custom_fields": {
        "medium_lot": "MS-2609-03",
        "cytokinin_added": true
      }
    }
  ]
}
```

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` | `EXPLANT_QUERY_FAILED` | The explants could not be read. Retry later. |

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