Skip to content
BobaBoard Docs

Fetches thread data.

GET
/threads/{thread_id}

Fetches data for the specified thread.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

The id of the thread to fetch.

Examples

A thread with a comments thread.

8b2646af-2778-487e-8e44-7ae530c2549c

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The thread data.

object
posts
required
Array<object>

A contribution to a thread.

object
id
required
string format: uuid
parent_thread_id
required
string format: uuid
parent_post_id
required
One of:
string format: uuid
content
required
string format: quill-delta
created_at
required
string format: date-time
secret_identity
required

The public-facing identity associated with the contribution.

object
name
required
string
avatar
required
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri-reference
user_identity
required
One of:
object
name
required
One of:
string
avatar
required
One of:
string format: uri-reference
new
required
boolean
own
required
boolean
friend
required
boolean
total_comments_amount
required
number
new_comments_amount
required
number
tags
required

Types of tags associated to a contribution.

object
whisper_tags
required
Array<string>
index_tags
required
Array<string>
category_tags
required
Array<string>
content_warnings
required
Array<string>
comments
required

A map from post_id to its comments.

object
key
additional properties
Array<object>
object
id
required
string format: uuid
parent_post_id
required
string format: uuid
parent_comment_id
required
One of:
string format: uuid
chain_parent_id
required
One of:
string format: uuid
content
required
string format: quill-delta
secret_identity
required

The public-facing identity associated with the comment.

object
name
required
string
avatar
required
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri-reference
user_identity
required
One of:
object
name
required
One of:
string
avatar
required
One of:
string format: uri-reference
created_at
required
string format: date-time
own
required
boolean
new
required
boolean
friend
required
boolean
id
required
string format: uuid
parent_board_slug
required
string
parent_board_id
required
string
parent_realm_slug
required
string
parent_realm_id
required
string
starter
required

The contribution that starts the thread.

object
id
required
string format: uuid
parent_thread_id
required
string format: uuid
parent_post_id
required
One of:
string format: uuid
content
required
string format: quill-delta
created_at
required
string format: date-time
secret_identity
required

The public-facing identity associated with the contribution.

object
name
required
string
avatar
required
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri-reference
user_identity
required
One of:
object
name
required
One of:
string
avatar
required
One of:
string format: uri-reference
new
required
boolean
own
required
boolean
friend
required
boolean
total_comments_amount
required
number
new_comments_amount
required
number
tags
required

Types of tags associated to a contribution.

object
whisper_tags
required
Array<string>
index_tags
required
Array<string>
category_tags
required
Array<string>
content_warnings
required
Array<string>
default_view
required
string
Allowed values: thread gallery timeline
new
required

Whether the thread is new. False when the user is logged out.

boolean
muted
required

Whether the thread is muted. False when the user is logged out.

boolean
hidden
required

Whether the thread is hidden. False when the user is logged out.

boolean
starred
required

Whether the thread is starred.

boolean
new_posts_amount
required
number
new_comments_amount
required
number
total_comments_amount
required
number
total_posts_amount
required
number
direct_threads_amount
required
number
last_activity_at
required
string format: date-time
Examples

A thread with a comments thread with nested comments.

