/api/v1/chat/room/{id}

Get a chat room with all its messages

chatgetApiV1ChatRoomById

Parameters

1 path · 1 query

2 total

Path · 1

idstringRequired

Chat room public id (cas__chat_room.external_id), 24 chars.

Length: 24–24

Query · 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

Request

GET /api/v1/chat/room/{id}

get

curl -X GET "https://api.bizkithub.com/api/v1/chat/room/ZUiVZuKwAaXNoT4nGUbnKR75?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "state": "ok",
  "room": {
    "id": "ZUiVZuKwAaXNoT4nGUbnKR75",
    "title": "example_title",
    "isMarkedProblematic": false,
    "hasProblematicMessage": false,
    "insertedDate": "example_insertedDate",
    "updatedDate": "example_updatedDate",
    "metadata": {}
  },
  "messages": [
    {
      "id": "example_id",
      "content": "example_content",
      "isMarkedProblematic": false,
      "insertedDate": "example_insertedDate",
      "metadata": {}
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key