On-call Overrides

Get all overrides

get

Path parameters

oncall_idstringRequired

oncall_id parameter

Query parameters

fromstringRequiredExample: <iso timestamp>

tostringRequiredExample: <iso timestamp>

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/oncalls/{oncall_id}/overrides

HTTPcURLJavaScriptPython

GET /oncalls/{oncall_id}/overrides?from=text&to=text HTTP/1.1
Host: api.spike.sh
x-api-key: text
Accept: */*

{}

Delete an override

delete

Path parameters

oncall_idstringRequired

oncall_id parameter

override_idstringRequired

override_id parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

delete

/on-calls/{oncall_id}/overrides/{override_id}/remove

HTTPcURLJavaScriptPython

DELETE /on-calls/{oncall_id}/overrides/{override_id}/remove HTTP/1.1
Host: api.spike.sh
x-api-key: text
Accept: */*

{}

Add an override

post

Add a temporary override to an on-call schedule. Overrides allow you to temporarily assign a different user to cover an on-call shift.

All timestamps should be in ISO 8601 format (e.g., 2025-01-24T00:00:00.000Z).

Path parameters

oncall_idstringRequired

oncall_id parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Body

application/json

userstringOptional

startstringOptional

endstringOptional

descstringOptional

timezonestringOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

post

/on-calls/{oncall_id}/overrides/add

HTTPcURLJavaScriptPython

POST /on-calls/{oncall_id}/overrides/add HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "user": "<user-id>",
  "start": "2025-01-24T00:00:00.000Z",
  "end": "2025-01-25T00:00:00.000Z",
  "desc": "Covering for vacation",
  "timezone": "UTC"
}

{}