GET
/api/v1/groups
Lists the team's monitor groups in dashboard order. parent_id conveys the two-level tree; monitors_count is the monitors directly in each group.
Response
{
"total": 2,
"data": [
{
"id": 7,
"name": "Agency Clients",
"description": "Everything billed monthly",
"parent_id": null,
"sort_order": 0,
"monitors_count": 12,
"created_at": "2026-08-21T14:02:11Z",
"updated_at": "2026-08-21T14:02:11Z"
},
{
"id": 9,
"name": "Aurora Tickets",
"description": null,
"parent_id": 7,
"sort_order": 0,
"monitors_count": 4,
"created_at": "2026-08-21T14:05:37Z",
"updated_at": "2026-08-21T14:05:37Z"
}
]
}Groups are returned in dashboard order. parent_id conveys the two-level tree.
Fields
name | Unique within the team, max 60 characters |
description | Optional, max 255 characters |
parent_id | The parent group for a subgroup, or null at the top level. Nesting is one level deep: a subgroup cannot have children. |
sort_order | Position within the sibling set; new groups append to the end |
monitors_count | Monitors directly in this group (subgroup monitors are counted in the subgroup) |
Monitors join a group through the group_id field on the monitor endpoints.