BrewForge Docs

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`).

POST
/api/v1/actions/find_recipes

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).

AuthorizationBearer <token>

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 brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: brews:read

Request Body

application/json

query?string

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".

tag?string

Only recipes whose newest version has this tag, e.g. "competition".

sort?string

"recent" (default: latest change first), "last_brewed" (most recently brewed first, never-brewed last), "times_brewed" (most batches first) or "name".

Value in"recent" | "last_brewed" | "times_brewed" | "name"
limit?integer

How many rows to return, 1-100 (default 20).

Range1 <= value <= 100
cursor?string

next_cursor from the previous page, to get the next page. Omit for the first page.

[key: string]?never

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": {}
  }
}