Teams
Authorizations
Query parameters
start-indexinteger · int32OptionalDefault:
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
max-resultsinteger · int32 · max: 100OptionalDefault:
the maximum number of results when paging through a list of entities.
50
membersnumberOptional
optional, filter teams for specific members (currently only a single occurrence of this param is allowed)
Responses
200
The teams
application/json
get
GET /api/teams HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
The teams
[
{
"id": 1,
"name": "text",
"visibility": "PUBLIC",
"members": [
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
],
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
}
]
Authorizations
Body
idinteger · int64Optional
namestringOptional
visibilitystring · enumOptionalPossible values:
createdAtstring · date-timeOptional
Date in ISO-8601
updatedAtstring · date-timeOptional
Date in ISO-8601
Responses
200
The newly created team
application/json
post
POST /api/teams HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 479
{
"id": 1,
"name": "text",
"visibility": "PUBLIC",
"members": [
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
],
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
}
200
The newly created team
{
"id": 1,
"name": "text",
"visibility": "PUBLIC",
"members": [
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
],
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Responses
200
The requested team
application/json
get
GET /api/teams/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
The requested team
{
"id": 1,
"name": "text",
"visibility": "PUBLIC",
"members": [
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
],
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Body
idinteger · int64Optional
namestringOptional
visibilitystring · enumOptionalPossible values:
createdAtstring · date-timeOptional
Date in ISO-8601
updatedAtstring · date-timeOptional
Date in ISO-8601
Responses
200
The updated team
application/json
put
PUT /api/teams/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 479
{
"id": 1,
"name": "text",
"visibility": "PUBLIC",
"members": [
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
],
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
}
200
The updated team
{
"id": 1,
"name": "text",
"visibility": "PUBLIC",
"members": [
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
],
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Body
rolestring · enumOptionalPossible values:
Responses
200
The added team member
application/json
post
POST /api/teams/{id}/members HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 344
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
200
The added team member
{
"user": {
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-07-08T10:04:13.175Z",
"createdAt": "2025-07-08T10:04:13.175Z",
"updatedAt": "2025-07-08T10:04:13.175Z"
},
"role": "STAKEHOLDER"
}
Was this helpful?