Skip to main content
GET
/
api
/
v1
/
status-pages
/
{id}
Get status page
curl --request GET \
  --url https://app.larm.dev/api/v1/status-pages/{id}
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Status",
    "slug": "acme",
    "description": "Current status of Acme services",
    "theme": "system",
    "primary_color": "#4F46E5",
    "enabled": true,
    "subscribers_enabled": true,
    "custom_domain": null,
    "domain_status": "none",
    "logo_light_url": null,
    "logo_dark_url": null,
    "url": "https://acme.status.larm.dev",
    "components": [
      {
        "type": "group",
        "id": "880e8400-e29b-41d4-a716-446655440000",
        "name": "Backend",
        "position": 0,
        "components": [
          {
            "type": "component",
            "id": "770e8400-e29b-41d4-a716-446655440000",
            "name": "API",
            "description": "REST API",
            "position": 0,
            "monitors": [
              {
                "monitor_id": "660e8400-e29b-41d4-a716-446655440000",
                "down_status": "major_outage"
              }
            ],
            "inserted_at": "2025-03-01T12:00:00Z",
            "updated_at": "2025-03-01T12:00:00Z"
          }
        ],
        "inserted_at": "2025-03-01T12:00:00Z",
        "updated_at": "2025-03-01T12:00:00Z"
      },
      {
        "type": "component",
        "id": "990e8400-e29b-41d4-a716-446655440000",
        "name": "Marketing site",
        "description": null,
        "position": 1,
        "monitors": [],
        "inserted_at": "2025-03-01T12:00:00Z",
        "updated_at": "2025-03-01T12:00:00Z"
      }
    ],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}
Requires status_pages:read permission.
​
id
string
required
Status page ID (UUID)
The components field is a polymorphic tree of group and component entries, ordered by position. Groups contain components (groups cannot nest). Ungrouped components appear at the top level. To replace the entire tree, use PUT structure. For individual CRUD on components and groups, see the Components and Component groups endpoints. 
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Status",
    "slug": "acme",
    "description": "Current status of Acme services",
    "theme": "system",
    "primary_color": "#4F46E5",
    "enabled": true,
    "subscribers_enabled": true,
    "custom_domain": null,
    "domain_status": "none",
    "logo_light_url": null,
    "logo_dark_url": null,
    "url": "https://acme.status.larm.dev",
    "components": [
      {
        "type": "group",
        "id": "880e8400-e29b-41d4-a716-446655440000",
        "name": "Backend",
        "position": 0,
        "components": [
          {
            "type": "component",
            "id": "770e8400-e29b-41d4-a716-446655440000",
            "name": "API",
            "description": "REST API",
            "position": 0,
            "monitors": [
              {
                "monitor_id": "660e8400-e29b-41d4-a716-446655440000",
                "down_status": "major_outage"
              }
            ],
            "inserted_at": "2025-03-01T12:00:00Z",
            "updated_at": "2025-03-01T12:00:00Z"
          }
        ],
        "inserted_at": "2025-03-01T12:00:00Z",
        "updated_at": "2025-03-01T12:00:00Z"
      },
      {
        "type": "component",
        "id": "990e8400-e29b-41d4-a716-446655440000",
        "name": "Marketing site",
        "description": null,
        "position": 1,
        "monitors": [],
        "inserted_at": "2025-03-01T12:00:00Z",
        "updated_at": "2025-03-01T12:00:00Z"
      }
    ],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}