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`).
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).
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 brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: cellar:write
Request Body
application/json
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.
"menu" | "screen" | "guest_link"create, update, show_on, remove_from, activate, deactivate (screens), revoke (guest links).
"create" | "update" | "show_on" | "remove_from" | "activate" | "deactivate" | "revoke"The menu or screen: id or exact name (not for create).
The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.
create / update: design name, e.g. "Bar TV".
1 <= length <= 100create: template id (menu: classic, modern, brewery, taphouse-board, minimal; screen: taproom, modern, chalkboard, taphouse-board). Default: the first.
Heading shown on the menu/screen (default: the list name).
length <= 200Screens: which beers to show (default both).
"taps" | "bottles" | "both"revoke: the guest link id or URL (optional when the list has one active link).
Guest link create: how many beers guests may add in total.
1 <= value <= 1000Guest link create: days until the link stops working.
1 <= value <= 365Response 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": {}
}
}