BrewForge Docs

Tap lists: beers, taps, menus and screens

Shows the brewer's tap lists (the beers on offer in a taproom, at home or at an event). With one list (or list given): its beers, its taps with what is pouring and next up, the menus/screens showing it with their public URLs, guest add-links, and brews that could still be added. With several lists and no list: a summary of each list plus the menu and screen designs. Call it before manage_tap or save_taplist_beer to see names and ids. Needs the plan feature `taplist`. Scope: `cellar:read` (or `read`).

POST
/api/v1/actions/get_taplist

Shows the brewer's tap lists (the beers on offer in a taproom, at home or at an event). With one list (or list given): its beers, its taps with what is pouring and next up, the menus/screens showing it with their public URLs, guest add-links, and brews that could still be added. With several lists and no list: a summary of each list plus the menu and screen designs. Call it before manage_tap or save_taplist_beer to see names and ids.

Needs the plan feature taplist. 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

list?string

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

[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_taplist" \  -H "Content-Type: application/json" \  -d '{}'
{
  "lists": [
    {
      "id": "string",
      "name": "string",
      "beers": 0,
      "taps": 0,
      "menus": [
        "string"
      ],
      "screens": [
        "string"
      ]
    }
  ],
  "list": {
    "id": "string",
    "name": "string",
    "description": "string",
    "default_serving": "string",
    "auto_add_completed": true,
    "include_conditioning": true,
    "beers": [
      {
        "id": "string",
        "name": "string",
        "brew_id": "string",
        "style": "string",
        "abv_pct": 0,
        "ibu": 0,
        "color_ebc": 0,
        "color_srm": 0,
        "serving": [
          "string"
        ],
        "available": true,
        "on_tap": "string",
        "next_up_on": "string"
      }
    ],
    "taps": [
      {
        "id": "string",
        "name": "string",
        "enabled": true,
        "pouring": "string",
        "next_up": "string"
      }
    ],
    "menus": [
      {
        "id": "string",
        "name": "string",
        "url": "string",
        "pdf_url": "string"
      }
    ],
    "screens": [
      {
        "id": "string",
        "name": "string",
        "url": "string",
        "active": true
      }
    ],
    "guest_links": [
      {
        "id": "string",
        "url": "string",
        "active": true,
        "added": 0,
        "max": 0,
        "expiry_date": "string"
      }
    ],
    "brews_to_add": [
      {
        "id": "string",
        "name": "string",
        "status": "string"
      }
    ]
  },
  "designs": {
    "menus": [
      {
        "id": "string",
        "name": "string",
        "template": "string",
        "lists": [
          "string"
        ]
      }
    ],
    "screens": [
      {
        "id": "string",
        "name": "string",
        "template": "string",
        "lists": [
          "string"
        ]
      }
    ],
    "templates": {
      "menu": [
        "string"
      ],
      "screen": [
        "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": {}
  }
}