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

Метод и конечная точка

GET /users.list

Описание

Возвращает список всех пользователей системы. Результат ограничен тем, что имеет право просматривать вызывающий пользователь.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
offset	нет	number	Смещение для пагинации
count	нет	number	Количество результатов на страницу
sort	нет	string	Поле для сортировки
query	нет	string	JSON-строка с условиями фильтрации
fields	нет	string	JSON-строка с полями для включения

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.list?offset=0&count=20' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя.

Ответ

200 — List of users — Список пользователей. Пример вывода:

{
  "success": true,
  "count": 20,
  "offset": 0,
  "total": 150,
  "users": [
    {
      "_id": "7w9BMr9r78W4RNe8x",
      "name": "John Doe",
      "username": "john.doe",
      "status": "online",
      "active": true
    }
  ]
}