Team Management
Retrieve a list of teams within the workspace, showcasing their members count and other details.
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
Sort by field specified
GET /workspaces/{workspaceId}/teams HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"visibility": "text",
"accessibility": "text",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"id": "text",
"type": "text"
}
],
"hideFromViews": true,
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
],
"nextPageToken": "text",
"total": 1
}
Retrieve information about a specific team within the workspace, including its name, and other details.
GET /workspaces/{workspaceId}/teams/{teamId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"visibility": "text",
"accessibility": "text",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"id": "text",
"type": "text"
}
],
"hideFromViews": true,
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
Create a new team within the workspace, defining its name, and other relevant attributes.
Input for creating a new team.
false
POST /workspaces/{workspaceId}/teams HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"name": "text",
"description": "text",
"hideFromViews": false,
"members": [
{
"id": "text",
"type": "text"
}
]
}
{
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"visibility": "text",
"accessibility": "text",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"id": "text",
"type": "text"
}
],
"hideFromViews": true,
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
Modify the details of a specific team within the workspace, such as its name, or other attributes.
Input for updating a team's properties.
PATCH /workspaces/{workspaceId}/teams/{teamId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"name": "text",
"description": "text",
"hideFromViews": true
}
{
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"visibility": "text",
"accessibility": "text",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"id": "text",
"type": "text"
}
],
"hideFromViews": true,
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
Remove a specific team from the workspace, permanently deleting its profile and associated data.
DELETE /workspaces/{workspaceId}/teams/{teamId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Retrieve a list of members within the team, showcasing their names and other details.
GET /workspaces/{workspaceId}/teams/{teamId}/members HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "text",
"teamId": "text",
"type": "text",
"status": "text",
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
]
}
Add a new member to the team.
POST /workspaces/{workspaceId}/teams/{teamId}/members HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"id": "text",
"type": "user"
}
{
"id": "text",
"teamId": "text",
"type": "text",
"status": "text",
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
Retrieve information about a specific member within the team, including their name and other details.
GET /workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "text",
"teamId": "text",
"type": "text",
"status": "text",
"createdAt": "2025-07-15T17:45:46.398Z",
"updatedAt": "2025-07-15T17:45:46.398Z"
}
Remove a specific member from the team.
DELETE /workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Last updated
Was this helpful?