BrewForge Docs

Get a brew

One brew with its status, dates, style and planned stats (OG/FG as SG, ABV %, IBU, color EBC), out-of-style warnings, plus actual stats once measured. Heavy sections only on request with include: "recipe" (ingredients with entry ids for update_recipe, mash and fermentation steps; L, g, °C), "measured" (brew-day measurements), "readings" (newest fermentation readings), "notes" (newest notes), "versions" (version history: every version and batch of this recipe), "cost" (ingredient cost from inventory prices, in the user's currency). Reference the brew by id, batch number or exact name. Scope: `brews:read` (or `read`).

POST
/api/v1/actions/get_brew

One brew with its status, dates, style and planned stats (OG/FG as SG, ABV %, IBU, color EBC), out-of-style warnings, plus actual stats once measured. Heavy sections only on request with include: "recipe" (ingredients with entry ids for update_recipe, mash and fermentation steps; L, g, °C), "measured" (brew-day measurements), "readings" (newest fermentation readings), "notes" (newest notes), "versions" (version history: every version and batch of this recipe), "cost" (ingredient cost from inventory prices, in the user's currency). Reference the brew by id, batch number or exact name.

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

brew*string

The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.

include?array<>

Extra sections to include, e.g. ["recipe", "versions"]. Default: none (summary only).

[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/get_brew" \  -H "Content-Type: application/json" \  -d '{    "brew": "string"  }'
{
  "id": "string",
  "name": "string",
  "status": "idea",
  "planned": {
    "og_sg": 0,
    "og_plato": 0,
    "fg_sg": 0,
    "fg_plato": 0,
    "abv_pct": 0,
    "ibu": 0,
    "color_ebc": 0
  },
  "actual": {
    "og_sg": 0,
    "og_plato": 0,
    "fg_sg": 0,
    "fg_plato": 0,
    "abv_pct": 0,
    "ibu": 0,
    "color_ebc": 0
  },
  "readings": [
    {
      "at": "string",
      "gravity_sg": 0,
      "gravity_plato": 0,
      "temp_c": 0,
      "ph": 0,
      "pressure_psi": 0,
      "comment": "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": {}
  }
}