Публичный Web API: Получение списка пользователей

Запрос

POST /pub/v1/user/list

Тело запроса (body)

Тело запроса принимает ресурс Получение списка пользователей — Request. Содержит следующие доступные для записи свойства:

{
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "string"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Свойства

Имя	Тип	Описание	Дополнительно
filter	object	Фильтрация	Опциональное
filter.<key>	map of object		Опциональное
from	int64	Начальный индекс возвращаемых элементов (offset)	Опциональное
ids[]	array of string	Фильтрация по идентификаторам	Опциональное
size	int64	Количество возвращаемых элементов	Опциональное
sortExpressions[]	array	Правила сортировки	Опциональное
sortExpressions[].ascending	boolean	Признак сортировки по возрастанию	Опциональное
sortExpressions[].field	string	Поле сортировки	Опциональное

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP:

HTTP-статус	Описание	Модель ответа
200	OK Модель списка пользователей	Модель списка пользователей (Получение списка пользователей)