Get Recipes

get

https://api.apicbase.com/api/v2/products/recipes/

Returns a list of recipes in the library.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Not all of a recipe's fields are available in this list endpoint, for performance reasons. To get all information related to a recipe, use the Get Recipe Details endpoint.

🚧
Recipe modification dates
The modification date gets updated only when there is a change in one of the recipe's native data fields. Attributes that are a calculated result from an aggregation of related objects do not update the recipe's modified_date. These are the financial, nutrition_info, nutrition_info_per_portion and dietary_info objects. Changes to a related object's fields (such as changing an ingredient's names) will also not update the modified_date of the recipes that contain it.
To track these changes, you need to track the modification dates of the ingredients contained in these recipes by querying the Get Ingredients endpoint with the modification_date filter.
For more info about keeping local copies of data objects up to date, consult the guides.

Query Params

page

int32

A page number within the paginated result set.

ordering

string

A field to order results by.

name

string

A recipe name to query on.

uid

string

A UID (reference number) to query on.

persons

int32

The amount of servings.

persons__gt

int32

The amount of servings (greater than).

persons__lt

int32

The amount of servings (lower than).

tax

float

Filter on a tax rate.

tax__gt

float

Filter on a tax rate (greater than).

tax__lt

float

Filter on a tax rate (lower than).

current_sell_price

float

Filter on a sell price (exact).

current_sell_price__gt

float

Filter on a sell price (greater than).

current_sell_price__lt

float

Filter on a sell price (lower than).

created_date

date

Filter on a creation date (exact).

created_date__gt

date

Filter on a creation date (greater than).

created_date__lt

date

Filter on a creation date (lower than).

modified_date

date

Filter on a modification date (exact).

modified_date__gt

date

Filter on a modification date (greater than).

modified_date__gte

date

Filter on a modification date (greater than or equal).

modified_date__lt

date

Filter on a modification date (lower than).

created_by

string

A user ID.

stockable

boolean

Filter recipes that are or are not stockable.

original

string

A recipe ID. Filters on recipes that are clones of a given recipe.

outlet

string

Filter on an outlet ID. Gets recipes connected to an outlet.

outlet__in

string

Filter on a list of outlet IDs (comma-separated). Gets recipes connected to any outlet in the list.

string

Filter on a menu ID. Gets recipes in a given menu.

menu__in

string

Filter on a list of menu IDs (comma-separated). Gets recipes in any of the given menus.

type

string

enum

Filter on a recipe type.

type__in

string

Filter on any given recipe type (comma-separated).

accounting_category

string

Filter on an accounting category. Only for stockable recipes.

accounting_category__in

string

Filter on any given accounting category (comma-separated). Only for stockable recipes.

stage

string

enum

Filter on a recipe stage.

Allowed:

stage__in

string

Filter on any given recipe stage (comma-separated).

season

string

enum

Filter on a recipe's season.

Allowed:

season__in

string

Filter on any given season (comma-separated).

class

string

enum

Filter on a recipe class.

Allowed:

class__in

string

Filter on any given recipe class (comma-separated).

Recipe modification dates

200200