Documentation Index
Fetch the complete documentation index at: https://openlinear.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
List Teams
Auth: optionalAuth. Returns teams the authenticated user belongs to, with member counts and associated projects.
Create Team
Auth: requireAuth. The creator is automatically added as owner.
| Field | Type | Required | Default | Description |
|---|
name | string | Yes | — | 1-50 characters |
key | string | Yes | — | 1-10 chars, uppercase alphanumeric, starts with letter (e.g., ENG) |
description | string | No | null | Up to 500 characters |
color | string | No | #6366f1 | Hex color code |
icon | string | No | null | Icon identifier |
private | boolean | No | false | Restrict team visibility |
An invite code is auto-generated in the format KEY-XXXXXXXX.
Broadcasts: team:created
Join Team
Auth: requireAuth.
| Field | Type | Required |
|---|
inviteCode | string | Yes |
Adds the user as a member of the team.
Get Team
Returns team details with members and project associations.
Update Team
| Field | Type | Description |
|---|
name | string | Team name |
description | string | Team description |
color | string | Hex color |
icon | string | Icon identifier |
private | boolean | Visibility |
Broadcasts: team:updated
Delete Team
Cascades: removes all team members, project-team associations, and nullifies teamId on associated tasks.
Broadcasts: team:deleted
Members
List Members
GET /api/teams/:id/members
Returns team members with user details, ordered by join date.
Add Member
POST /api/teams/:id/members
Auth: requireAuth.
| Field | Type | Required | Description |
|---|
email | string | One of email/userId | User’s email |
userId | string | One of email/userId | User’s UUID |
role | enum | No | owner, admin, or member (default: member) |
Remove Member
DELETE /api/teams/:id/members/:userId
Removes a user from the team.