API - Пользователи
Внимание
Для выполнения запроса к API необходима дополнительная авторизация.
Используйте в запросе заголовок Authorization: Bearer <персональный токен>.
Получить список пользователей по фильтру
POST /api/public/pl/v2/users/filter
Запрос возвращает список найденных пользователей.
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
|---|---|---|---|---|
| page | integer | нет | null | Номер страницы |
| perPage | integer | нет | null | Количество записей на одну страницу. Если -1 - будут возвращены все объекты |
| search | string | нет | null | Строка поиска |
| sortCol | string | нет | null | Название поля, по которому выполняется сортировка |
| sortDir | string | нет | null | Направление сортировки (asc/desc) |
| skip | integer | нет | null | Количество записей, которое требуется пропустить |
| fieldMask | string [] | нет | null | Маска полей |
Тело запроса
{
"isEnabled": true,
"isActive": true,
"emails": [
"admin@monq.ru"
],
"ids": [
1
]
}
Поля тела запроса
| Название поля | Обязательно | Тип поля | По умолчанию | Описание |
|---|---|---|---|---|
| isEnabled | нет | boolean | null | Выборка только по активным или деактивированным пользователям |
| isActive | нет | boolean | null | Выборка только по пользователя которые сейчас в сети |
| emails | нет | string [] | null | Список электронных адресов пользователей |
| ids | нет | integer [] | null | Список идентификаторов пользователей |
Коды ответов
| Код ответа | Описание |
|---|---|
| 200 | Запрос выполнен успешно |
| 400 | Неверная модель данных в теле запроса |
| 401 | Не удалось выполнить авторизацию пользователя |
| 403 | Недостаточно прав для получения списка пользователей |
Модель ответа
[
{
"id": 0,
"enabled": true,
"email": "string",
"fullName": "string",
"lastActivity": "2025-11-13T07:09:51.033Z",
"isAdSynced": true,
"workGroups": [
{
"workGroup": {
"id": 0,
"name": "string",
"workGroupKey": "string",
"description": "string",
"type": "Unknown"
},
"roles": [
{
"id": 0,
"name": "string"
}
]
}
]
}
]
Получить список групп пользователей по фильтру
POST /api/public/pl/v2/user-groups/filter
Запрос возвращает список групп пользователей.
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
|---|---|---|---|---|
| page | integer | нет | null | Номер страницы |
| perPage | integer | нет | null | Количество записей на одну страницу. Если -1 - будут возвращены все объекты |
| search | string | нет | null | Строка поиска |
| sortCol | string | нет | null | Название поля, по которому выполняется сортировка |
| sortDir | string | нет | null | Направление сортировки (asc/desc) |
| skip | integer | нет | null | Количество записей, которое требуется пропустить |
| fieldMask | string [] | нет | null | Маска полей |
Тело запроса
{
"ids": [
0
],
"names": [
"string"
]
}
Поля тела запроса
| Название поля | Обязательно | Тип поля | По умолчанию | Описание |
|---|---|---|---|---|
| ids | нет | integer [] | null | Список идентификаторов групп пользователей |
| names | нет | string [] | null | Список названий групп пользователей |
Коды ответов
| Код ответа | Описание |
|---|---|
| 200 | Запрос выполнен успешно |
| 400 | Неверная модель данных в теле запроса |
| 401 | Не удалось выполнить авторизацию пользователя |
| 403 | Недостаточно прав для получения списка групп пользователей |
Модель ответа
[
{
"id": 0,
"name": "string",
"description": "string",
"isAdSynced": true,
"workGroups": [
{
"workGroup": {
"id": 0,
"name": "string",
"workGroupKey": "string",
"description": "string",
"type": "Unknown"
},
"roles": [
{
"id": 0,
"name": "string"
}
]
}
],
"members": [
{
"id": 0,
"fullName": "string",
"enabled": true
}
]
}
]