Список веток

Метод и конечная точка

GET /chat.getThreadsList

Описание

Возвращает список веток (threads) в указанной комнате. Поддерживает фильтрацию по типу и пагинацию.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
rid	да	string	Идентификатор комнаты
type	нет	string	Тип веток: following, unread, all
text	нет	string	Текст для поиска
offset	нет	number	Смещение для пагинации
count	нет	number	Количество результатов на страницу
sort	нет	string	Поле для сортировки
fields	нет	string	JSON-строка с полями для включения
query	нет	string	JSON-строка с условиями фильтрации

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.getThreadsList?rid=<ROOM_ID>&type=all&offset=0&count=20' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <ROOM_ID> — идентификатор комнаты.

Ответ

200 — Successfully get thread list — Список веток. Пример вывода:

{
  "success": true,
  "count": 5,
  "offset": 0,
  "total": 5,
  "threads": [
    {
      "_id": "thread_123456",
      "rid": "GENERAL",
      "msg": "Thread discussion",
      "tcount": 3,
      "ts": "2026-06-24T10:00:00.000Z"
    }
  ]
}