---
title: "OnCall user groups HTTP API | Grafana OnCall documentation"
description: "OnCall user groups HTTP API List user groups Required permission: grafana-oncall-app.chatops:read shell Copy 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:"
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# OnCall user groups HTTP API

## List user groups

**Required permission**: `grafana-oncall-app.chatops:read`

shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```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 ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```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
}
```

> **Note**: The response is [paginated](/docs/oncall/latest/oncall-api-reference/#pagination). You may need to make multiple requests to get all records.

Expand table

| 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/`