Comments

Get thread

Changed on

This endpoint returns a thread by its ID. Corresponds to liveblocks.getThread.

get/rooms/{roomId}/threads/{threadId}

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/rooms/{roomId}/threads/{threadId}
  • Auth: none declared

Path parameters

roomIdstring required

ID of the room

Example:my-room-id
threadIdstring required

ID of the thread

Example:th_abc123

Response

Success. Returns requested thread.

type'thread' required
idstring required
roomIdstring required
createdAtstring date-time required
metadataThreadMetadata required

Custom metadata attached to a thread. Supports maximum 50 entries. Key length has a limit of 40 characters maximum. Value length has a limit of 4000 characters maximum for strings.

resolvedboolean required
visibility'public' | 'private' required
updatedAtstring date-time required

Example response

{
  "type": "thread",
  "id": "th_abc123",
  "roomId": "my-room-id",
  "comments": [
    {
      "type": "comment",
      "threadId": "th_abc123",
      "roomId": "my-room-id",
      "id": "cm_abc123",
      "userId": "alice",
      "createdAt": "2022-07-13T14:32:50.697Z",
      "body": {
        "version": 1,
        "content": []
      },
      "metadata": {},
      "reactions": [],
      "attachments": []
    }
  ],
  "createdAt": "2022-07-13T14:32:50.697Z",
  "updatedAt": "2022-07-13T14:32:50.697Z",
  "metadata": {
    "color": "blue"
  },
  "resolved": false,
  "visibility": "public"
}

Changes

  • e66e044110f9Revision changes
    • info

      added the required property to the response with the status

  • 77cd6a75b2b7Revision changes
    • info

      api operation id get-rooms-roomId-threads-threadId removed and replaced with get-thread

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value comment was removed for the status

    • info

      added 'propertyNames' constraint to the // response property for the status

    • info

      added 'propertyNames' constraint to the response property for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      the response required property // became not read-only for the status