Dokumente/API & Webhooks/Teams

Teams

Teams gruppieren Benutzer für Berichterstellung, Compliance-Roll-ups und team-bezogene Zuweisungen. Alle Endpunkte befinden sich unter /api/public/v1/teams. Ein Benutzer kann gleichzeitig in null oder einem Team sein.

Endpunkte

MethodePfadGeltungsbereichZweck
GET/teamsteams:readTeams mit Mitgliederzahlen auflisten.
GET/teams/{'{'}id{'}'}teams:readEinzelnes Team mit Mitgliederliste.
POST/teamsteams:writeEin Team erstellen.
PATCH/teams/{'{'}id{'}'}teams:writeEin Team umbenennen.
DELETE/teams/{'{'}id{'}'}teams:writeEin Team löschen. Mitglieder werden gelöst, nicht deaktiviert.
POST/teams/{'{'}teamId{'}'}/members/{'{'}userId{'}'}teams:writeEinen Benutzer zu einem Team hinzufügen.
DELETE/teams/{'{'}teamId{'}'}/members/{'{'}userId{'}'}teams:writeEinen Benutzer aus einem Team entfernen.

Teams auflisten

Gibt jedes Team in der Organisation zurück. Die Mitgliederzahl ist denormalisiert — rufen Sie GET /teams/{id} für die tatsächliche Liste auf.

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

Antwort

[
  {
    "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"
  }
]

Beispiel

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

Team abrufen

Gibt das Team plus seine Mitgliederliste in der gleichen Form wie GET /users/{id} ohne Fortschrittsarrays zurück.

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

Antwort

{
  "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"
    }
  ]
}

Beispiel

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

Team erstellen

Teamnamen müssen innerhalb der Organisation eindeutig sein. Die Antwort gibt das neue Team mit einer Mitgliederzahl von null zurück.

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

Anfragetext

FeldTypErforderlichBedeutung
namestringjaAnzeigename des Teams. Muss innerhalb der Organisation eindeutig sein.

Antwort

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

Beispiel

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

Team aktualisieren

Nur der Teamname kann geändert werden. Um Mitglieder hinein- oder herauszubewegen, verwenden Sie die Mitglieder-Endpunkte.

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

Anfragetext

FeldTypErforderlichBedeutung
namestringjaNeuer Teamname.

Antwort

{
  "message": "Team updated"
}

Beispiel

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

Team löschen

Entfernt das Team. Mitglieder des Teams werden gelöst (ihr teamId wird zu null), aber nicht deaktiviert — ihre Konten, XP und Fortschritt bleiben intakt. Team-bezogene Zuweisungen, die an das gelöschte Team gebunden sind, werden deaktiviert.

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

Antwort

{
  "message": "Team deleted"
}

Beispiel

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

Mitglied hinzufügen

Verschiebt einen Benutzer in das Team. Wenn der Benutzer bereits in einem anderen Team war, wird die vorherige Mitgliedschaft ersetzt. Es gibt keinen separaten "Transfer"-Aufruf.

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

Antwort

{
  "message": "Member added"
}

Beispiel

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

Mitglied entfernen

Löst den Benutzer vom Team. Äquivalent zum PATCHen des Benutzers mit teamId: null, leitet aber sauber durch die Team-Identität. Das Konto und der Fortschritt des Benutzers sind nicht betroffen.

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

Antwort

{
  "message": "Member removed"
}

Beispiel

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