BrewForge Docs

Brewing calendar

Events of the brewing calendar in a date range, as the app's calendar shows them: planned and actual brew days, fermentation steps (dry hop, cold crash, ...), packaging days, ready-by / brew-by dates, reminders and (with the cellar feature) when kegs and fermenters are occupied or free. Default range: 7 days ago to 60 days ahead. Example: {"from": "2026-12-01", "to": "2026-12-31", "types": ["brew_day", "planned"]}. The iCal subscription URL is in get_preferences (calendar_feed). Scope: `brews:read` (or `read`).

POST
/api/v1/actions/get_calendar

Events of the brewing calendar in a date range, as the app's calendar shows them: planned and actual brew days, fermentation steps (dry hop, cold crash, ...), packaging days, ready-by / brew-by dates, reminders and (with the cellar feature) when kegs and fermenters are occupied or free. Default range: 7 days ago to 60 days ahead. Example: {"from": "2026-12-01", "to": "2026-12-31", "types": ["brew_day", "planned"]}. The iCal subscription URL is in get_preferences (calendar_feed).

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

from?string

First day, YYYY-MM-DD (default: 7 days ago).

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

Last day, YYYY-MM-DD (default: 60 days ahead). At most 400 days after from.

Match^\d{4}-\d{2}-\d{2}$
types?array<>

Only these event types: brew_day, planned, packaging, fermentation_event, ready_by, brew_by, reminder, vessel_occupied, vessel_free. Default: all.

[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_calendar" \  -H "Content-Type: application/json" \  -d '{}'
{
  "from": "string",
  "to": "string",
  "counts": {
    "property1": 0,
    "property2": 0
  },
  "events": [
    {
      "date": "string",
      "end": "string",
      "type": "brew_day",
      "title": "string",
      "description": "string",
      "brew": {
        "id": "string",
        "name": "string",
        "batch_number": 0,
        "status": "string"
      },
      "vessel": "string"
    }
  ],
  "truncated": true
}
{
  "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": {}
  }
}