{
  "id": "8b2646af-2778-487e-8e44-7ae530c2549c",
  "parent_board_slug": "gore",
  "parent_board_id": "c6d3d10e-8e49-4d73-b28a-9d652b41beec",
  "parent_realm_slug": "twisted-minds",
  "parent_realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
  "starter": {
    "id": "ff9f2ae2-a254-4069-9791-3ac5e6dff5bb",
    "parent_thread_id": "8b2646af-2778-487e-8e44-7ae530c2549c",
    "parent_post_id": null,
    "created_at": "2020-09-25T05:42:00.00Z",
    "content": "[{\"insert\":\"Remember to be excellent to each other and only be mean to fictional characters!\"}]",
    "secret_identity": {
      "name": "GoreMaster5000",
      "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fc26e8ce9-a547-4ff4-9486-7a2faca4d873%2F6518df53-2031-4ac5-8d75-57a0051ed924?alt=media&token=23df54b7-297c-42ff-a0ea-b9862c9814f8",
      "color": "red",
      "accessory": null
    },
    "user_identity": null,
    "friend": false,
    "own": false,
    "new": false,
    "tags": {
      "whisper_tags": [
        "An announcement from your headmaster!"
      ],
      "index_tags": [],
      "category_tags": [],
      "content_warnings": []
    },
    "total_comments_amount": 2,
    "new_comments_amount": 0
  },
  "posts": [
    {
      "id": "ff9f2ae2-a254-4069-9791-3ac5e6dff5bb",
      "parent_thread_id": "8b2646af-2778-487e-8e44-7ae530c2549c",
      "parent_post_id": null,
      "created_at": "2020-09-25T05:42:00.00Z",
      "content": "[{\"insert\":\"Remember to be excellent to each other and only be mean to fictional characters!\"}]",
      "secret_identity": {
        "name": "GoreMaster5000",
        "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fc26e8ce9-a547-4ff4-9486-7a2faca4d873%2F6518df53-2031-4ac5-8d75-57a0051ed924?alt=media&token=23df54b7-297c-42ff-a0ea-b9862c9814f8",
        "color": "red",
        "accessory": null
      },
      "user_identity": null,
      "friend": false,
      "own": false,
      "new": false,
      "tags": {
        "whisper_tags": [
          "An announcement from your headmaster!"
        ],
        "index_tags": [],
        "category_tags": [],
        "content_warnings": []
      },
      "total_comments_amount": 2,
      "new_comments_amount": 0
    }
  ],
  "comments": {
    "ff9f2ae2-a254-4069-9791-3ac5e6dff5bb": [
      {
        "id": "d3c21e0c-7ab9-4cb6-b1ed-1b7e558ba375",
        "parent_comment_id": null,
        "chain_parent_id": null,
        "parent_post_id": "ff9f2ae2-a254-4069-9791-3ac5e6dff5bb",
        "created_at": "2020-10-02T05:43:00.00Z",
        "content": "[{\"insert\":\"But can we be mean to you?\"}]",
        "secret_identity": {
          "name": "DragonFucker",
          "avatar": "https://pbs.twimg.com/profile_images/473496567366705152/JyHRKG7g.jpeg",
          "color": null,
          "accessory": null
        },
        "user_identity": null,
        "friend": false,
        "own": false,
        "new": false
      },
      {
        "id": "146d4087-e11e-4912-9d67-93065b9a0c78",
        "parent_comment_id": "d3c21e0c-7ab9-4cb6-b1ed-1b7e558ba375",
        "chain_parent_id": null,
        "parent_post_id": "ff9f2ae2-a254-4069-9791-3ac5e6dff5bb",
        "created_at": "2020-10-04T05:44:00.00Z",
        "content": "[{\"insert\":\"BobaNitro users can be mean to the webmaster once a month.\"}]",
        "secret_identity": {
          "name": "GoreMaster5000",
          "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fc26e8ce9-a547-4ff4-9486-7a2faca4d873%2F6518df53-2031-4ac5-8d75-57a0051ed924?alt=media&token=23df54b7-297c-42ff-a0ea-b9862c9814f8",
          "color": "red",
          "accessory": null
        },
        "user_identity": null,
        "friend": false,
        "own": false,
        "new": false
      }
    ]
  },
  "default_view": "thread",
  "muted": false,
  "hidden": false,
  "starred": false,
  "new": false,
  "last_activity_at": "2020-10-04T05:44:00.00Z",
  "new_posts_amount": 0,
  "new_comments_amount": 0,
  "total_comments_amount": 2,
  "total_posts_amount": 1,
  "direct_threads_amount": 0
}

401

Section titled “401 ”

User was not found and thread requires authentication.

Generic response object

object
message
string
Examples

No authentication token given.

{
  "message": "No authenticated user found."
}

403

Section titled “403 ”

User is not authorized to access thread.

Generic response object

object
message
string
Examples

User does not have required permissions to access thread.

{
  "message": "User does not have required permissions to access thread."
}

404

Section titled “404 ”

The specified thread could not be found.

Generic response object

object
message
string
Examples

Thread not found.

{
  "message": "The thread with id 29d1b2da-3289-454a-9089-2ed47db4967b was not found."
}