oncall-engine/docs/sources/oncall-api-reference/user_groups.md
Joey Orlando 47042decb7
don't enforce line-length rule for markdownlint for code-blocks or tables (#2145)
# 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)
2023-06-09 06:57:19 +00:00

1.4 KiB

canonical title weight
https://grafana.com/docs/oncall/latest/oncall-api-reference/user_groups/ OnCall User Groups HTTP API 1400

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 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"
      }
    }
  ]
}
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/