Документация/API и Webhook'и/Команды

Команды

Команды группируют пользователей для отчётности, агрегатов соответствия и заданий, ограниченных командой. Все эндпоинты находятся под /api/public/v1/teams. Пользователь может быть в ноле или одной команде одновременно.

Конечные точки

МетодПутьОбласть действияНазначение
GET/teamsteams:readСписок команд со счётчиком участников.
GET/teams/{'{'}id{'}'}teams:readОдна команда со списком участников.
POST/teamsteams:writeСоздать команду.
PATCH/teams/{'{'}id{'}'}teams:writeПереименовать команду.
DELETE/teams/{'{'}id{'}'}teams:writeУдалить команду. Участники отвязываются, не деактивируются.
POST/teams/{'{'}teamId{'}'}/members/{'{'}userId{'}'}teams:writeДобавить пользователя в команду.
DELETE/teams/{'{'}teamId{'}'}/members/{'{'}userId{'}'}teams:writeУдалить пользователя из команды.

Список команд

Возвращает каждую команду в организации. Счётчик участников денормализован — вызовите GET /teams/{id} для фактического состава.

GET /api/public/v1/teams
Authorization: Bearer scs_live_…

Ответ

[
  {
    "id": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
    "name": "Payments",
    "memberCount": 12,
    "createdAt": "2025-11-03T14:20:00Z"
  },
  {
    "id": "a52e1f9b-8c44-4a31-9c0d-3b62e0a17c84",
    "name": "Platform",
    "memberCount": 8,
    "createdAt": "2025-11-03T14:21:42Z"
  }
]

Пример

curl -sS -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams

Получить команду

Возвращает команду плюс её состав участников той же формы, что и GET /users/{id}, минус массивы прогресса.

GET /api/public/v1/teams/{teamId}
Authorization: Bearer scs_live_…

Ответ

{
  "id": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
  "name": "Payments",
  "createdAt": "2025-11-03T14:20:00Z",
  "members": [
    {
      "id": "b1a4d7c2-9e58-4f3a-83cd-2c6f1a90e7b4",
      "name": "Jane Smith",
      "email": "jane.smith@acme.com",
      "role": "member",
      "teamId": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
      "teamName": "Payments",
      "isActive": true,
      "lastLoginAt": "2026-05-27T16:42:11Z",
      "createdAt": "2026-02-04T11:08:00Z"
    }
  ]
}

Пример

curl -sS -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32

Создать команду

Имена команд должны быть уникальны в пределах организации. Ответ возвращает новую команду со счётчиком участников ноль.

POST /api/public/v1/teams
Authorization: Bearer scs_live_…
Content-Type: application/json

Тело запроса

ПолеТипОбязательноЗначение
namestringдаОтображаемое имя команды. Должно быть уникальным в пределах организации.

Ответ

{
  "id": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
  "name": "Payments",
  "memberCount": 0,
  "createdAt": "2026-05-29T09:30:12Z"
}

Пример

curl -sS -X POST \
  -H "Authorization: Bearer $SCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Payments"}' \
  https://api.limeplate.com/api/public/v1/teams

Обновить команду

Может быть изменено только имя команды. Чтобы перемещать участников внутрь или наружу, используйте эндпоинты участников.

PATCH /api/public/v1/teams/{teamId}
Authorization: Bearer scs_live_…
Content-Type: application/json

Тело запроса

ПолеТипОбязательноЗначение
namestringдаНовое имя команды.

Ответ

{
  "message": "Team updated"
}

Пример

curl -sS -X PATCH \
  -H "Authorization: Bearer $SCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Payments Core"}' \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32

Удалить команду

Удаляет команду. Участники команды отвязываются (их teamId становится null), но не деактивируются — их аккаунты, XP и прогресс остаются нетронутыми. Задания, ограниченные удалённой командой, деактивируются.

DELETE /api/public/v1/teams/{teamId}
Authorization: Bearer scs_live_…

Ответ

{
  "message": "Team deleted"
}

Пример

curl -sS -X DELETE \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32

Добавить участника

Перемещает пользователя в команду. Если пользователь уже был в другой команде, это предыдущее членство заменяется. Отдельного вызова «перевод» нет.

POST /api/public/v1/teams/{teamId}/members/{userId}
Authorization: Bearer scs_live_…

Ответ

{
  "message": "Member added"
}

Пример

curl -sS -X POST \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32/members/b1a4d7c2-9e58-4f3a-83cd-2c6f1a90e7b4

Удалить участника

Отвязывает пользователя от команды. Эквивалентно PATCH пользователя с teamId: null, но проходит чище через идентичность команды. Аккаунт и прогресс пользователя не затрагиваются.

DELETE /api/public/v1/teams/{teamId}/members/{userId}
Authorization: Bearer scs_live_…

Ответ

{
  "message": "Member removed"
}

Пример

curl -sS -X DELETE \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32/members/b1a4d7c2-9e58-4f3a-83cd-2c6f1a90e7b4