Skip to content
BobaBoard Docs

Fetches board metadata.

GET
/boards/{board_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
board_id
required
string format: uuid

The external id of the board to retrieve metadata for.

Examples

An existing board

c6d3d10e-8e49-4d73-b28a-9d652b41beec

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The board metadata.

One of:
object
id
required
string format: uuid
realm_id
required
string
slug
required
string
avatar_url
required
string format: uri-reference
tagline
required
string
accent_color
required
string
logged_in_only
required
boolean
delisted
required
boolean
descriptions
required
Array
One of: discriminator: type
object
id
required
string format: uuid
index
required
number
title
required
string
type
required
string
Allowed values: text
description
required
string
Examples

An existing board

{
  "id": "c6d3d10e-8e49-4d73-b28a-9d652b41beec",
  "realm_id": "f377afb3-5c62-40cc-8f07-1f4749a780eb",
  "slug": "gore",
  "tagline": "Blood! Blood! Blood!",
  "avatar_url": "/gore.png",
  "accent_color": "#f96680",
  "delisted": false,
  "logged_in_only": false,
  "descriptions": [
    {
      "id": "f377afb3-5c62-40cc-8f07-1f4749a780eb",
      "type": "category_filter",
      "index": 2,
      "title": "Gore Categories",
      "categories": [
        "blood",
        "bruises"
      ],
      "description": null
    },
    {
      "id": "f377afb3-5c62-40cc-8f07-1f4749a780eb",
      "type": "text",
      "index": 1,
      "title": "Gore description",
      "categories": null,
      "description": "[{\"insert\": \"pls b nice\"}]"
    }
  ]
}

401

Section titled “401 ”

User was not found and board requires authentication.

object
message
string
Example
{
  "message": "User must be authenticated to access board."
}

403

Section titled “403 ”

User is not authorized to fetch the metadata of this board.

object
message
string
Example
{
  "message": "User does not have required permission to access board."
}

404

Section titled “404 ”

The board was not found.

string
Example
Not Found