Список сотрудников
GET/users
Метод для получения актуального списка сотрудников вашей компании.
Параметры строки запроса
query
string
Поисковая фраза для фильтрации результатов. Поиск работает по полям:
first_name (имя), last_name (фамилия), email (электронная почта), phone_number (телефон) и nickname (никнейм).limit
integer, (int32)
Количество возвращаемых сущностей за один запрос
По умолчанию:
50Диапазон:
1 — 50cursor
string
Курсор для пагинации (из
meta.paginate.next_page)Ответ
200OK
The request has succeeded.
meta
object
Метаданные пагинации
paginate
object
Вспомогательная информация
next_page
string
Курсор пагинации следующей страницы
data[]
array of objects
*id
integer, (int32)
*Идентификатор пользователя
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, (int32)
*Идентификатор поля
name
string
*Название поля
data_type
string
*Тип поля
Возможные значения
stringСтроковое значение
numberЧисловое значение
dateДата
linkСсылка
value
string
*Значение
user_status
nullableobject
*Статус
emoji
string
*Emoji символ статуса
title
string
*Текст статуса
expires_at
nullablestring, (date-time)
*Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
bot
boolean
*Является ботом
sso
boolean
*Использует ли пользователь SSO
created_at
string, (date-time)
*Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
last_activity_at
string, (date-time)
*Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
time_zone
string
*Часовой пояс пользователя
image_url
nullablestring
*Ссылка на скачивание аватарки пользователя