47042decb7
# What this PR does ## Which issue(s) this PR fixes ## Checklist - [ ] Unit, integration, and e2e (if applicable) tests updated - [ ] Documentation added (or `pr:no public docs` PR label added if not required) - [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
---
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/user_groups/
|
|
title: OnCall User Groups HTTP API
|
|
weight: 1400
|
|
---
|
|
|
|
<!--Used in escalation policies with type = `notify_user_group` and in schedules.-->
|
|
|
|
# List user groups
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/user_groups/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"count": 1,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": "GPFAPH7J7BKJB",
|
|
"type": "slack_based",
|
|
"slack": {
|
|
"id": "MEOW_SLACK_ID",
|
|
"name": "Meow Group",
|
|
"handle": "meow_group"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
| Parameter | Unique | Description |
|
|
| --------- | :----: | :---------------------------------------------------------------------------------------------------- |
|
|
| `id` | Yes | User Group ID |
|
|
| `type` | No | [Slack-defined user groups](https://slack.com/intl/en-ru/help/articles/212906697-Create-a-user-group) |
|
|
| `slack` | No | Metadata retrieved from Slack. |
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/user_groups/`
|