Browse the recipe book
The recipe book: one row per recipe (all its versions and batches grouped), newest activity first, with style, version count, times brewed (batches), last brew date and BJCP score. query matches text in the recipe name, its style and the style's BJCP category, so "lager" also finds a German Pils filed under a lager category, but only by text: for a family the brewer defines (e.g. "house lagers"), use tag. sort: recent (default), last_brewed, times_brewed or name. Use it to answer "what have I brewed" or to pick a recipe to brew again (copy_brew). For one recipe's version history call get_brew with include ["versions"]; for individual batches use find_brews. Scope: `brews:read` (or `read`).
The recipe book: one row per recipe (all its versions and batches grouped), newest activity first, with style, version count, times brewed (batches), last brew date and BJCP score. query matches text in the recipe name, its style and the style's BJCP category, so "lager" also finds a German Pils filed under a lager category, but only by text: for a family the brewer defines (e.g. "house lagers"), use tag. sort: recent (default), last_brewed, times_brewed or name. Use it to answer "what have I brewed" or to pick a recipe to brew again (copy_brew). For one recipe's version history call get_brew with include ["versions"]; for individual batches use find_brews.
Scope: brews:read (or read).
API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).
read: Read everything (all areas)write: Create, change and delete everything (all areas)brews:read: List and view brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: brews:read
Request Body
application/json
Text the recipe name, style or style category contains, e.g. "ipa" or "lager". Several alternatives separated by commas match any of them, e.g. "pale ale, ipa".
Only recipes whose newest version has this tag, e.g. "competition".
"recent" (default: latest change first), "last_brewed" (most recently brewed first, never-brewed last), "times_brewed" (most batches first) or "name".
"recent" | "last_brewed" | "times_brewed" | "name"How many rows to return, 1-100 (default 20).
1 <= value <= 100next_cursor from the previous page, to get the next page. Omit for the first page.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/find_recipes" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"recipe_id": "string",
"name": "string",
"latest_brew_id": "string",
"latest_version": "string",
"style": "string",
"versions": 0,
"batches": 0,
"last_brewed": "string",
"bjcp_avg_score": 0,
"tags": [
"string"
]
}
],
"next_cursor": "string"
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}