BizKitHub
DocsAPI ReferenceChat/api/v1/chat/room
getpostChatPublic API v1

/api/v1/chat/room

Returns rooms owned by the API key holder, newest activity first.

chatgetApiV1ChatRoom

Parameters

8 query

Query parameters

· 8
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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
kind"ai" | "internal" | "external"Optional
sourcestringOptional
Length: 0–32
Exampleexample_source
externalUserRefstringOptional

Partition rooms by end-user id (e.g. ChatSPC cuRefNo, anon-token).

Length: 0–64
Exampleexample_externalUserRef
contactExternalIdstringOptional

Filter to threads owned by this shop__contact.external_id.

Length: 16–16
Exampleexample_contactExternalId
qstringOptional

ILIKE filter against title.

Length: 0–200
Exampleexample_q
limitstringOptional

Maximum items (1–200, default 50). Sent as a query string.

Exampleexample_limit
offsetstringOptional

Number of items to skip (default 0). Sent as a query string.

Exampleexample_offset

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

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

Length: 24–24
ExampleZUiVZuKwAaXNoT4nGUbnKR75
kind"ai" | "internal" | "external"Required
titlestringRequired
sourcestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
modelstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
ownerContactExternalIdstring | nullRequired
One of 2:
Variant 1
string

16-char shop__contact.external_id of the logged-in customer who owns this thread. Null for anonymous threads and member-owned (internal) threads.

Variant 2
null
ownerContactNamestring | nullRequired
One of 2:
Variant 1
string

Display name of the owning contact (first_name + last_name, or company_name as fallback). Null when no owner is set or when the contact has no name fields filled.

Variant 2
null
externalUserRefstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
messageCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
totalTokensstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
lastMessageDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isMarkedProblematicbooleanRequired

True when the conversation is flagged as a problem case (toggleable).

hasProblematicMessagebooleanRequired

True when at least one message in the thread is marked problematic.

insertedDatestringRequired
updatedDatestringRequired
metadataobjectRequired
totalstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer

Response example

application/json
{
  "items": [
    {
      "id": "ZUiVZuKwAaXNoT4nGUbnKR75",
      "title": "example_title",
      "isMarkedProblematic": false,
      "hasProblematicMessage": false,
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate",
      "metadata": {}
    }
  ]
}

Request example

GET /api/v1/chat/room

get
curl -X GET "https://api.bizkithub.com/api/v1/chat/room?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&source=example_source&externalUserRef=example_externalUserRef&contactExternalId=example_contactExternalId&q=example_q&limit=example_limit&offset=example_offset" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key