Browse docs

Teams

Overview

Teams group workspace members together. Tickets can be assigned to a team, which notifies all team members. Admin role is required to create, update, or delete teams, or to manage members.

List Teams

GET /api/teams

Example Response

{
    "data": [
        {
            "id": 1,
            "ulid": "01hx9f3k2a...",
            "name": "Support",
            "description": "Tier 1 support team",
            "logo_url": null,
            "member_count": 4
        }
    ]
}

Show Team

GET /api/teams/{team}

Create Team (admin only)

POST /api/teams

Request Body

Field Type Required
name string Yes
description string No

Update Team (admin only)

PUT /api/teams/{team}

Same body as create. Omit fields to leave them unchanged.

Delete Team (admin only)

DELETE /api/teams/{team}

Add Team Member (admin only)

POST /api/teams/{team}/members/{user}

The {user} parameter is the user ULID. The user must already be a member of the workspace. Returns the updated team.

Remove Team Member (admin only)

DELETE /api/teams/{team}/members/{user}

Returns 204 on success.