> ## Documentation Index
> Fetch the complete documentation index at: https://docs.monyfix.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Группы юзера

> Сущность групп (команд)

## Как получить список групп

Получить список групп можно с помощью `GET` запроса к API `/users/teams`.

<Card title="Get User teams" icon="link" href="/api-reference/users/get-user-teams">
  Перейти к роуту и изучить основные поля
</Card>

<Note>
  Данный роут **требует** JWT авторизацию для получения данных.
</Note>

### Структура ответа

Метод возвращает массив объектов групп с ключем `members` (массив юзеров)

```json theme={null}
[
  {
    "id": "int",
    "name": "string",
    "members": [
      {
        "id": "string",
        "phone": "string",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      }
    ]
  }
]
```

## Как получить одну группу

Получить одну группу можно с помощью `GET` запроса к API `/users/teams/{id}` по `ID` группы.

<Card title="Get User single team" icon="link" href="/api-reference/users/get-user-single-team">
  Перейти к роуту и изучить основные поля
</Card>

<Note>
  Данный роут **требует** JWT авторизацию для получения данных.
</Note>

### Структура ответа

Метод возвращает объект группы с ключем `members` (массив юзеров)

```json theme={null}
{
  "id": "int",
  "name": "string",
  "members": [
    {
      "id": "string",
      "phone": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  ]
}
```

## Как создать группу

Создать группу можно с помощью `POST` запроса к API `/users/teams`.

<Card title="Create user team" icon="link" href="/api-reference/users/create-user-team">
  Перейти к роуту и изучить основные поля
</Card>

<Note>
  Данный роут **требует** JWT авторизацию для получения данных.
</Note>

### Структура JSON Body

```json theme={null}
{
  "name": "string",
  "members": ["string"]
}
```

где,

`members` - массив строк, состоящий из телефонов пользователей

### Структура ответа

Метод возвращает созданный объект группы с ключем `members` (массив юзеров)

```json theme={null}
{
  "id": "int",
  "name": "string",
  "members": [
    {
      "id": "string",
      "phone": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  ]
}
```

## Как обновить группу

Обновить группу можно с помощью `PUT` запроса к API `/users/teams/{id}` по `ID` группы.

<Card title="Update user single team" icon="link" href="/api-reference/users/update-user-single-team">
  Перейти к роуту и изучить основные поля
</Card>

<Note>
  Данный роут **требует** JWT авторизацию для получения данных.
</Note>

<Note>
  Объекты для передачи в `body` и структура ответа совпадает с роутом создания группы (`POST /users/teams`)
</Note>