🧩 Retrieve User & Team IDs via API
This reference shows how to retrieve users and teams – including their unique IDs – via the Valuestreamer API. These IDs are required for further API actions (e.g. permissions, assignments, team details).
🔍 Overview of Available Endpoints
| Purpose | HTTP Method | Endpoint |
|---|---|---|
| Retrieve all users | GET |
/api/exchange/users |
| Retrieve all teams | GET |
/api/exchange/teams |
| Get details of a specific team | GET |
/api/exchange/teams/{teamId} |
👤 Retrieve Users
📌 Request
GET https://api-TENANT.valuestreamer.de/api/exchange/users
ℹ️ Note: Replace TENANT with your tenant-specific domain.
📥 Example Response (simplified)
[
{
"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"
}
]
{
"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"
}
]
Field Descriptions
| Field | Description |
|---|---|
id |
Unique user ID (UUID) used for further API calls |
firstName |
User’s first name |
lastName |
User’s last name |
email |
User’s email address |
ℹ️ Note: IDs are static and cannot be edited.
🧑🤝🧑 Retrieve Teams
📌 Request
GET https://api-TENANT.valuestreamer.de/api/exchange/teams
📥 Example Response (simplified)
[
{
"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"
}
]
Field Descriptions
| Field | Description |
|---|---|
id |
Unique team ID (UUID) |
name |
Full team name |
shortName |
Short team name |
parentTeam |
UUID of the parent team, if applicable |
ℹ️ Note: Teams can be hierarchical. parentTeam = null means there is no parent team.
📋 Retrieve Details of a Specific Team
Use this endpoint to view a team's members and associated process boards.
📌 Request
GET https://api-TENANT.valuestreamer.de/api/exchange/teams/{team-Id}
Replace {teamId} with the actual ID of the team you want to query.
📥 Example Response (shortened)
{
"id": "UUID-TEAM-DETAIL",
"name": "Team Gamma",
"shortName": "Gamma",
"parentTeam": "UUID-TEAM-0",
"members": [
{
"id": "UUID-USER-A",
"firstName": "Anna",
"lastName": "Example",
"email": "anna.example@example.de"
},
{
"id": "UUID-USER-B",
"firstName": "Ben",
"lastName": "Example",
"email": "ben.example@example.de"
}
],
"processBoards": [
{
"id": "UUID-PROCESS-1",
"name": "Process X"
}
]
}
"id": "UUID-TEAM-DETAIL",
"name": "Team Gamma",
"shortName": "Gamma",
"parentTeam": "UUID-TEAM-0",
"members": [
{
"id": "UUID-USER-A",
"firstName": "Anna",
"lastName": "Example",
"email": "anna.example@example.de"
},
{
"id": "UUID-USER-B",
"firstName": "Ben",
"lastName": "Example",
"email": "ben.example@example.de"
}
],
"processBoards": [
{
"id": "UUID-PROCESS-1",
"name": "Process X"
}
]
}
Field Descriptions
| Field | Description |
|---|---|
members |
List of team members with basic user information |
processBoards |
List of process boards assigned to the team |
✨ Tip:
Use team details to programmatically manage team settings, roles, or processes.
❓ FAQ
How can I identify which team ID belongs to which team?
Use the /teams endpoint to retrieve all teams and match by name.