BrewForge Docs

Menus, TV screens and guest links of tap lists

Two different kinds of link. (1) A link guests OPEN TO SEE the list: kind menu (an online menu page, also printable as PDF) or kind screen (a TV display page); 'share my tap list' / 'a page guests can look at' = menu (create with list). (2) kind guest_link = a link where guests ADD THEIR OWN beers to the list (e.g. a bottle share); it does not show the list. Menus/screens are designs that can be shown on several lists, each with its own public URL. actions: create (name, template, optional list to show it on right away, title; screen: show taps/bottles/both), update (design: name/title/show), show_on (design + list), remove_from (design + list), activate / deactivate (screen on a list); guest_link: create (list, max_entries, expires_in_days) or revoke. Templates: menu classic, modern, brewery, taphouse-board, minimal; screen taproom, modern, chalkboard, taphouse-board. Colours, fonts and layout are edited in the app's design editor (not here). Returns the public URLs; menus also a PDF link to print. Needs the plan feature `taplist`. Scope: `cellar:write` (or `write`).

POST
/api/v1/actions/manage_taplist_sharing

Two different kinds of link. (1) A link guests OPEN TO SEE the list: kind menu (an online menu page, also printable as PDF) or kind screen (a TV display page); 'share my tap list' / 'a page guests can look at' = menu (create with list). (2) kind guest_link = a link where guests ADD THEIR OWN beers to the list (e.g. a bottle share); it does not show the list. Menus/screens are designs that can be shown on several lists, each with its own public URL. actions: create (name, template, optional list to show it on right away, title; screen: show taps/bottles/both), update (design: name/title/show), show_on (design + list), remove_from (design + list), activate / deactivate (screen on a list); guest_link: create (list, max_entries, expires_in_days) or revoke. Templates: menu classic, modern, brewery, taphouse-board, minimal; screen taproom, modern, chalkboard, taphouse-board. Colours, fonts and layout are edited in the app's design editor (not here). Returns the public URLs; menus also a PDF link to print.

Needs the plan feature taplist. Scope: cellar:write (or write).

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:write

Request Body

application/json

kind*string

menu = page guests open to see the list (and PDF); screen = TV page showing the list; guest_link = page where guests add beers to the list.

Value in"menu" | "screen" | "guest_link"
action*string

create, update, show_on, remove_from, activate, deactivate (screens), revoke (guest links).

Value in"create" | "update" | "show_on" | "remove_from" | "activate" | "deactivate" | "revoke"
design?string

The menu or screen: id or exact name (not for create).

list?string

The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.

name?string

create / update: design name, e.g. "Bar TV".

Length1 <= length <= 100
template?string

create: template id (menu: classic, modern, brewery, taphouse-board, minimal; screen: taproom, modern, chalkboard, taphouse-board). Default: the first.

title?string

Heading shown on the menu/screen (default: the list name).

Lengthlength <= 200
show?string

Screens: which beers to show (default both).

Value in"taps" | "bottles" | "both"
link?string

revoke: the guest link id or URL (optional when the list has one active link).

max_entries?integer

Guest link create: how many beers guests may add in total.

Range1 <= value <= 1000
expires_in_days?integer

Guest link create: days until the link stops working.

Range1 <= value <= 365
[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/manage_taplist_sharing" \  -H "Content-Type: application/json" \  -d '{    "kind": "menu",    "action": "create"  }'
{
  "kind": "string",
  "id": "string",
  "name": "string",
  "template": "string",
  "url": "string",
  "list": "string",
  "shown_on": [
    {
      "list": "string",
      "url": "string",
      "pdf_url": "string",
      "active": true
    }
  ],
  "message": "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": {}
  }
}