Find brews
List the user's brews (every batch and recipe idea), newest activity first. Filter by name, batch number, status or tag. Returns compact rows (id, name, batch number, status, style, dates); call get_brew with an id for details. Brews can be referenced by id, batch number or exact name in other tools, so use this when you need to search, not to look up one brew you already know. Scope: `brews:read` (or `read`).
List the user's brews (every batch and recipe idea), newest activity first. Filter by name, batch number, status or tag. Returns compact rows (id, name, batch number, status, style, dates); call get_brew with an id for details. Brews can be referenced by id, batch number or exact name in other tools, so use this when you need to search, not to look up one brew you already know.
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 brew name contains, or a batch number (e.g. "pale ale", "12", "#12").
Only brews in these statuses, e.g. ["fermenting", "conditioning"]. Lifecycle: idea → planned → brewing → fermenting → conditioning → completed → archived.
Only brews with this tag (exact, e.g. "competition").
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_brews" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"id": "string",
"name": "string",
"batch_number": 0,
"status": "idea",
"style": "string",
"brew_date": "string",
"planned_date": "string",
"tags": [
"string"
],
"pinned": true
}
],
"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": {}
}
}