Для разработчиков

Список сотрудников

GET/users
users:read

Все сотрудники пространства, кроме удалённых. Приостановленные приходят вместе с остальными и отличаются полем suspended.

Боты в пространстве — тоже сотрудники и приходят в общем списке с bot: true. Но из выдачи по query они исключены: чтобы найти бота по имени, перебирайте страницы без поискового запроса.

Мульти-гостю метод отдаёт не всё пространство, а тех, кого он видит в интерфейсе: его самого, участников общих с ним чатов вместе с ботами и публичных ботов. Треды и архивные чаты общими не считаются.

Почта и телефон приходят null, если в пространстве выключен показ персональных данных, а вызывающий не администратор. Мульти-гостю они всегда приходят null.

Поиск по query может не уложиться по времени: тогда метод отвечает 504 с кодом timeout, и запрос стоит сузить.

Карточку одного сотрудника отдаёт GETИнформация о сотруднике, свою — GETСвой профиль.

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

query
string
Поисковая фраза для фильтрации результатов. Поиск работает по полям: first_name (имя), last_name (фамилия), email (электронная почта), phone_number (телефон) и nickname (никнейм).
Пример:Олег
limit
integer, (int32)
Количество возвращаемых сущностей за один запрос. Целое число вне допустимых значений заменяется ближайшей границей.
Пример:1
По умолчанию:
50
Диапазон:
1 — 50
cursor
string
Курсор для пагинации (из meta.paginate.next_page или meta.paginate.prev_page)
Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор пользователя
Пример:12
first_name
nullablestring
*
Имя. Возвращается null, пока приглашённый сотрудник не завершил регистрацию (invite_status со значением sent).
Пример:Олег
Длина:
<= 255 символов
last_name
nullablestring
*
Фамилия. Если не заполнена, возвращается null или пустая строка.
Пример:Петров
Длина:
<= 255 символов
nickname
string
*
Имя пользователя
Пример:olegpetrov
Длина:
<= 255 символов
email
nullablestring
*
Электронная почта. В чужой карточке приходит null, если у вызывающего нет права видеть персональные данные: у владельца пространства и администратора оно есть всегда, у сотрудника и бота — только когда в пространстве включён показ персональных данных, у гостя и мульти-гостя — никогда. В своей карточке поле приходит всегда.
Пример:olegp@example.com
Длина:
<= 255 символов
phone_number
nullablestring
*
Телефон. В чужой карточке приходит null, если у вызывающего нет права видеть персональные данные: у владельца пространства и администратора оно есть всегда, у сотрудника и бота — только когда в пространстве включён показ персональных данных, у гостя и мульти-гостя — никогда. В своей карточке поле приходит всегда.
Пример:+79001234567
Длина:
<= 255 символов
department
nullablestring
*
Департамент. Если не указан, возвращается null или пустая строка.
Пример:Продукт
Длина:
<= 255 символов
title
nullablestring
*
Должность. Если не указана, возвращается null или пустая строка.
Пример:CIO
role
string
*
Уровень доступа
Возможные значения
Пример:admin
suspended
boolean
*
Деактивация пользователя
Пример:false
invite_status
string
*
Статус приглашения
Возможные значения
Пример:confirmed
inviter_id
nullableinteger, (int32)
*
Идентификатор сотрудника, который пригласил данного сотрудника. Возвращает null, если сотрудник зарегистрировался самостоятельно или если пригласивший сотрудник был удалён.
Пример:185
list_tags[]
array of strings
*
Массив тегов, привязанных к сотруднику. Мульти-гостю в чужой карточке приходит пустым.
Пример:["Product","Design"]
custom_properties[]
array of objects
*
Дополнительные поля сотрудника
id
integer, (int32)
*
Идентификатор поля
Пример:1678
name
string
*
Название поля
Пример:Город
Длина:
<= 32 символов
data_type
string
*
Тип поля
Возможные значения
Пример:string
value
nullablestring
*
Значение. Возвращается null, если поле не заполнено. Число передаётся строкой, дата — в формате ISO 8601.
Пример:Санкт-Петербург
Длина:
<= 768 символов
user_status
nullableobject
*
Статус. null, если у сотрудника не установлен статус.
emoji
string
*
Emoji символ статуса
Пример:🎮
title
string
*
Текст статуса
Пример:Очень занят
Длина:
<= 50 символов
expires_at
nullablestring, (date-time)
*
Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если срок не задан — такой статус не сбрасывается автоматически.
Пример:2024-04-08T10:00:00.000Z
is_away
boolean
*
Режим «Нет на месте»
Пример:false
away_message
nullableobject
*
Сообщение при режиме «Нет на месте». Отображается в профиле пользователя, а также при отправке ему личного сообщения или упоминании в чате. null, если текст не задан.
text
string
*
Текст сообщения
Пример:Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov.
Длина:
<= 1024 символов
bot
boolean
*
Является ботом
Пример:false
sso
boolean
*
Использует ли пользователь SSO
Пример:false
created_at
string, (date-time)
*
Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2020-06-08T09:32:57.000Z
last_activity_at
nullablestring, (date-time)
*
Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если сотрудник ещё ни разу не заходил в Пачку — в этом случае invite_status возвращает sent.
Пример:2025-01-20T13:40:07.000Z
time_zone
nullablestring
*
Часовой пояс пользователя. null, если сотрудник не задал личный часовой пояс — тогда применяется часовой пояс компании.
Пример:Europe/Moscow
Длина:
<= 32 символов
image_url
nullablestring
*
Ссылка на скачивание аватарки пользователя. null, если аватарка не загружена.
Пример:https://app.pachca.com/users/12/photo.jpg
meta
object
*
Метаданные пагинации
paginate
object
*
Вспомогательная информация
next_page
string
*
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
prev_page
string
Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.
Пример:eyJxZCO2MiwiZGlyIjoiYXNjIn0
has_next
boolean
Есть ли ещё данные на следующей странице. На последней странице — false.
Пример:true
has_prev
boolean
Есть ли ещё данные на предыдущей странице. На первом запросе без курсора — false.
Пример:false
Список сотрудников
# Добавьте --all для автоматической пагинацииpachca users list \  --query=Олег \  --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    }  }}