BrewForge Docs

List or open ingredient packages

Ingredient packages are the catalog: collections of malts, hops, yeasts and misc from one supplier (e.g. "Weyermann"), plus the user's own packages (My Ingredients, imports). Only picked ingredients show in the user's picker for recipes and stock. Without package: lists every package with ingredient counts and how much of it is picked (in_picker all/some/none). With package (id or name): that package's ingredients with key specs and in_picker per ingredient, filterable by type and name. To find which package has an ingredient use find_ingredients with scope "catalog". To pick ingredients use select_package_ingredients. Scope: `inventory:read` (or `read`).

POST
/api/v1/actions/get_ingredient_packages

Ingredient packages are the catalog: collections of malts, hops, yeasts and misc from one supplier (e.g. "Weyermann"), plus the user's own packages (My Ingredients, imports). Only picked ingredients show in the user's picker for recipes and stock. Without package: lists every package with ingredient counts and how much of it is picked (in_picker all/some/none). With package (id or name): that package's ingredients with key specs and in_picker per ingredient, filterable by type and name. To find which package has an ingredient use find_ingredients with scope "catalog". To pick ingredients use select_package_ingredients.

Scope: inventory: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: inventory:read

Request Body

application/json

package?string

The ingredient package: its id or exact name (e.g. "Weyermann", "Yakima Chief Hops"). get_ingredient_packages lists them. Leave out to list all packages.

type?string

Only packages / ingredients of this type.

Value in"fermentable" | "hop" | "yeast" | "misc"
query?string

Text in the package name (list) or ingredient name (one package).

limit?integer

How many rows to return, 1-200 (default 50).

Range1 <= value <= 200
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/get_ingredient_packages" \  -H "Content-Type: application/json" \  -d '{}'
{
  "packages": [
    {
      "id": "string",
      "name": "string",
      "kind": "catalog",
      "supplier": "string",
      "region": "string",
      "ingredients": {
        "fermentable": 0,
        "hop": 0,
        "yeast": 0,
        "misc": 0
      },
      "in_picker": "all"
    }
  ],
  "package": {
    "id": "string",
    "name": "string",
    "kind": "catalog",
    "supplier": "string",
    "region": "string",
    "ingredients": {
      "fermentable": 0,
      "hop": 0,
      "yeast": 0,
      "misc": 0
    },
    "in_picker": "all",
    "description": "string",
    "website": "string"
  },
  "ingredients": [
    {
      "id": "string",
      "name": "string",
      "type": "fermentable",
      "in_picker": true,
      "property1": null,
      "property2": null
    }
  ],
  "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": {}
  }
}