Grafana OnCallGrafana OnCall API referenceOnCall User Groups HTTP API

List user groups

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

The above command returns JSON structured like this:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "GPFAPH7J7BKJB",
            "type": "slack_based",
            "slack": {
              "id": "MEOW_SLACK_ID",
              "name": "Meow Group",
              "handle": "meow_group"
            }
        }
    ]
}
ParameterUniqueDescription
idYesUser Group ID
typeNoSlack-defined user groups
slackNoMetadata retrieved from Slack.

HTTP request

GET {{API_URL}}/api/v1/user_groups/