Team API

Team Search With Paging
Using the query parameter
Using the name parameter
Status Codes:
Get Team By Id
Add Team
Update Team
Delete Team By Id
Get Team Members
Add Team Member
Remove Member From Team
Bulk Update Team Members
Get Team Preferences
Update Team Preferences

{{< docs/shared lookup="developers/deprecated-apis.md" source="grafana" version="<GRAFANA_VERSION>" >}}

This API can be used to manage Teams and Team Memberships.

Access to these API endpoints is restricted as follows:

All authenticated users are able to view details of teams they are a member of.
Organization Admins are able to manage all teams and team members.

If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to Role-based access control permissions for more information.

Team Search With Paging

GET /api/teams/search?perpage=50&page=1&query=myteam&sort=memberCount-desc

GET /api/teams/search?name=myteam

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:read	teams:*

Example Request:

GET /api/teams/search?perpage=10&page=1&query=mytestteam HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Example Response:

HTTP/1.1 200
Content-Type: application/json

{
  "totalCount": 1,
  "teams": [
    {
      "id": 1,
      "orgId": 1,
      "name": "MyTestTeam",
      "email": "",
      "avatarUrl": "\/avatar\/3f49c15916554246daa714b9bd0ee398",
      "memberCount": 1
    }
  ],
  "page": 1,
  "perPage": 1000
}

Using the query parameter

Default value for the perpage parameter is 1000 and for the page parameter is 1.

The totalCount field in the response can be used for pagination of the teams list E.g. if totalCount is equal to 100 teams and the perpage parameter is set to 10 then there are 10 pages of teams.

The query parameter is optional and it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded e.g. query=my%20team.

The sort param is an optional comma separated list of options to order the search result. Accepted values for the sort filter are: name-asc, name-desc, email-asc, email-desc, memberCount-asc, memberCount-desc. By default, if sort is not specified, the teams list will be ordered by name in ascending order.

Using the name parameter

The name parameter returns a single team if the parameter matches the name field.

Status Codes:

200 - Ok
400 - Bad Request
401 - Unauthorized
403 - Permission denied
404 - Team not found (if searching by name)

Get Team By Id

GET /api/teams/:id

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:read	teams:*

Example Request:

GET /api/teams/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Example Response:

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "orgId": 1,
  "name": "MyTestTeam",
  "email": "",
  "created": "2017-12-15T10:40:45+01:00",
  "updated": "2017-12-15T10:40:45+01:00"
}

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied
404 - Team not found

Add Team

The Team name needs to be unique. name is required and email is optional.

POST /api/teams

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:create	N/A

Example Request:

POST /api/teams HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

{
  "name": "MyTestTeam",
  "email": "email@test.com",
}

Example Response:

HTTP/1.1 200
Content-Type: application/json

{"message":"Team created","teamId":2,"uid":"ceaulqadfoav4e"}

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied
409 - Team name is taken

Update Team

There are two fields that can be updated for a team: name and email.

PUT /api/teams/:id

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:write	teams:*

Example Request:

PUT /api/teams/2 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

{
  "name": "MyTestTeam",
  "email": "email@test.com"
}

Example Response:

HTTP/1.1 200
Content-Type: application/json

{"message":"Team updated"}

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied
404 - Team not found
409 - Team name is taken

Delete Team By Id

DELETE /api/teams/:id

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:delete	teams:*

Example Request:

DELETE /api/teams/2 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Example Response:

HTTP/1.1 200
Content-Type: application/json

{"message":"Team deleted"}

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied
404 - Failed to delete Team. ID not found

Get Team Members

GET /api/teams/:teamId/members

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams.permissions:read	teams:*

Example Request:

GET /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Example Response:

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "teamId": 1,
    "userId": 3,
    "email": "user1@example.com",
    "login": "user1",
    "avatarUrl": "\/avatar\/1b3c32f6386b0185c40d359cdc733a79"
  },
  {
    "orgId": 1,
    "teamId": 1,
    "userId": 2,
    "email": "user2@example.com",
    "login": "user2",
    "avatarUrl": "\/avatar\/cad3c68da76e45d10269e8ef02f8e73e"
  }
]

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied

Add Team Member

POST /api/teams/:teamId/members

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams.permissions:write	teams:*

Example Request:

POST /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

{
  "userId": 2
}

Example Response:

HTTP/1.1 200
Content-Type: application/json

{"message":"Member added to Team"}

Status Codes:

200 - Ok
400 - User is already added to this team
401 - Unauthorized
403 - Permission denied
404 - Team not found

Remove Member From Team

DELETE /api/teams/:teamId/members/:userId

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams.permissions:write	teams:*

Example Request:

DELETE /api/teams/2/members/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Example Response:

HTTP/1.1 200
Content-Type: application/json

{"message":"Team Member removed"}

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied
404 - Team not found/Team member not found

Bulk Update Team Members

Allows bulk updating team members and administrators using user emails. Will override all current members and administrators for the specified team.

`PUT /api/teams/:teamId/members

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams.permissions:write	teams:*

Example Request:

PUT /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

{
  "members": ["user1@example.com", "user2@example.com"]
  "admins": ["user3@example.com"]
}

Example Response:

HTTP/1.1 200
Content-Type: application/json

{"message":"Team memberships have been updated"}

Status Codes:

200 - Ok
401 - Unauthorized
403 - Permission denied
404 - Team not found/Team member not found
500 - Internal error

Get Team Preferences

GET /api/teams/:teamId/preferences

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:read	teams:*

Example Request:

GET /api/teams/2/preferences HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Example Response:

HTTP/1.1 200
Content-Type: application/json

{
  "theme": "",
  "homeDashboardId": 0,
  "homeDashboardUID": "",
  "timezone": ""
}

Update Team Preferences

PUT /api/teams/:teamId/preferences

Required permissions

See note in the introduction for an explanation.

Action	Scope
teams:write	teams:*

Example Request:

PUT /api/teams/2/preferences HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

{
  "theme": "dark",
  "homeDashboardId": 39,
  "homeDashboardUID": "jcIIG-07z",
  "timezone": "utc"
}

JSON Body Schema:

theme - One of: light, dark, or an empty string for the default theme
homeDashboardId - Deprecated. Use homeDashboardUID instead.
homeDashboardUID - The :uid of a dashboard, or the reserved value global-home to show the instance default home instead of the organization's dashboard. An empty string clears the preference so the organization's dashboard applies.
timezone - One of: utc, browser, or an empty string for the default

Omitting a key will cause the current value to be replaced with the system default value.

Example Response:

HTTP/1.1 200
Content-Type: text/plain; charset=utf-8

{
  "message":"Preferences updated"
}

版本号 #2
由壳壳虫创建于 2026-10-31 16:08:33 UTC
由壳壳虫更新于 2026-10-31 16:08:36 UTC