> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fire.rest/llms.txt
> Use this file to discover all available pages before exploring further.

# List recipes

> Returns recipes for a vendor with optional filters. Recipes define how inventory items are consumed.

<ParamField header="x-api-key" type="string" required>
  BOH API key with `recipes:read` scope.
</ParamField>

<ParamField path="vendorId" type="string" required>
  Vendor UUID.
</ParamField>

<ParamField query="recipe_type" type="string">
  Filter: `SALES_RECIPE`, `PRODUCTION_RECIPE`, or `SUBRECIPE`.
</ParamField>

<ParamField query="status" type="string">
  `DRAFT`, `PUBLISHED`, or `ARCHIVED`. Defaults to all non-archived.
</ParamField>

<ParamField query="store_id" type="string">
  UUID of a BOH store — returns recipes scoped to that store plus global ones.
</ParamField>

<ParamField query="external_product_id" type="string">
  Your product ID — returns recipes linked to that product.
</ParamField>

<ParamField query="output_item_id" type="string">
  UUID of the output item — for production recipes and subrecipes.
</ParamField>

<ParamField query="service_code" type="string">
  Returns recipes that have at least one line matching this service code.
</ParamField>

<ParamField query="search" type="string">
  Partial match on recipe name or code.
</ParamField>

<ParamField query="limit" type="integer" default="50">
  Page size (1–200).
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Offset pagination.
</ParamField>

<ParamField query="cursor" type="string">
  Cursor-based pagination (mutually exclusive with `offset`).
</ParamField>

<RequestExample>
  ```http theme={null}
  GET /api/v1/public/vendors/vnd_abc123/recipes?recipe_type=SALES_RECIPE&status=PUBLISHED
  x-api-key: boh_live_xxxxxxxx
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "items": [
      {
        "id": "rec_01j5k...",
        "account_id": "acc_01j...",
        "store_id": null,
        "recipe_type": "SALES_RECIPE",
        "status": "PUBLISHED",
        "version": 2,
        "recipe_name": "Classic Burger",
        "recipe_code": null,
        "external_product_id": "prod-burger-001",
        "external_variant_id": null,
        "output_item_id": null
      }
    ],
    "total": 1,
    "limit": 50,
    "offset": 0
  }
  ```
</ResponseExample>