Teams
Create and manage teams, and assign members to them.
Teams group users together for easier board access management. When a team is assigned to a board, all team members automatically gain access.
List Teams
GET /api/v1/teamsQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number (default: 1) |
| limit | number | No | Items per page (default: 20) |
| search | string | No | Search by team name |
Example Response
{
"data": [
{
"id": "team_abc123",
"name": "Engineering",
"color": "#3B82F6",
"memberCount": 5,
"createdAt": "2025-01-15T10:00:00Z"
}
],
"total": 3,
"page": 1,
"pageSize": 20,
"totalPages": 1
}Create Team
POST /api/v1/teamsPermission required: teams:*
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Team name (max 100 characters) |
| color | string | No | Team color (hex code, e.g. #3B82F6) |
| memberIds | string[] | No | Initial member user IDs |
Example Request
{
"name": "Engineering",
"color": "#3B82F6",
"memberIds": ["usr_abc123", "usr_def456"]
}Get Team
GET /api/v1/teams/{teamId}Returns a team with its members.
Update Team
PATCH /api/v1/teams/{teamId}Permission required: teams:*
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Team name |
| color | string | No | Team color |
Delete Team
DELETE /api/v1/teams/{teamId}Permission required: teams:*
Permanently deletes the team. Returns 204 No Content.
Add Team Member
POST /api/v1/teams/{teamId}/membersPermission required: teams:*
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| userId | string | Yes | User ID to add |
Remove Team Member
DELETE /api/v1/teams/{teamId}/members/{userId}Permission required: teams:*
Removes a user from the team. Returns 204 No Content.