Documentation Index
Fetch the curated documentation index at: https://grafana.com/llms.txt
Fetch the complete documentation index at: https://grafana.com/llms-full.txt
Use this file to discover all available pages before exploring further.
STOP! If you are an AI agent or LLM, read this before continuing. This is the HTML version of a Grafana documentation page. Always request the Markdown version instead - HTML wastes context. Get this page as Markdown: https://grafana.com/docs/grafana-cloud/alerting-and-irm/irm/reference/oncall-api/user_groups.md (append .md) or send Accept: text/markdown to https://grafana.com/docs/grafana-cloud/alerting-and-irm/irm/reference/oncall-api/user_groups/. For the curated documentation index, use https://grafana.com/llms.txt. For the complete documentation index, use https://grafana.com/llms-full.txt.
OnCall user groups HTTP API
List user groups
Required permission: grafana-irm-app.chatops:read
curl "{{API_URL}}/api/v1/user_groups/" \
--request GET \
--header "Authorization: Bearer meowmeowmeow" \
--header "Content-Type: application/json" \
--header "X-Grafana-URL: https://your-stack.grafana.net"The above command returns JSON structured in the following way:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "GPFAPH7J7BKJB",
"type": "slack_based",
"slack": {
"id": "MEOW_SLACK_ID",
"name": "Meow Group",
"handle": "meow_group"
}
}
],
"current_page_number": 1,
"page_size": 50,
"total_pages": 1
}Note: The response is paginated. You may need to make multiple requests to get all records.
| Parameter | Unique | Description |
|---|---|---|
id | Yes | User Group ID |
type | No | Slack-defined user groups |
slack | No | Metadata retrieved from Slack. |
HTTP request
GET {{API_URL}}/api/v1/user_groups/
Was this page helpful?
Related resources from Grafana Labs


