# List media recipes

> The workspace's culture media recipes that the key's owner can see — their own, and those shared with the workspace or published — newest first, each with its components. Another member's private recipe is not listed. Filter by status.

Source: https://docs.xplantpro.com/docs/api/media/list-media-recipes

`GET https://app.xplantpro.com/api/v1/media-recipes`

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

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `"active"` \| `"archived"` \| `"deprecated"` \| `"draft"` \| `"published"` | No | Only recipes with this status. |
| `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/media-recipes?status=published" \
  -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 recipes = await client.mediaRecipes.list({ status: "published" });
```

**Python**

```python
import os
import requests

resp = requests.get(
    "https://app.xplantpro.com/api/v1/media-recipes",
    headers={"Authorization": f"Bearer {os.environ['XPLANT_API_KEY']}"},
    params={"status": "published"},
    timeout=10,
)
body = resp.json()
if not body["ok"]:
    raise RuntimeError(f"{resp.status_code} {body['code']}: {body['error']}")
recipes = 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 \| null | Yes | One of `active`, `archived`, `deprecated`, `draft`, `published`. |
| `origin` | string \| null | Yes | Where the recipe came from, for example `user` or `imported`. |
| `visibility` | string | Yes | `private`: only its creator can see it. `team`: everyone in the workspace can. |
| `is_public` | boolean | Yes | Published to xPlant's public recipe library. |
| `notes` | string \| null | Yes | — |
| `ph_target` | number \| null | Yes | Target pH. |
| `sterilization_notes` | string \| null | Yes | — |
| `storage_notes` | string \| null | Yes | — |
| `usage_notes` | string \| null | Yes | — |
| `components` | object[] | Yes | The ingredients, in order. |
| `components[].id` | string | Yes | The component's id. Send it back in an update to keep the component. |
| `components[].name` | string | Yes | The ingredient. |
| `components[].qty` | string | Yes | The amount as the recipe writes it. |
| `components[].unit` | string \| null | Yes | The unit of `qty`. |
| `components[].concentration` | string \| null | Yes | A concentration, when the recipe states one apart from the amount. |
| `version` | integer | Yes | The recipe's version. It goes up by one each time the formulation changes, and every version is kept. |
| `created_by` | string | Yes | User id of the workspace member who created the recipe. Only they can change it. |
| `created_at` | string \| null | Yes | ISO 8601. |

```json title="Response"
{
  "ok": true,
  "data": [
    {
      "id": "a3d5f7b9-1c2e-4f6a-8b0d-2e4f6a8c0e1f",
      "title": "MS + 1 mg/L BAP",
      "status": "active",
      "origin": "user",
      "visibility": "team",
      "is_public": false,
      "notes": "Shoot multiplication medium for aroid cultures.",
      "ph_target": 5.8,
      "sterilization_notes": "Autoclave for 20 minutes at 121 °C.",
      "storage_notes": "Keep poured vessels at 4 °C and use within two weeks.",
      "usage_notes": null,
      "components": [
        {
          "id": "c1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b",
          "name": "MS basal salts",
          "qty": "4.4",
          "unit": "g/L",
          "concentration": null
        },
        {
          "id": "d2b3c4d5-e6f7-4a81-9b0c-1d2e3f4a5b6c",
          "name": "Sucrose",
          "qty": "30",
          "unit": "g/L",
          "concentration": null
        },
        {
          "id": "e3c4d5e6-f7a8-4b92-8c1d-2e3f4a5b6c7d",
          "name": "6-BAP",
          "qty": "1",
          "unit": "mg/L",
          "concentration": null
        },
        {
          "id": "f4d5e6f7-a8b9-4ca3-9d2e-3f4a5b6c7d8e",
          "name": "Agar",
          "qty": "7",
          "unit": "g/L",
          "concentration": null
        }
      ],
      "version": 1,
      "created_by": "0d7e4b9a-6f21-4c3e-8a5b-2e9f1c7d4a60",
      "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. |
| `422` | `VALIDATION_ERROR` | `status` is not one of the recipe statuses. |
| `429` | `RATE_LIMIT_EXCEEDED` | Too many requests for this key, device token or workspace. Wait `Retry-After` seconds. |
| `500` | `MEDIA_RECIPE_QUERY_FAILED` | The recipes could not be read. Retry later. |

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