BrewForge Docs

Cellar overview: what is in which vessel

Shows the brewer's cellar vessels (fermenters, tanks, kegs) with what is in each today, the stays (planned or current) in a date window, and when each vessel is free. Use it for 'what's in the cellar?', 'what is free next week?' (from/to = that week; free_vessels are free all week, free_from/free_until show vessels free for part of it), or to find stay ids for save_stay / end_stay. Filter with vessel or brew. A stay is one beer in one vessel from start_date to end_date (end exclusive; no end = until ended). Volumes are in litres. Bottles/cans and keg volumes are in get_beer_stock. Needs the plan feature `cellar`. Scope: `cellar:read` (or `read`).

POST
/api/v1/actions/get_cellar

Shows the brewer's cellar vessels (fermenters, tanks, kegs) with what is in each today, the stays (planned or current) in a date window, and when each vessel is free. Use it for 'what's in the cellar?', 'what is free next week?' (from/to = that week; free_vessels are free all week, free_from/free_until show vessels free for part of it), or to find stay ids for save_stay / end_stay. Filter with vessel or brew. A stay is one beer in one vessel from start_date to end_date (end exclusive; no end = until ended). Volumes are in litres. Bottles/cans and keg volumes are in get_beer_stock.

Needs the plan feature cellar. Scope: cellar: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: cellar:read

Request Body

application/json

from?string

First day of the window, YYYY-MM-DD (default: today). E.g. next Monday for "what is free next week".

Match^\d{4}-\d{2}-\d{2}$
to?string

Last day of the window, YYYY-MM-DD, inclusive (default: from + 30 days).

Match^\d{4}-\d{2}-\d{2}$
vessel?string

Only this vessel: id or exact name (e.g. "Fermenter 1").

brew?string

Only stays of this brew. 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.

today?string

The brewer's local date today, YYYY-MM-DD (e.g. "2026-11-11"). Optional: defaults to today in UTC. Pass it when the brewer's day differs from UTC (late evening in America, early morning in Asia).

Match^\d{4}-\d{2}-\d{2}$
[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_cellar" \  -H "Content-Type: application/json" \  -d '{}'
{
  "today": "string",
  "from": "string",
  "to": "string",
  "vessels": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "capacity_l": 0,
      "roles": [
        "string"
      ],
      "now": {
        "stay_id": "string",
        "beer": "string",
        "role": "string",
        "until": "string"
      },
      "stays": [
        {
          "id": "string",
          "beer": "string",
          "brew_id": "string",
          "role": "string",
          "name": "string",
          "start_date": "string",
          "end_date": "string",
          "volume_l": 0,
          "status": "planned",
          "notes": "string"
        }
      ],
      "free_from": "string",
      "free_until": "string",
      "free_whole_window": true
    }
  ],
  "free_vessels": [
    "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": {}
  }
}