chat

List conversations

Lists the caller's own conversations: a signed-in user's, or a guest's by session id. A caller with neither gets an empty list.

get/api/chat/conversations

Request

  • Base URL: https://localhost:8080
  • URL: https://localhost:8080/api/chat/conversations
  • Auth: none declared

Query parameters

isPublicboolean
Example:true

Filter by public/private status

source'web' | 'word_plugin' | 'slack' | 'docs'
Example:word_plugin

Filter by conversation source platform

limitnumber
Example:50

Maximum number of results

offsetnumber

Number of results to skip (for pagination)

Response

Conversations retrieved successfully

totalnumber required

Total number of conversations

limitnumber required

Limit used

offsetnumber required

Offset used

Example response

{
  "conversations": [
    {
      "id": "uuid",
      "title": "What is the statute of limitations?",
      "source": "word_plugin",
      "isOwner": true,
      "lastMessageAt": "2024-01-01T00:00:00.000Z",
      "messageCount": 5,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "total": 100,
  "limit": 50
}

Changes

No recorded changes to this operation across all 1 revision of this API.