API docs by Redocly

Tapboard API (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Enables Home Brew Masters to programmatically manage their Tapboard

Get a single Tapboard

Retrieve a Tapboard that belongs to you.

Authorizations:
basicAuth
path Parameters
boardID
required
string

The ID of the Tapboard to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "pk": "string",
  • "sk": "string",
  • "itemType": "board",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "GSI1PK": "string",
  • "GSI1SK": "string",
  • "userID": "string",
  • "hasAds": true,
  • "hasMinimalBranding": true,
  • "name": "string",
  • "layout": "1-COL",
  • "font": "Pangolin",
  • "fontSize": 100,
  • "textColor": "string",
  • "background": "chalkboard",
  • "beverages": [
    ]
}

Update a single Tapboard

Update a Tapboard that belongs to you.

path Parameters
boardID
required
string

The ID of the Tapboard to update.

Request Body schema: application/json

The updated Tapboard. Must include all ID fields, and any differences to mutable fields will overwrite the persisted Tapboard.

id
required
string

Entity ID (immutable)

pk
required
string

Internal ID (immutable)

sk
required
string

Internal ID (immutable)

itemType
required
string
Value: "board"

Internal indicator, will always be "board" (immutable)

createdAt
required
string\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\...

ISO date when the entity was created (immunable)

updatedAt
required
string\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\...

ISO date when the entity was last updated (immutable)

GSI1PK
required
string

Internal ID (immutable)

GSI1SK
required
string

Internal ID (immutable)

userID
required
string

The ID of the Tapboard's owner (immutable)

hasAds
boolean

Internal indicator of owner's permissions (immutable).

hasMinimalBranding
boolean

Internal indicator of owner's permissions (immutable).

name
required
string <= 50 characters

The name of the Tapboard. Visible to users.

layout
string
Default: "2-COL"
Enum: "1-COL" "2-COL"

The layout of the Tapboard in full screen mode.

font
string
Default: "Pangolin"
Enum: "Pangolin" "Chelsea Market" "Permanent Marker" "Roboto" "Open Sans" "Nato Sans" "Montserrat" "Roboto Mono"

The font used to display the Tapboard.

fontSize
number
Default: 100

Percentage adjustment to the default font size of 14px

textColor
string

The color (hex or rgb()) of the Tapboard's font.

string or string
Default: "chalkboard"

The background texture of the Tapboard.

Array of objects

Set of Beverages.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "pk": "string",
  • "sk": "string",
  • "itemType": "board",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "GSI1PK": "string",
  • "GSI1SK": "string",
  • "userID": "string",
  • "hasAds": true,
  • "hasMinimalBranding": true,
  • "name": "string",
  • "layout": "1-COL",
  • "font": "Pangolin",
  • "fontSize": 100,
  • "textColor": "string",
  • "background": "chalkboard",
  • "beverages": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "pk": "string",
  • "sk": "string",
  • "itemType": "board",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "GSI1PK": "string",
  • "GSI1SK": "string",
  • "userID": "string",
  • "hasAds": true,
  • "hasMinimalBranding": true,
  • "name": "string",
  • "layout": "1-COL",
  • "font": "Pangolin",
  • "fontSize": 100,
  • "textColor": "string",
  • "background": "chalkboard",
  • "beverages": [
    ]
}

Update a single Beverage

Update a single Beverage on a Tapboard that belongs to you.

path Parameters
boardID
required
string

The ID of the Tapboard to update.

beverageID
required
string

The ID of the Beverage to update.

Request Body schema: application/json

The updated Beverage. May include any fields, and any differences to mutable fields will overwrite the persisted Beverage. There is no way to unset a value, it is best to set it to its default.

id
required
string <= 32 characters ^[A-Za-z0-9\-]*$

The ID of the Beverage for use with API access. This is not used by Tapboard so it can be changed at any time.

name
required
string <= 100 characters

The name of the Beverage. Visible to users.

description
required
string <= 300 characters

The short description of the Beverage. Visible to users.

style
string <= 50 characters

The style of Beverage. Any value less than or equal to 50 characters can be used.

abv
number

The Beverage's ABV

ibu
number

The Beverage's IBU

color
string <= 30 characters

The Beverage's color in hex or rgb()

temp
number

The Beverage's current temperature. Best when used with a connected digital thermometer.

volume
number

The Beverage's current volume. Use volumeUnit to set the unit.

volumeUnit
string

The unit to display for the Beverage's current volume.

icon
string
Enum: "SHAKER_PINT" "IMPERIAL_PINT" "PILSNER" "WEISEN" "SNIFTER" "THISTLE" "CHALICE" "WINE" "CAN"

The icon to use for this beverage. Generally a representation of the Beverage style.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "style": "string",
  • "abv": 0,
  • "ibu": 0,
  • "color": "string",
  • "temp": 0,
  • "volume": 0,
  • "volumeUnit": "string",
  • "icon": "SHAKER_PINT"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "pk": "string",
  • "sk": "string",
  • "itemType": "board",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "GSI1PK": "string",
  • "GSI1SK": "string",
  • "userID": "string",
  • "hasAds": true,
  • "hasMinimalBranding": true,
  • "name": "string",
  • "layout": "1-COL",
  • "font": "Pangolin",
  • "fontSize": 100,
  • "textColor": "string",
  • "background": "chalkboard",
  • "beverages": [
    ]
}