oncall-engine/docs/sources/oncall-api-reference/user_groups.md
Michael Derynck 6b40f95033 World, meet OnCall!
Co-authored-by: Eve832 <eve.meelan@grafana.com>
    Co-authored-by: Francisco Montes de Oca <nevermind89x@gmail.com>
    Co-authored-by: Ildar Iskhakov <ildar.iskhakov@grafana.com>
    Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com>
    Co-authored-by: Julia <ferril.darkdiver@gmail.com>
    Co-authored-by: maskin25 <kengurek@gmail.com>
    Co-authored-by: Matias Bordese <mbordese@gmail.com>
    Co-authored-by: Matvey Kukuy <motakuk@gmail.com>
    Co-authored-by: Michael Derynck <michael.derynck@grafana.com>
    Co-authored-by: Richard Hartmann <richih@richih.org>
    Co-authored-by: Robby Milo <robbymilo@fastmail.com>
    Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
    Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
    Co-authored-by: Yulia Shanyrova <yulia.shanyrova@grafana.com>
2022-06-03 08:09:47 -06:00

1.1 KiB

+++ title = "OnCall User Groups HTTP API" aliases = ["/docs/grafana-cloud/oncall/oncall-api-reference/user_groups/"] weight = 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/