Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
OnCall user groups HTTP API
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"
}
}
],
"current_page_number": 1,
"page_size": 50,
"total_pages": 1
}
Note: The response is paginated. You may need to make multiple requests to get all records.
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/