Find ingredients
Search the ingredient catalog by name and type, with key specs (color, alpha acid, attenuation, ...). Use it to find the exact name or id that add_stock, order items and recipe tools expect. scope "picker" (default) lists what the user can use right now: My Ingredients plus the ingredients chosen from packages. scope "catalog" searches every package BrewForge offers (query required), including ingredients not picked yet (in_picker: false); pick those with select_package_ingredients. This lists ingredients, not stock; find_stock shows amounts in stock. Scope: `inventory:read` (or `read`).
Search the ingredient catalog by name and type, with key specs (color, alpha acid, attenuation, ...). Use it to find the exact name or id that add_stock, order items and recipe tools expect. scope "picker" (default) lists what the user can use right now: My Ingredients plus the ingredients chosen from packages. scope "catalog" searches every package BrewForge offers (query required), including ingredients not picked yet (in_picker: false); pick those with select_package_ingredients. This lists ingredients, not stock; find_stock shows amounts in stock.
Scope: inventory: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: inventory:read
Request Body
application/json
Text the name contains, e.g. "citra", "pilsner", "us-05". Required for scope "catalog" (at least 2 characters).
Ingredient type: "fermentable" (malts, sugars, extracts), "hop", "yeast" or "misc" (water agents, finings, spices, ...).
"fermentable" | "hop" | "yeast" | "misc""picker" (default): ingredients the user can use. "catalog": search all packages, including ones not in the picker.
"picker" | "catalog"Only the user's own ingredients (My Ingredients and imported ones).
How many rows to return, 1-100 (default 25).
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_ingredients" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"id": "string",
"name": "string",
"type": "fermentable",
"package": "string",
"package_id": "string",
"own": true,
"in_picker": true,
"property1": null,
"property2": null
}
],
"next_cursor": "string",
"hint": "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": {}
}
}