Перейти к содержимому
Для разработчиков

Поиск сотрудников

GET/search/users
search:users

Метод для полнотекстового поиска сотрудников по имени, email, должности и другим полям.

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

query
string
Текст поискового запроса
Пример:Олег
limit
integer, (int32)
Количество возвращаемых результатов за один запрос
Пример:10
По умолчанию:
200
Диапазон:
<= 200
cursor
string
Курсор для пагинации (из meta.paginate.next_page)
Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9
sort
string
Сортировка результатов
Возможные значения
Пример:by_score
order
string
Направление сортировки
Возможные значения
Пример:desc
created_from
string, (date-time)
Фильтр по дате создания (от)
Пример:2025-01-01T00:00:00.000Z
created_to
string, (date-time)
Фильтр по дате создания (до)
Пример:2025-02-01T00:00:00.000Z
company_roles[]
array of strings
Фильтр по ролям сотрудников
Возможные значения
Пример:["admin","user"]

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор пользователя
Пример:12
first_name
string
*
Имя
Пример:Олег
last_name
string
*
Фамилия
Пример:Петров
nickname
string
*
Имя пользователя
Пример:
email
string
*
Электронная почта
Пример:olegp@example.com
phone_number
string
*
Телефон
Пример:
department
string
*
Департамент
Пример:Продукт
title
string
*
Должность
Пример:CIO
role
string
*
Уровень доступа
Возможные значения
Пример:admin
suspended
boolean
*
Деактивация пользователя
Пример:false
invite_status
string
*
Статус приглашения
Возможные значения
Пример:confirmed
list_tags[]
array of strings
*
Массив тегов, привязанных к сотруднику
Пример:["Product","Design"]
custom_properties[]
array of objects
*
Дополнительные поля сотрудника
id
integer, (int32)
*
Идентификатор поля
Пример:1678
name
string
*
Название поля
Пример:Город
data_type
string
*
Тип поля
Возможные значения
Пример:string
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
Пример:2024-04-08T10:00:00.000Z
is_away
boolean
*
Режим «Нет на месте»
Пример:false
away_message
nullableobject
*
Сообщение при режиме «Нет на месте». Отображается в профиле пользователя, а также при отправке ему личного сообщения или упоминании в чате.
text
string
*
Текст сообщения
Пример:Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov.
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
string, (date-time)
*
Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2025-01-20T13:40:07.000Z
time_zone
string
*
Часовой пояс пользователя
Пример:Europe/Moscow
image_url
nullablestring
*
Ссылка на скачивание аватарки пользователя
Пример:https://app.pachca.com/users/12/photo.jpg
meta
object
*
Мета-информация для пагинации поисковых результатов
total
integer, (int32)
*
Общее количество найденных результатов
Пример:42
paginate
object
*
Вспомогательная информация
next_page
string
*
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
Поиск сотрудников
Ответ 200