Метод для получения актуального списка сотрудников вашей компании.
Запрос
|
||
---|---|---|
per | integer | Количество возвращаемых сущностей за один запрос (по умолчанию 50, максимум 50) |
page | integer | Страница выборки (по умолчанию 1) |
query | string | Поисковая фраза для фильтрации результатов (поиск идет по полям first_name (имя), last_name (фамилия), email (электронная почта), phone_number (телефон) и nickname (никнейм)) |
Ответ
|
||
data | array of objects | Массив списка сотрудников |
id | integer | Идентификатор пользователя |
first_name | string | Имя |
last_name | string | Фамилия |
nickname | string | Имя пользователя |
string | Электронная почта | |
phone_number | string | Телефон |
department | string | Департамент |
title | string | Должность |
role | string | Уровень доступа: admin (администратор), user (сотрудник), multi_guest (мульти-гость) |
suspended | boolean | Деактивация пользователя. При значении true пользователь является деактивированным. |
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 |
time_zone | string | Часовой пояс пользователя |
image_url | string или null | Ссылка на скачивание аватарки пользователя |
Возможные ошибки запроса (errors code)
|
||
Описания ошибок отсутствуют |
{
"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",
"time_zone": "Europe/Moscow",
"image_url": null
},
{
"id": 13,
"first_name": "Сергей",
"last_name": "Кузнецов",
"nickname": "skuz",
"email": "sergkuzn@example.com",
"phone_number": "",
"department": "Разработка",
"title": "iOS Developer",
"role": "user",
"suspended": false,
"invite_status": "confirmed",
"list_tags": [
"Development",
"Android"
],
"custom_properties": [
{
"id": 1678,
"name": "Город",
"data_type": "string",
"value": "Москва"
}
],
"user_status": {
"emoji": "🎮",
"title": "Очень занят",
"expires_at": "2024-04-08T10:00:00.000Z"
},
"bot": false,
"created_at": "2020-06-08T09:31:17.000Z",
"time_zone": "Europe/Moscow",
"image_url": null
},
{
"id": 14,
"first_name": "Дмитрий",
"last_name": "Смирнов",
"nickname": "dsmir",
"email": "ds@example.com",
"phone_number": "",
"department": "Разработка",
"title": "Android Developer",
"role": "user",
"suspended": false,
"invite_status": "confirmed",
"list_tags": [
"Development",
"Frontend"
],
"custom_properties": [
{
"id": 1678,
"name": "Город",
"data_type": "string",
"value": "Санкт-Петербург"
}
],
"user_status": {
"emoji": "🚀",
"title": "Лечу",
"expires_at": null
},
"bot": false,
"created_at": "2020-06-08T09:32:57.000Z",
"time_zone": "Europe/Moscow",
"image_url": null
}
]
}