# List SOPs

> The workspace's standard operating procedures, most recently updated first — drafts and archived ones included, with status saying which. Summaries only: fetch one SOP to read the steps of the version in force.

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

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

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

Editing an SOP moves it to the front of the list, so an SOP edited while you page through can move between pages: it may appear twice, or not at all.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `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/sops?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 sops = await client.sops.list({ limit: 50 });
```

**Python**

```python
import os
import requests

resp = requests.get(
    "https://app.xplantpro.com/api/v1/sops",
    headers={"Authorization": f"Bearer {os.environ['XPLANT_API_KEY']}"},
    params={"limit": 50},
    timeout=10,
)
body = resp.json()
if not body["ok"]:
    raise RuntimeError(f"{resp.status_code} {body['code']}: {body['error']}")
sops = 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 | — |
| `description` | string \| null | Yes | — |
| `category` | string \| null | Yes | The kind of procedure, such as `media-prep`, `sterilization` or `tissue-culture`. |
| `status` | string \| null | Yes | `draft`, `active` or `archived`. |
| `level` | string \| null | Yes | Who it is written for: `beginner`, `intermediate`, `advanced` or `expert`. |
| `tags` | string[] | Yes | — |
| `equipment` | string[] | Yes | Equipment the procedure calls for. |
| `estimatedTimeMinutes` | number \| null | Yes | How long one run is expected to take, in minutes. |
| `durationHours` | number \| null | Yes | The procedure's duration in hours, as the lab recorded it. |
| `currentVersion` | integer | Yes | The newest version number. It can be a draft; the version the lab works from is the one Get an SOP returns. |
| `updatedAt` | string \| null | Yes | — |
| `createdAt` | string \| null | Yes | — |

```json title="Response"
{
  "ok": true,
  "data": [
    {
      "id": "2e4f6a8c-0b1d-4e3f-9a5b-7c9d1e3f5a7b",
      "title": "Phalaenopsis flower-stalk node initiation",
      "description": "Surface-sterilise nodes from a healthy flower stalk and place them onto initiation medium.",
      "category": "tissue-culture",
      "status": "active",
      "level": "intermediate",
      "tags": [
        "initiation",
        "orchid"
      ],
      "equipment": [
        "laminar flow hood",
        "autoclave"
      ],
      "estimatedTimeMinutes": 45,
      "durationHours": null,
      "currentVersion": 3,
      "updatedAt": "2026-09-18T11:04:52.000Z",
      "createdAt": "2026-06-02T08:30:00.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` | `SOP_QUERY_FAILED` | The SOPs could not be read. Retry later. |

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