Teams
List Teams for User
Teams
List Teams for User
Retrieve all teams associated with the authenticated user. If the user is a tenant admin, returns all teams for the tenant. Pagination is available based on query parameters
GET
/
api
/
svc
/
v1
/
teams
/
user
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/teams/user \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"teamName": "<string>",
"description": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"members": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
]
}
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Number of items per page
Required range:
1 <= x <= 1000
Example:
10
Number of items to skip
Required range:
x >= 0
Example:
0
Response
200 - application/json
Returns an array of teams associated with the user or tenant And also the response includes paginated data
Teams
+value=volume
Available options:
team
+sort=1 +message=Use of only alpha numeric character and "-" is allowed as team name and must be less than 25 characters +usage=Name of the Team
+sort=2 +label=Team Members +message=Enter email of each of the user you want to add in the team. +uiType=UserSelect +uiProps={"optionTypes": ["users"]}
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/teams/user \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"teamName": "<string>",
"description": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"members": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
]
}
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}