Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Chat

List Chats

Returns a paginated list of chats with optional filters. Org-level API keys return all chats; user-level keys return only chats accessible to the user.

get/chats

Query parameters

filter[external_id]string

Filter by external ID (exact match)

filter[type]'chat' | 'email'

Filter by chat type (chat or email)

filter[title]string

Filter by title (case-insensitive partial match)

filter[participant_name]string

Filter by participant name (case-insensitive partial match)

filter[scorecard_id]string[]

Filter by scorecard UUID(s) — returns chats evaluated with any of the given scorecards

filter[user_id]string[]

Filter by user UUID(s)

filter[team_id]string[]

Filter by team UUID(s)

from_date_timestring date-time

Start of date range filter (ISO 8601 format)

to_date_timestring date-time

End of date range filter (ISO 8601 format)

exclude_transcriptboolean

If true, omit transcript data from response to reduce payload size

pageinteger

Page number for pagination (starts from 1)

sizeinteger

Number of items per page (min 1, max 50)

Response

Chats successfully returned

Example response

{
  "data": [
    {
      "id": "chat-uuid-123",
      "externalId": "slack-channel-xyz",
      "applicationName": "slack",
      "title": "Sales Q1 Planning",
      "type": "chat",
      "userId": "user-uuid-456",
      "teamId": "team-uuid-789",
      "dateStart": "2024-03-18T09:00:00Z",
      "createdAt": "2024-03-18T09:00:00Z",
      "participants": [],
      "transcript": []
    }
  ],
  "meta": {
    "totalRecords": 1
  }
}