Skip to content
BobaBoard Docs

Fetches the top-level realm metadata by slug.

GET
/realms/slug/{realm_slug}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
realm_slug
required
string

The slug of the realm.

Examples

the v0 realm

v0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The realm metadata.

object
id
required
string format: uuid
slug
required
string
icon
required
string format: uri
homepage
required

Settings for the Realm homepage.

object
blocks
required

List of UI Blocks that appear in the Realm homepage.

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
settings
required

Cosmetic settings active for the Realm, merged with users’ own preferences.

object
root
required
object
cursor
object
index_page
required
Array
One of: discriminator: type
object
name
required
string
type
required
string
Allowed values: BOOLEAN
value
required
boolean
board_page
required
Array
One of: discriminator: type
object
name
required
string
type
required
string
Allowed values: BOOLEAN
value
required
boolean
thread_page
required
Array
One of: discriminator: type
object
name
required
string
type
required
string
Allowed values: BOOLEAN
value
required
boolean
realm_permissions
required
Array<string>
Allowed values: create_realm_invite post_on_realm comment_on_realm create_thread_on_realm access_locked_boards_on_realm view_roles_on_realm
boards
required
Array<object>
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
Examples

The data for the v0 Realm

{
  "id": "0d91d28f-182c-4684-aa6c-9159059a5b49",
  "slug": "v0",
  "icon": "https://images-ext-1.discordapp.net/external/KLz7_JytTOB6vzGDmnAuXTgkDtWuUCluyB6VxiAL8FA/%3Fsize%3D1024/https/cdn.discordapp.com/icons/911351540504199168/d6f98ff59822c22b1ff650796c346166.png",
  "settings": {
    "root": {
      "cursor": {}
    },
    "index_page": [],
    "board_page": [],
    "thread_page": []
  },
  "homepage": {
    "blocks": [
      {
        "id": "f8cf1796-c5b4-49c9-9773-eb1a245e222c",
        "index": 0,
        "title": "A description block",
        "type": "text",
        "description": "Welcome to the Realm"
      },
      {
        "id": "d829b5fb-6343-4700-bf7c-7626950f2c8d",
        "index": 1,
        "title": "A rules block",
        "type": "rules",
        "rules": [
          {
            "index": 0,
            "title": "Be nice to each other",
            "description": "What it says up there",
            "pinned": true
          },
          {
            "index": 1,
            "title": "This is a hidden rule",
            "description": "Congratulations! Here's a cookie",
            "pinned": false
          }
        ]
      }
    ]
  },
  "realm_permissions": [
    "create_realm_invite",
    "post_on_realm",
    "comment_on_realm",
    "create_thread_on_realm",
    "access_locked_boards_on_realm"
  ],
  "boards": [
    {
      "id": "2fb151eb-c600-4fe4-a542-4662487e5496",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "main_street",
      "tagline": "For BobaBoard-related discussions.",
      "avatar_url": "/villains.png",
      "accent_color": "#ff5252",
      "delisted": false,
      "logged_in_only": false
    },
    {
      "id": "c6d3d10e-8e49-4d73-b28a-9d652b41beec",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "gore",
      "tagline": "Blood! Blood! Blood!",
      "avatar_url": "/gore.png",
      "accent_color": "#f96680",
      "delisted": false,
      "logged_in_only": false
    },
    {
      "id": "4b30fb7c-2aca-4333-aa56-ae8623a92b65",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "anime",
      "tagline": "I wish I had a funny one for this.",
      "avatar_url": "/anime.png",
      "accent_color": "#24d282",
      "delisted": false,
      "logged_in_only": false
    },
    {
      "id": "db8dc5b3-5b4a-4bfe-a303-e176c9b00b83",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "long",
      "tagline": "A board to test with many posts.",
      "avatar_url": "/onceler-board.png",
      "accent_color": "#00b8ff",
      "delisted": false,
      "logged_in_only": false
    },
    {
      "id": "0e0d1ee6-f996-4415-89c1-c9dc1fe991dc",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "memes",
      "tagline": "A board to test collections view.",
      "avatar_url": "/kink-meme.png",
      "accent_color": "#7b00ff",
      "delisted": false,
      "logged_in_only": false
    },
    {
      "id": "2bdce2fa-12e0-461b-b0fb-1a2e67227434",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "muted",
      "tagline": "A board to test for muting.",
      "avatar_url": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fc26e8ce9-a547-4ff4-9486-7a2faca4d873%2Feded338a-e0e5-4a97-a368-5ae525c0eec4?alt=media&token=914f84b7-a581-430e-bb09-695f653e8e02",
      "accent_color": "#9b433b",
      "delisted": false,
      "logged_in_only": false
    },
    {
      "id": "76ebaab0-6c3e-4d7b-900f-f450625a5ed3",
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "slug": "restricted",
      "tagline": "A board to test for logged-in only view",
      "avatar_url": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fgore%2Fe4e263cf-ee98-4902-9c14-c10299210e01.png?alt=media&token=7c170411-9401-4d4e-9f66-5d6dfee2fccd",
      "accent_color": "#234a69",
      "delisted": false,
      "logged_in_only": true
    }
  ]
}

404

Section titled “404 ”

The realm was not found.