Skip to main content

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

Описание​

Эндпоинт GET /users извлекает информацию о пользователях, предоставляя гибкие возможности для фильтрации, сортировки и пагинации.

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

ПараметрОписаниеПримерПо умолчанию
limit (целое число)Максимальное количество результатов для возврата.202147483647
offset (целое число)Количество результатов, которые нужно пропустить.00
sort (строка)Критерии сортировки, указывающие поле и направление.id,ascid,asc
q (строка)Быстрый поиск по всем текстовым полям.John
id (строка)Фильтрация по конкретным ID пользователей.in:5cc08a1a-519f-4ac8-9e23-855240d0c20f
firstName (строка)Фильтрация по имени пользователя.John
lastName (строка)Фильтрация по фамилии пользователя.Fox
role (строка)Фильтрация по роли пользователя (например, USER, ADMIN).in:USER
status (строка)Фильтрация по статусу пользователя (например, ACTIVE, INACTIVE).in:ACTIVE
email (строка)Фильтрация по адресу электронной почты.[email protected]
locationId (строка)Фильтрация по конкретным ID местоположений.in:99b770c0-2396-43d3-b109-85a9d73df7b1
tags (строка)Фильтрация по тегам.in:tag1,tag2

Пример запроса​

GET /users?limit=20&offset=0&sort=firstName,asc&role=in:USER&status=in:ACTIVE
Authorization: Bearer {your_access_token}

Пример успешного ответа​

Тело ответа:​

{
  "data": [
    {
      "id": "be63c536-6cf3-4866-8970-37a956e3f403",
      "firstName": "John",
      "middleName": "Lee",
      "lastName": "Fox",
      "employeeNo": "1234",
      "employeePin": "4321",
      "email": "[email protected]",
      "phone": "80291110099",
      "language": "ru",
      "role": "ADMIN",
      "status": "ACTIVE",
      "photoId": "a7c6f740-2a42-449c-a03b-b8d36aa4709a",
      "locationIds": [
        "99b770c0-2396-43d3-b109-85a9d73df7b1",
        "e1dfeaba-4318-4411-be91-f8af5214dd02"
      ],
      "tags": [
        "tag1",
        "tag2"
      ],
      "userLinked": true
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "property": "role",
        "value": "USER"
      },
      {
        "property": "firstName",
        "value": "John"
      }
    ]
  }
}

Пример ошибки​

Внутренняя ошибка сервера​

  • Код: 500 Internal Server Error
  • Тело ответа: 
    {
      "message": "internal server error",
      "code": "internal.server.error",
      "timestamp": "2023-03-07T05:57:59.315Z"
    }
  • Описание: Произошла непредвиденная ошибка на сервере.

Резюме​

Эндпоинт GET /users предоставляет возможность запроса информации о пользователях с возможностью фильтрации, сортировки и пагинации. Это позволяет настроить ответы под конкретные потребности. Ошибки, такие как проблемы на сервере, должны быть обработаны должным образом для обеспечения бесперебойной работы системы.