767c5352fa
# What this PR does This PR: - adds a few attributes to paginated API responses - removes channel filter "send demo alert" internal API endpoint + tests (this endpoint was marked as deprecated + not consumed by the web UI) With the new paginated API response schema, the web UI will no longer need to: - hardcode `ITEMS_PER_PAGE` for each table - manually calculate total number of pages (these two things ☝️ will be done in https://github.com/grafana/oncall/issues/2476) For `GET /api/internal/v1/alertgroups` the response will now look like this: ```diff { "next": <url> | None, "previous": <url> | None, "results": [], ++ "page_size": <int> } ``` For all other paginated API responses, the response will now look like: ```diff { "count": <int>, "next": <url> | None, "previous": <url> | None, "results": [], ++ "page_size": <int>, ++ "current_page_number": <int>, ++ "total_pages": <int> } ``` ## TODO - [x] update public API docs to include these new attributes ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
50 lines
1.5 KiB
Markdown
50 lines
1.5 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"
|
|
}
|
|
}
|
|
],
|
|
"current_page_number": 1,
|
|
"page_size": 50,
|
|
"total_pages": 1
|
|
}
|
|
```
|
|
|
|
| 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/`
|