centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
oncall-engine/docs/sources/oncall-api-reference/teams.md
Joey Orlando 8dee2503e6
update public API docs subpage ordering (#4833) 
# What this PR does

**Before**
![Screenshot 2024-08-15 at 13 55
40](https://github.com/user-attachments/assets/847afb34-d8d1-46f8-b6b4-fba2b6a469e0)

**After**
<img width="295" alt="Screenshot 2024-08-15 at 15 20 41"
src="https://github.com/user-attachments/assets/6cfef429-fde6-4b0d-81af-f59e97adaaaa">
2024-08-15 19:29:56 +00:00

2.2 KiB
Raw Blame History

canonical title weight refs
https://grafana.com/docs/oncall/latest/oncall-api-reference/teams/ Grafana OnCall teams HTTP API 0
pagination
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/oncall-api-reference/#pagination
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/#pagination

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",
  "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 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",
      "name": "my test team",
      "email": "",
      "avatar_url": "/avatar/3f49c15916554246daa714b9bd0ee398"
    }
  ],
  "page_size": 50,
  "current_page_number": 1,
  "total_pages": 1
}

Note

: The response is paginated. You may need to make multiple requests to get all records.

The following available filter parameter should be provided as a GET argument:

  • name (Exact match)

HTTP request

GET {{API_URL}}/api/v1/teams/