Skip to main content
GET
Get maintenance window

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Personal keys (gm_pat_) act as you, limited by your role and the key's scopes; organization keys (gm_api_) act for one organization. Send X-Organization-Id with every org-scoped request.

Headers

X-Organization-Id
string
required

ID of the organization to act in. Required with API keys. A user session may omit it and acts in its active organization.

Example:

"k2p9x7w4m1n8b3v6c5z0q2r7"

Path Parameters

statusPageId
string
required

Status page ID.

maintenanceId
string
required

Maintenance ID.

Response

OK

id
string
required
statusPageId
string
required
title
string
required
description
string
required
status
string
required
scheduledStartAt
string<date-time>
required
scheduledEndAt
string<date-time>
required
actualStartAt
string | null
required
actualEndAt
string | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
userId
string
required
organizationId
string
required
updates
any[]
required