Метод возвращает список пользователей.

Адрес/v1.0/users
ТипGET
LoginТребуется 

Входные параметры

ПараметрОбязательностьОписаниеВозможные значения

direction

Опционален

Направление сортировки.

По умолчанию используется сортировка asc

  • asc — сортировка от меньшего к большему;
  • desc — сортировка от большего к меньшему

limit

Опционален

Максимальное количество записей, которые можно получить.

По умолчанию равен 100

От 1 до 100 включительно

offset

Опционален

Смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей.

Записи нумеруются с 0


archived

Опционален

Фильтрация на архивные пользователей.

По умолчанию в запросе возвращаются все пользователи

  • true — вернутся архивные пользователи;
  • false — вернутся не архивные пользователи
Пример запроса
https://station.guardant.ru/v1.0/users?direction=desc&limit=1&offset=5&archived=false

Ответ

Возвращает массив users:

Пример результата запроса
{
  "users": [
  {
    "_id": 10026,
    "confirmed": true,
    "email": "bob@mycompany.com",
    "status": true,
    "userdetails": {
       "_id": 10027,
       "firstname": "Bob",
       "lastname": "Doe",
       "lastvisitdate": 0,
       "archived": false,
       "archivationdate: 0,
       "role": {
          "_id": 5,
         "createorders": false,
         "createproducts": false,
         "createusers": false,
         "manageprotect": true,
         "nameeng": "Developer",
         "namerus": "Разработчик"
       },
      "settings": {
       "language": 0
     }
}}]}
  • No labels