Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation

OnCall

API reference

Grafana OnCall teams HTTP API

Open source

Grafana OnCall teams HTTP API

Get a team

This endpoint retrieves the team object.

curl "{{API_URL}}/api/v1/teams/TI73TDU19W48J/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

{
  "id": "TI73TDU19W48J",
  "grafana_id": 123,
  "name": "my test team",
  "email": "",
  "avatar_url": "/avatar/3f49c15916554246daa714b9bd0ee398"
}

HTTP request

GET {{API_URL}}/api/v1/teams/<TEAM_ID>/

Parameter	Unique	Description
`id`	Yes/org	OnCall team ID
`grafana_id`	Yes/org	Grafana team ID
`name`	Yes/org	Team name
`email`	Yes/org	Team e-mail
`avatar_url`	Yes	Avatar URL of the Grafana team

List Teams

curl "{{API_URL}}/api/v1/teams/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "TI73TDU19W48J",
      "grafana_id": 123,
      "name": "my test team",
      "email": "",
      "avatar_url": "/avatar/3f49c15916554246daa714b9bd0ee398"
    }
  ],
  "page_size": 50,
  "current_page_number": 1,
  "total_pages": 1
}