Skip to main content

Информация о команде

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

GET /teams/{teamId}

Описание​

Возвращает полную информацию о команде по её идентификатору.

Параметры пути​

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

НазваниеОбязательныйТип данныхОписание
teamIdдаstringИдентификатор команды

Запрос​

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/teams/<TEAM_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 — Teams — Список команд. Пример вывода:

{
  "status": "success",
  "data": {
    "_id": "team123abc456def",
    "name": "Моя команда",
    "description": "Описание команды",
    "type": "team",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T14:45:00.000Z",
    "createdBy": {
      "_id": "user123",
      "username": "john.doe",
      "name": "John Doe"
    },
    "members": [
      {
        "_id": "user123",
        "username": "john.doe",
        "name": "John Doe",
        "role": "owner"
      },
      {
        "_id": "user456",
        "username": "jane.smith",
        "name": "Jane Smith",
        "role": "member"
      }
    ],
    "channels": [
      {
        "_id": "channel789",
        "name": "general"
      }
    ],
    "memberCount": 5,
    "channelCount": 3
  }
}

401 Unauthorized — неверный токен. Пример вывода:

{
  "status": "error",
  "error": "Unauthorized",
  "message": "Invalid or expired auth token"
}