Skip to main content

Get Team

Retrieve detailed information about a specific team, including team members.

Endpoint

GET /api/teams/{teamId}

Headers

Authorization
string
required
Bearer token for authentication

Path Parameters

teamId
string
required
Team UUID

Response

id
string
Team UUID
name
string
Team name
accessCode
string
Unique access code for joining the team
createdAt
string
ISO 8601 timestamp of creation
updatedAt
string
ISO 8601 timestamp of last update
members
array
Array of team member objects

Example Request

curl https://your-umami-instance.com/api/teams/660e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "id": "660e8400-e29b-41d4-a716-446655440001",
  "name": "Engineering",
  "accessCode": "team_abc123def456789",
  "createdAt": "2024-01-10T08:00:00.000Z",
  "updatedAt": "2024-02-15T10:30:00.000Z",
  "members": [
    {
      "id": "880e8400-e29b-41d4-a716-446655440003",
      "userId": "990e8400-e29b-41d4-a716-446655440004",
      "teamId": "660e8400-e29b-41d4-a716-446655440001",
      "role": "team-manager",
      "createdAt": "2024-01-10T08:00:00.000Z",
      "user": {
        "id": "990e8400-e29b-41d4-a716-446655440004",
        "username": "john.doe"
      }
    },
    {
      "id": "aa0e8400-e29b-41d4-a716-446655440005",
      "userId": "bb0e8400-e29b-41d4-a716-446655440006",
      "teamId": "660e8400-e29b-41d4-a716-446655440001",
      "role": "team-member",
      "createdAt": "2024-01-15T12:00:00.000Z",
      "user": {
        "id": "bb0e8400-e29b-41d4-a716-446655440006",
        "username": "jane.smith"
      }
    }
  ]
}

Error Responses

401
error
Unauthorized - You must be a member of this team
404
error
Not Found - Team does not exist
You must be a member of the team to view its details. The response includes full member information for team management.

Build docs developers (and LLMs) love