Get Group

Retrieve a group with its monitors, child groups and breadcrumb path

Overview

Returns one group, including the monitors assigned to it, its direct child groups, and the path from the top-level group down to it.

GET /api/groups/{groupId}

Authentication

X-API-Key: YOUR_API_KEY or Authorization: Bearer YOUR_JWT. A read-only API key is sufficient.

Path parameters

Parameter	Type	Description
groupId	UUID	The group to retrieve.

Response

200 OK

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "0b0f7a0e-2c3d-4f55-9a11-6f1c2f1d9a10",
    "project_id": "7c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "created_by": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Web Services",
    "description": "Frontend and web services",
    "parent_group_id": "660e8400-e29b-41d4-a716-446655440001",
    "created_at": "2026-09-30T10:30:00.000Z",
    "updated_at": "2026-09-30T10:30:00.000Z",
    "check_count": 2,
    "monitors": [
      {
        "id": "8d9e0f1a-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
        "name": "Marketing site",
        "target": "https://example.com",
        "type": "HTTP",
        "status": "active",
        "group_id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "children": [],
    "path": [
      { "id": "660e8400-e29b-41d4-a716-446655440001", "name": "Production" },
      { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Web Services" }
    ]
  }
}

Field	Type	Description
monitors[].status	string	active or paused.
monitors[].type	string	The monitor type.
children	array	Direct child groups (group objects with check_count).
path	array	{ id, name } entries from the top-level ancestor to this group, inclusive.

The remaining fields are described in Group object.

Errors

Status	Code	Cause
401	MISSING_AUTH / INVALID_API_KEY	Missing or invalid credentials.
404	RESOURCE_NOT_FOUND	Group not found. The group does not exist, or belongs to another organization or project.
500	INTERNAL_ERROR	Failed to get group.

Example

cURL

curl https://api.uptimeio.com/api/groups/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: YOUR_API_KEY"