On-Call API › Maintenance windows
List maintenance windows
GET/api/v1/maintenance-windows
Lists the organization's maintenance windows — scheduled, running and past.
With active=true, only the windows in effect right now.
Permission (API-key scope): oncall:maintenance:read.
Authorization
bearerAuth(oncall:maintenance:read)apiKeyHeader(oncall:maintenance:read)
Parameters
Query parameters
activestringtruefor only the windows in effect now.
Responses
200
The windows.
dataarray of MaintenanceWindow requiredShow MaintenanceWindow properties
idstringorg_idstringtitlestringbodystringWhat the maintenance does.starts_atstring (date-time)ends_atstring (date-time)created_bystringcreated_atstring (date-time)ended_atstring (date-time)Set when the window was ended early.silence_oncallbooleanWhether paging is held back during the window.
successboolean required
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
Example request
curl -X GET 'https://evohub.io/api/v1/maintenance-windows' \
-H 'Authorization: Bearer <TOKEN>'