Skip to main content

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

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

Get User teams

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.

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

Метод возвращает массив объектов групп с ключем members (массив юзеров) 
[
  {
    "id": "int",
    "name": "string",
    "members": [
      {
        "id": "string",
        "phone": "string",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      }
    ]
  }
]

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

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

Get User single team

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.

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

Метод возвращает объект группы с ключем members (массив юзеров) 
{
  "id": "int",
  "name": "string",
  "members": [
    {
      "id": "string",
      "phone": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  ]
}

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

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

Create user team

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.

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

{
  "name": "string",
  "members": ["string"]
}
где, members - массив строк, состоящий из телефонов пользователей

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

Метод возвращает созданный объект группы с ключем members (массив юзеров) 
{
  "id": "int",
  "name": "string",
  "members": [
    {
      "id": "string",
      "phone": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  ]
}

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

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

Update user single team

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.
Объекты для передачи в body и структура ответа совпадает с роутом создания группы (POST /users/teams)