Get

[POST] .../v1/chat/get

Returns a list of chats with filtering and pagination. Use this method to load the chat list visible to the current request user for inbox, channel, CRM, task or integration chat workflows. The response returns Chat records with participants, linked entity metadata, unread count and current-user state flags; public filters metadata documents the supported chat, participant, state and linked-entity filters and sort_orders supports name, last_message_date, last_update, created_user_id and id. The request body is required, limit and offset control pagination and access is resolved from chat participation or linked entity permissions by the persistent layer. Missing body, invalid filters, denied access to linked entity chats, translation or profile lookup failures and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of result items.
offset Int32 Optional Result set offset.
search String Optional Search by chat name.
sort_orders Array of ChatOrder Optional Sort array in the { column, direction } format. If omitted, sorting is not applied.

Filterable Fields

Field Type Description
archived bool Current user's archived chat flag filter.
chat_type string Chat type: Group or Individual.
closed bool Closed chat flag filter.
entity_bound bool Filter by whether the chat is linked to a business entity.
entity_type string Linked chat business entity type: Task, Lead, Deal or Ticket.
external_id string External chat ID for exact filtering.
id string Chat UUIDs.
name string
participant_entity_id int Participant entity ID filter.
participant_entity_type string Participant entity type filter: User, Client or ChatBot.
pinned bool Current user's pinned chat flag filter.

Sortable Fields

Field
created_user_id
id
last_message_date
last_update
name

Request Example

{
  "filters": [
    {
      "field": "participant_entity_type",
      "operator": "Equal",
      "value": "User"
    },
    {
      "field": "participant_entity_id",
      "operator": "Equal",
      "value": "42"
    }
  ],
  "sort_orders": [
    {
      "column": "last_message_date",
      "direction": "DESC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Chat Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": "8cdd646d-dbd0-45c0-8f5b-d90a9b000001",
      "chat_type": "Group",
      "name": "Purchase approval",
      "logo_url": null,
      "external_id": "purchase-approval",
      "last_message_id": "4b9727ec-a389-4274-95b6-069350000001",
      "last_message_date": 1767225600,
      "last_message_text": "Please review the supplier invoice.",
      "created_user_id": 42,
      "last_update": 1767225600,
      "closed": false,
      "closed_date": null,
      "participants": [
        {
          "entity_type": "User",
          "entity_id": 42,
          "role": "Staff",
          "name": "Alex Carter",
          "photo_url": null,
          "joined_date": 1767225000,
          "last_update": 1767225000
        }
      ],
      "entity_type": null,
      "entity_id": null,
      "unread_count": 3,
      "muted": false,
      "archived": false,
      "pinned": true
    }
  ],
  "next_offset": 50,
  "total": 1
}