Skip to main content
GET
Get recipe

Authorizations

X-API-Key
string
header
required

Path Parameters

recipe_id
string<shortuuid>
required

Id of the recipe.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A recipe with the products it is attached to.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
organization_id
string<shortuuid>
required

The organization that owns this recipe.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
title
string
required

Recipe title.

description
string
required

Short description. Empty string when unset.

ingredients_list
string
required

Ingredients, one per line.

instructions
string
required

Preparation instructions.

image_url
string
required

External image URL. Empty string when unset.

preparation_time_minutes
integer
required

Preparation time in minutes.

cooking_time_minutes
integer
required

Cooking time in minutes.

servings
integer
required

Number of servings the recipe makes.

difficulty
enum<string>
required

How hard the recipe is to prepare.

Available options:
easy,
medium,
hard
products
RecipeProductOut · object[]
required

The products this recipe is shown on, by GTIN.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).