Список пользователей

GET /core/users/

Описание

Этот эндпоинт возвращает список пользователей, зарегистрированных в системе. Каждая запись содержит детализированную информацию о пользователе, такую как имя, email, статус активности, роль и другие атрибуты. Эндпоинт предназначен для управления пользователями и анализа их данных.

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

Обязательные параметры:

Нет

Вспомогательные параметры:

sortBy — параметр для сортировки по указанному полю
sortOrder — порядок сортировки: ASC (по возрастанию) или DESC (по убыванию).
limit — ограничение на количество записей, возвращаемых в одном запросе.
page — номер страницы для постраничного вывода данных.

Пример:

GET /core/users/?sortBy=name&sortOrder=ASC&limit=20&page=1

Ответ

Возвращается в формате JSON и содержит следующие ключевые поля:

id - Уникальный идентификатор пользователя.
name - Имя пользователя.
surname - Фамилия пользователя.
email - Email-адрес пользователя.
image - URL аватара пользователя.
active - Статус активности пользователя (true / false).
roleId - Идентификатор роли пользователя.
role - Данные о роли пользователя (включая id и name).
createdAt - Дата и время создания пользователя.
updatedAt - Дата и время последнего обновления данных.

pagination - Информация о пагинации данных:
- limit - Лимит элементов на странице.
- offset - Смещение от начала списка.
- currentTotal - Количество элементов на текущей странице.
- total - Общее количество пользователей.
- page - Номер текущей страницы.

GET

/core/users/

При успешном запросе, ответ будет выглядеть так:

1{
2  "status": "success",
3  "payload": [
4    {
5      "id": 101,
6      "name": "Иван",
7      "surname": "Иванов",
8      "image": "/images/avatar.jpg",
9      "email": "ivanov@example.com",
10      "active": true,
11      "roleId": 3,
12      "createdAt": "2024-11-23T09:15:00.000Z",
13      "updatedAt": "2024-11-23T09:15:00.000Z",
14      "role": {
15        "id": 3,
16        "name": "Менеджер"
17      },
18      "canEdit": true
19    },
20    {
21      "id": 102,
22      "name": "Петр",
23      "surname": "Петров",
24      "image": "/images/avatar2.jpg",
25      "email": "petrov@example.com",
26      "active": false,
27      "roleId": 4,
28      "createdAt": "2024-11-23T10:00:00.000Z",
29      "updatedAt": "2024-11-23T10:30:00.000Z",
30      "role": {
31        "id": 4,
32        "name": "Администратор"
33      },
34      "canEdit": false
35    }
36  ],
37  "pagination": {
38    "limit": 20,
39    "offset": 0,
40    "currentTotal": 2,
41    "total": 100,
42    "page": 1
43  }
44}