Перейти к основному содержимому

Список пользователей (с пагинацией)

GET
/users

Контракт

Параметр
Значение
Разделusers
АвторизацияCookieAuth
Принимаетне требуется
Возвращаетapplication/json

Параметры

6 параметров

Имя
Где
Обязательный
Тип
Описание
inputqueryнетstringСтрока поиска по email или имени
group_idqueryнетstringФильтр по ID группы
countqueryдаintegerРазмер страницы
pagequeryдаintegerНомер страницы, начиная с 1
keyqueryдаstringПоле сортировки
orderqueryдаenum(asc, desc)Направление сортировки
  • "asc"

Ответы

4 ответов

Статус
Описание
Тип
200
Успешный ответobject
400
Некорректные параметры запросаobject
401
Не авторизованobject
500
Внутренняя ошибка сервераobject
  • {
      "cursor": {
        "count": 0,
        "currentPage": 0,
        "totalPages": 0,
        "totalRows": 0
      },
      "data": [
        {
          "agreementAccepted": true,
          "createdAt": "<string>",
          "deletedAt": "<string>",
          "email": "<string>",
          "group": {
            "createdAt": "<string>",
            "deletedAt": "<string>",
            "id": 0,
            "issuer": {},
            "issuerID": 0,
            "name": "<string>",
            "permissions": [
              {
                "value": 0
              }
            ],
            "updatedAt": "<string>",
            "users": [
              {}
            ]
          },
          "groupID": 0,
          "id": 0,
          "isActive": true,
          "isRequiredToSetPassword": true,
          "lastLogin": "<string>",
          "notificationsReadAt": "<string>",
          "passwordLength": 0,
          "realName": "<string>",
          "updatedAt": "<string>"
        }
      ]
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }