/api/v1/chat/room

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

chatgetApiV1ChatRoom

Parameters

8 query

8 total

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

kindstring | string | string

sourcestring

Length: 0–32

externalUserRefstring

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

Length: 0–64

contactExternalIdstring

Filter to threads owned by this shop__contact.external_id.

Length: 16–16

qstring

ILIKE filter against title.

Length: 0–200

limitstring

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

offsetstring

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

Request

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"

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key