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

GET/chats/{id}/members

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

Владелец пространства может получить состав участников любого чата пространства. Администраторы и боты могут получить список участников только тех чатов, в которых состоят (или которые являются открытыми).

Параметры пути

Идентификатор чата

Пример:334

Параметры строки запроса

Роль в чате

Возможные значения

Пример:all

По умолчанию:

all

Количество возвращаемых сущностей за один запрос

Пример:1

По умолчанию:

50

Диапазон:

1 — 50

Курсор для пагинации (из meta.paginate.next_page или meta.paginate.prev_page)

Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Ответ

200OK

The request has succeeded.

Идентификатор пользователя

Пример:12

Имя. Возвращается null, пока приглашённый сотрудник не завершил регистрацию (invite_status со значением sent).

Пример:Олег

Длина:

<= 255 символов

Фамилия. Если не заполнена, возвращается null или пустая строка.

Пример:Петров

Длина:

<= 255 символов

Имя пользователя

Пример:olegpetrov

Длина:

<= 255 символов

Электронная почта. Возвращает null для ботов без права просмотра персональных данных, а также при запросе данных другого пользователя ботом, для которого скрыты персональные данные сотрудников.

Пример:olegp@example.com

Длина:

<= 255 символов

Телефон. Возвращает null для ботов без права просмотра персональных данных, а также при запросе данных другого пользователя ботом, для которого скрыты персональные данные сотрудников.

Пример:+79001234567

Длина:

<= 255 символов

Департамент. Если не указан, возвращается null или пустая строка.

Пример:Продукт

Длина:

<= 255 символов

Должность. Если не указана, возвращается null или пустая строка.

Пример:CIO

Уровень доступа

Возможные значения

Пример:admin

Деактивация пользователя

Пример:false

Статус приглашения

Возможные значения

Пример:confirmed

Идентификатор сотрудника, который пригласил данного сотрудника. Возвращает null, если сотрудник зарегистрировался самостоятельно или если пригласивший сотрудник был удалён.

Пример:185

Дополнительные поля сотрудника

Идентификатор поля

Пример:1678

Название поля

Пример:Город

Длина:

<= 32 символов

Тип поля

Возможные значения

Пример:string

Значение. Возвращается null, если поле не заполнено. Число передаётся строкой, дата — в формате ISO 8601.

Пример:Санкт-Петербург

Длина:

<= 768 символов

Статус. null, если у сотрудника не установлен статус.

Emoji символ статуса

Пример:🎮

Текст статуса

Пример:Очень занят

Длина:

<= 50 символов

Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если срок не задан — такой статус не сбрасывается автоматически.

Пример:2024-04-08T10:00:00.000Z

Режим «Нет на месте»

Пример:false

Сообщение при режиме «Нет на месте». Отображается в профиле пользователя, а также при отправке ему личного сообщения или упоминании в чате. null, если текст автоответа не задан.

Текст сообщения

Пример:Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov.

Длина:

<= 1024 символов

Является ботом

Пример:false

Использует ли пользователь SSO

Пример:false

Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ

Пример:2020-06-08T09:32:57.000Z

Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если сотрудник ещё ни разу не заходил в Пачку — в этом случае invite_status возвращает sent.

Пример:2025-01-20T13:40:07.000Z

Часовой пояс пользователя. null, если сотрудник не задал личный часовой пояс — тогда применяется часовой пояс компании.

Пример:Europe/Moscow

Длина:

<= 32 символов

Ссылка на скачивание аватарки пользователя. null, если аватарка не загружена.

Пример:https://app.pachca.com/users/12/photo.jpg

Метаданные пагинации

Вспомогательная информация

Курсор пагинации следующей страницы

Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3

Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.

Пример:eyJxZCO2MiwiZGlyIjoiYXNjIn0

Есть ли ещё данные на следующей странице. На последней странице — false.

Пример:true

Есть ли ещё данные на предыдущей странице. На первом запросе без курсора — false.

Пример:false

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

# Добавьте --all для автоматической пагинацииpachca members list 334 \  --role=all \  --limit=1 \  --json \  --token YOUR_ACCESS_TOKEN

Ответ 200

{  "data": [    {      "id": 12,      "first_name": "Олег",      "last_name": "Петров",      "nickname": "olegpetrov",      "email": "olegp@example.com",      "phone_number": "+79001234567",      "department": "Продукт",      "title": "CIO",      "role": "admin",      "suspended": false,      "invite_status": "confirmed",      "inviter_id": 185,      "list_tags": [        "Product",        "Design"      ],      "custom_properties": [        {          "id": 1678,          "name": "Город",          "data_type": "string",          "value": "Санкт-Петербург"        }      ],      "user_status": {        "emoji": "🎮",        "title": "Очень занят",        "expires_at": "2024-04-08T10:00:00.000Z",        "is_away": false,        "away_message": {          "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."        }      },      "bot": false,      "sso": false,      "created_at": "2020-06-08T09:32:57.000Z",      "last_activity_at": "2025-01-20T13:40:07.000Z",      "time_zone": "Europe/Moscow",      "image_url": "https://app.pachca.com/users/12/photo.jpg"    }  ],  "meta": {    "paginate": {      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3",      "prev_page": "eyJxZCO2MiwiZGlyIjoiYXNjIn0",      "has_next": true,      "has_prev": false    }  }}