Список участников чата

Метод для получения актуального списка участников чата.

get /chats/{id}/members получение актуального списка участников чата
Запрос
role string Роль в чате: all (по умолчанию, любая), owner (создатель), admin (админ), editor (редактор), member (участник/подписчик)
limit integer Количество возвращаемых сущностей за один запрос (по умолчанию 50, максимум 50)
cursor string Курсор для пагинации (из meta.paginate.next_page)
Ответ
meta object Вспомогательная информация
paginate object Информация о пагинации
next_page string Курсор пагинации следующей страницы
data array of objects Массив списка участников
id integer Идентификатор созданного пользователя
first_name string Имя
last_name string Фамилия
nickname string Имя пользователя
email string Электронная почта
phone_number string Телефон
department string Департамент
title string Должность
role string Уровень доступа: admin (администратор), user (сотрудник), multi_guest (мульти-гость)
suspended boolean Приостановка доступа
invite_status string Статус пришлашения: confirmed (принято), sent (отправлено)
list_tags array of strings Массив тегов, привязанных к сотруднику
custom_properties array of objects Дополнительные поля сотрудника
id integer Идентификатор поля
name string Название поля
data_type string Тип поля (string, number, date или link)
value string Значение
user_status object или null Статус. Возвращается как null, если статус не установлен.
emoji string Emoji символ статуса
title string Текст статуса
expires_at string или null Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. Возвращается как null, если срок не установлен.
bot boolean Тип: пользователь (false) или бот (true)
created_at string Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
last_activity_at string Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
time_zone string Часовой пояс пользователя
image_url string или null Ссылка на скачивание аватарки пользователя
Возможные ошибки запроса (errors code)
not_found Не удалось найти
exclusion Поле имеет недопустимое значение
Идентификатор чата, список участников которого необходимо получить, и другие параметры передаются в URL (например, /chats/334/members?role=admin&limit=1)
{
  "meta": {
    "paginate": {
      "next_page": "eyJpZCI6MiwiZGlyIjoiYXNjIn0"
    }
  }
  "data": [
    {
      "id": 12,
      "first_name": "Олег",
      "last_name": "Петров",
      "nickname": "olegpetrov",
      "email": "olegp@example.com",
      "phone_number": "",
      "department": "Продукт",
      "title": "CIO",
      "role": "admin",
      "suspended": false,
      "invite_status": "confirmed",
      "list_tags": [
        "Product",
        "Design"
      ],
      "custom_properties": [
        {
          "id": 1678,
          "name": "Город",
          "data_type": "string",
          "value": "Санкт-Петербург"
        }
      ],
      "user_status": null,
      "bot": false,
      "created_at": "2020-06-08T09:10:11.000Z",
      "last_activity_at": "2025-01-20T13:40:07.000Z",
      "time_zone": "Europe/Moscow",
      "image_url": null
    }
  ]
}