🧩 User‑ & Team‑IDs abrufen
In dieser Referenz zeigen wir, wie Sie über die Valuestreamer‑API Benutzer (User) und Teams inklusive ihrer IDs abrufen. Diese IDs werden für weitere API‑Aufrufe genutzt (z. B. Berechtigungen, Zuordnungen, Team‑Details).
🔍 Übersicht der verfügbaren Endpunkte
| Zweck | HTTP‑Methode | Endpoint |
|---|---|---|
| Alle Benutzer abrufen | GET |
/api/exchange/users |
| Alle Teams abrufen | GET |
/api/exchange/teams |
| Details eines Teams abrufen | GET |
/api/exchange/teams/{teamId} |
👤 Benutzer (Users) abrufen
đź“Ś Request
GET https://api-TENANT.valuestreamer.de/api/exchange/users
ℹ️ Hinweis: Ersetzen Sie
TENANT durch Ihre Mandanten‑Domain.📥 Beispiel‑Response (vereinfachte Ausgabe)
[
{
"id": "UUID-USER-1",
"firstName": "Max",
"lastName": "Mustermann",
"email": "max.mustermann@example.de"
},
{
"id": "UUID-USER-2",
"firstName": "Maria",
"lastName": "Musterfrau",
"email": "maria.musterfrau@example.de"
}
]
Erläuterung der Felder
| Feld | Beschreibung |
|---|---|
id |
Eindeutige Benutzer‑ID (UUID) – zur Identifikation in weiteren API‑Calls |
firstName |
Vorname des Benutzers |
lastName |
Nachname des Benutzers |
email |
E‑Mail‑Adresse des Benutzers |
ℹ️ Hinweis: Die IDs sind fest und nicht editierbar.
🧑‍🤝‍🧑 Teams abrufen
đź“Ś Request
GET https://api-TENANT.valuestreamer.de/api/exchange/teams
📥 Beispiel‑Response (vereinfachte Ausgabe)
[
{
"id": "UUID-TEAM-1",
"name": "Team‑Alpha",
"shortName": "Alpha",
"parentTeam": null
},
{
"id": "UUID-TEAM-2",
"name": "Team‑Beta",
"shortName": "Beta",
"parentTeam": "UUID-TEAM-1"
}
]
{
"id": "UUID-TEAM-1",
"name": "Team‑Alpha",
"shortName": "Alpha",
"parentTeam": null
},
{
"id": "UUID-TEAM-2",
"name": "Team‑Beta",
"shortName": "Beta",
"parentTeam": "UUID-TEAM-1"
}
]
Feldbeschreibungen
| Feld | Bedeutung |
|---|---|
id |
Eindeutige Team‑ID (UUID) |
name |
Vollständiger Teamname |
shortName |
Kurzname des Teams |
parentTeam |
UUID des ĂĽbergeordneten Teams (falls vorhanden) |
ℹ️ Hinweis: Teams können hierarchisch aufgebaut sein. parentTeam = null" bedeutet, dass es kein übergeordnetes Team gibt.
đź“‹ Details zu einem einzelnen Team abrufen
Möchten Sie zu einem Team zusätzlich die Mitglieder und zugeordnete Prozessboards sehen, nutzen Sie den Detail‑Endpoint.
đź“Ś Request
GET https://api-TENANT.valuestreamer.de/api/exchange/teams/{teamId}
📥 Beispiel‑Response (gekürzt)
{
"id": "UUID-TEAM-DETAIL",
"name": "Team‑Gamma",
"shortName": "Gamma",
"parentTeam": "UUID-TEAM-0",
"members": [
{
"id": "UUID-USER-A",
"firstName": "Anna",
"lastName": "Beispiel",
"email": "anna.beispiel@example.de"
},
{
"id": "UUID-USER-B",
"firstName": "Ben",
"lastName": "Beispiel",
"email": "ben.beispiel@example.de"
}
],
"processBoards": [
{
"id": "UUID-PROCESS-1",
"name": "Prozess‑X"
}
]
}
"id": "UUID-TEAM-DETAIL",
"name": "Team‑Gamma",
"shortName": "Gamma",
"parentTeam": "UUID-TEAM-0",
"members": [
{
"id": "UUID-USER-A",
"firstName": "Anna",
"lastName": "Beispiel",
"email": "anna.beispiel@example.de"
},
{
"id": "UUID-USER-B",
"firstName": "Ben",
"lastName": "Beispiel",
"email": "ben.beispiel@example.de"
}
],
"processBoards": [
{
"id": "UUID-PROCESS-1",
"name": "Prozess‑X"
}
]
}
Feld‑Details
| Feld | Inhalt |
|---|---|
members |
Liste der Team‑Mitglieder mit User‑Details |
processBoards |
Zugeordnete Prozessboards |
✨ Tipp:
Nutzen Sie Team‑Details, um teamweite Einstellungen, Rollen oder Prozesse programmatisch zu verwalten.
âť“ FAQ
Wie finde ich heraus, welche Team‑ID zu welchem Team gehört?
Rufen Sie alle Teams ĂĽber den Endpoint /teams-id ab und verwenden Sie den Namen als Orientierung.