---
title: "Get a list of recipes"
method: GET
path: "/recipes"
tags: ["Public"]
---

# Get a list of recipes

`GET /recipes`

Returns a paged list of recipes

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

A list of recipes

- RecipeList — A list of recipes
  - `count` number — The number of recipes returned
  - `total_count` number — The total number of recipes
  - `offset` number — The first row of resources to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter
  - `limit` number — The number of items per page
  - `items` Recipe[]
    - `id` string — A unique id for the recipe
    - `alias` string — An alias for the recipe
    - `format` 'v4' | 'cantabular_blob' | 'cantabular_table' — The recipe format
    - `files` InputFile[]
      - `description` string, required — The description of the input file
    - `output_instances` Instance[] — A list of all instances created using this recipe
      - `dataset_id` string — A unique id for a dataset
      - `editions` string[] — Types of editions within the dataset
      - `title` string — The title for the dataset
      - `code_lists` CodeList[] — A list of all code lists within this instance
        - `id` string — A unique id for a single code list
        - `name` string — The name of the codelist
        - `href` string — A URL to the code list
        - `is_hierarchy` boolean — A bool to inform if there is hierarchy for codelist
    - `cantabular_blob` string — A Cantabular-specific collection of data

## Other responses

- `500` — Failed to process the request due to an internal error

---

[API](https://skmtc.net/office-of-national-statistics/apis/recipe-api.md) · [All operations](https://skmtc.net/office-of-national-statistics/apis/recipe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/office-of-national-statistics/recipe-api/revisions/51dcd3258b3d/schema)