Skip to main content

Get Team Members

Retrieve a list of all members in a team.

Endpoint

GET /api/teams/{teamId}/users

Headers

Authorization
string
required
Bearer token for authentication

Path Parameters

teamId
string
required
Team UUID

Query Parameters

page
number
Page number for pagination (default: 1)
pageSize
number
Number of results per page
Search term to filter members by username

Response

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

Example Request

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

Example Response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "count": 2,
  "page": 1,
  "pageSize": 20
}

Team Roles

team-manager
role
Full permissions to manage team settings, members, and resources
team-member
role
Can view and edit team resources but cannot manage team settings or members
team-view-only
role
Read-only access to team resources

Error Responses

401
error
Unauthorized - You must be a member of this team
You must be a member of the team to view its member list. Members are ordered by their join date (oldest first).

Build docs developers (and LLMs) love