Получение информации о пользователе

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

GET /users.info

Описание

Возвращает информацию о пользователе. Результат ограничен тем, что имеет право просматривать вызывающий пользователь. Необходимо указать либо userId, либо username.

Параметры

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

Название	Обязательный	Тип данных	Описание
userId	нет*	string	Идентификатор пользователя
username	нет*	string	Имя пользователя в формате firstname.lastname
includeUserRooms	нет	boolean	Включать ли комнаты пользователя в ответ

* Должен быть указан один из параметров: userId или username.

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.info?userId=<USER_ID>' \
  -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 — Information about a user — Информация о пользователе. Пример вывода:

{
  "success": true,
  "user": {
    "_id": "7w9BMr9r78W4RNe8x",
    "name": "John Doe",
    "username": "john.doe",
    "nickname": "JD",
    "emails": [
      {
        "address": "john.doe@example.com",
        "verified": true
      }
    ],
    "status": "online",
    "statusDefault": "online",
    "statusText": "Working on project",
    "bio": "Software Developer",
    "avatarOrigin": "upload",
    "avatarETag": "abc123",
    "roles": ["user"],
    "active": true,
    "_updatedAt": "2026-06-24T10:00:00.000Z"
  }
}