Skip to main content

Get Teams

Retrieve a list of all teams that the authenticated user is a member of.

Endpoint

GET /api/teams

Headers

Authorization
string
required
Bearer token for authentication

Query Parameters

page
number
Page number for pagination (default: 1)
pageSize
number
Number of results per page

Response

data
array
Array of team objects
count
number
Total number of teams
page
number
Current page number
pageSize
number
Results per page

Example Request

curl https://your-umami-instance.com/api/teams \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "data": [
    {
      "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"
    },
    {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "name": "Marketing",
      "accessCode": "team_xyz789ghi012345",
      "createdAt": "2024-02-01T12:00:00.000Z",
      "updatedAt": "2024-02-01T12:00:00.000Z"
    }
  ],
  "count": 2,
  "page": 1,
  "pageSize": 20
}
Only teams where you are a member will be returned. The response includes teams where you have any role (member, manager, or owner).

Build docs developers (and LLMs) love