On-call

Fetch on-calls

get

Get list of on-call schedules for a team

Header parameters

x-api-keystringRequired

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

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/on-calls

HTTPcURLJavaScriptPython

GET /on-calls HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Create an on-call

post

Create an on-call schedule.

Common case: send users plus a top-level rotation. Spike creates one primary layer and derives the shift order from the order of users.

Advanced: send a layers array instead to create multiple escalation tiers in one call.

The x-team-id header is REQUIRED and sets which team the on-call belongs to.

---

Custom slots (optional): restrict when this layer is on-call.

• customiseFor: "day" with fromTime/toTime for a single daily window.

• customiseFor: "week" with a conditions array to pick specific days (one entry per day window — add as many as you need).

Times are HH:mm (24-hour) in the schedule timezone; days are lowercase names.

        {
          "customiseFor": "week",
          "conditions": [
            { "fromDayOfWeek": "monday",    "fromTime": "00:00", "toDayOfWeek": "tuesday",   "toTime": "00:00" },
            { "fromDayOfWeek": "tuesday",   "fromTime": "00:00", "toDayOfWeek": "wednesday", "toTime": "00:00" },
            { "fromDayOfWeek": "wednesday", "fromTime": "00:00", "toDayOfWeek": "thursday",  "toTime": "00:00" }
          ]
        }

Header parameters

x-api-keystringRequired

Your API key. Find it in the Spike dashboard under Settings → API.

x-team-idstringRequired

REQUIRED to create an on-call — the id of the team the on-call will belong to. Must be a team in your organisation.

Body

application/json

Provide top-level users + rotation (one primary layer) OR a layers array (takes precedence when present).

namestringRequired

Display name for the on-call.

usersstring[] · min: 1Optional

Rotation members for the primary layer, in rotation order.

timezonestringOptional

IANA timezone for handoff times (e.g. America/New_York). Defaults to the owner timezone or Etc/UTC.

descstringOptional

Optional description.

Responses

201

On-call created; the full on-call is returned

application/json

400

Validation error (missing name, missing x-team-id, unknown user, or bad rotation)

application/json

401

Unauthorized

application/json

409

No owner/team could be resolved for this organisation

application/json

post

/on-calls

HTTPcURLJavaScriptPython

POST /on-calls HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "Backend on-call",
  "users": [
    "<user-id-1>",
    "<user-id-2>"
  ],
  "rotation": {
    "length": 1,
    "unit": "weeks",
    "handoff": "10:00",
    "handoffDay": "monday"
  }
}

Weekly rotation, hands off Monday 10:00Custom cadence — every 2 daysCustom cadence — every 2 weeksTwo layers (primary + escalation)With a daily on-call window (09:00–17:00)With weekly day-of-week windows (multiple days)

{}

Fetch an on-call

get

Get details about a specific on-call including layers, shifts and users

Path parameters

oncallIdstringRequired

oncallId parameter

Query parameters

fromstringRequiredExample: 2025-01-24T00:00:00.000Z

Header parameters

x-api-keystringRequired

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

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/on-calls/{oncallId}

HTTPcURLJavaScriptPython

GET /on-calls/{oncallId}?from=text HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Edit an on-call

put

Update an on-call's top-level properties (name and/or team). Layers are not changed here — use the layer endpoints to edit rotations. Send only the fields you want to change.

Path parameters

oncallIdstringRequired

The on-call ObjectId.

Header parameters

x-api-keystringRequired

Your API key. Find it in the Spike dashboard under Settings → API.

x-team-idstringOptional

Optional. Team to scope the request to. Defaults to your organisation's default team when omitted.

Body

application/json

namestringOptional

New display name.

teamIdstringOptional

Move the on-call to this team (ObjectId).

Responses

200

On-call updated; the full on-call is returned

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

On-call not found

application/json

put

/on-calls/{oncallId}

HTTPcURLJavaScriptPython

PUT /on-calls/{oncallId} HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "Backend on-call (EU)"
}

RenameMove to another team

{}

Add a layer

post

Add a new layer (rotation) to an on-call.

It's appended after the existing layers as the next escalation tier; shifts are derived from the order of users. Returns the full updated on-call.

---

Custom timings (optional): restrict when this layer is on-call.

• customiseFor: "day" with fromTime/toTime for a single daily window.

• customiseFor: "week" with a conditions array to pick specific days (one entry per day window — add as many as you need).

Times are HH:mm (24-hour) in the schedule timezone; days are lowercase names.

        {
          "customiseFor": "week",
          "conditions": [
            { "fromDayOfWeek": "monday",    "fromTime": "00:00", "toDayOfWeek": "tuesday",   "toTime": "00:00" },
            { "fromDayOfWeek": "tuesday",   "fromTime": "00:00", "toDayOfWeek": "wednesday", "toTime": "00:00" },
            { "fromDayOfWeek": "wednesday", "fromTime": "00:00", "toDayOfWeek": "thursday",  "toTime": "00:00" }
          ]
        }

Path parameters

oncallIdstringRequired

The on-call ObjectId.

Header parameters

x-api-keystringRequired

Your API key. Find it in the Spike dashboard under Settings → API.

x-team-idstringOptional

Optional. Team to scope the request to. Defaults to your organisation's default team when omitted.

Body

application/json

usersstring[] · min: 1Required

Rotation members for this layer, in order.

descstringOptional

Optional layer description.

Responses

201

Layer added; the full on-call is returned

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

On-call not found

application/json

post

/on-calls/{oncallId}/layers

HTTPcURLJavaScriptPython

POST /on-calls/{oncallId}/layers HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "users": [
    "<user-id-2>",
    "<user-id-1>"
  ],
  "rotation": {
    "length": 1,
    "unit": "weeks",
    "handoffDay": "monday"
  }
}

Secondary weekly layerEvery 3 daysLayer with a daily on-call window

{}

Edit a layer

put

Send any subset of users, rotation, desc; omitted fields keep their current values. When you send rotation, its fields merge onto the current cadence (e.g. send only { "rotation": { "length": 2 } } to change just the length). Returns the full updated on-call.

---

Custom slots (optional): restrict when this layer is on-call.

• customiseFor: "day" with fromTime/toTime for a single daily window.

• customiseFor: "week" with a conditions array to pick specific days (one entry per day window — add as many as you need).

Times are HH:mm (24-hour) in the schedule timezone; days are lowercase names.

        {
          "customiseFor": "week",
          "conditions": [
            { "fromDayOfWeek": "monday",    "fromTime": "00:00", "toDayOfWeek": "tuesday",   "toTime": "00:00" },
            { "fromDayOfWeek": "tuesday",   "fromTime": "00:00", "toDayOfWeek": "wednesday", "toTime": "00:00" },
            { "fromDayOfWeek": "wednesday", "fromTime": "00:00", "toDayOfWeek": "thursday",  "toTime": "00:00" }
          ]
        }

Path parameters

oncallIdstringRequired

The on-call ObjectId.

layerIdstringRequired

The layer ObjectId (from layers[].id).

Header parameters

x-api-keystringRequired

Your API key. Find it in the Spike dashboard under Settings → API.

x-team-idstringOptional

Optional. Team to scope the request to. Defaults to your organisation's default team when omitted.

Body

application/json

usersstring[] · min: 1Optional

Replacement rotation members, in order (replaces the existing list).

descstringOptional

New layer description.

Responses

200

Layer updated; the full on-call is returned

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

On-call or layer not found

application/json

put

/on-calls/{oncallId}/layers/{layerId}

HTTPcURLJavaScriptPython

PUT /on-calls/{oncallId}/layers/{layerId} HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "users": [
    "<user-id-1>",
    "<user-id-2>"
  ]
}

Replace members, keep scheduleSwitch to every 2 daysChange handoff time onlySet a daily on-call windowRemove custom timings (send null)

{}

Delete a layer

delete

Delete a layer from an on-call. An on-call must always keep at least one layer, so deleting the last remaining layer returns 409. Returns the full updated on-call.

Path parameters

oncallIdstringRequired

The on-call ObjectId.

layerIdstringRequired

The layer ObjectId (from layers[].id).

Header parameters

x-api-keystringRequired

Your API key. Find it in the Spike dashboard under Settings → API.

x-team-idstringOptional

Optional. Team to scope the request to. Defaults to your organisation's default team when omitted.

Responses

200

Layer deleted; the full on-call is returned

application/json

objectOptional

401

Unauthorized

application/json

404

On-call or layer not found

application/json

409

Cannot delete the only remaining layer

application/json

delete

/on-calls/{oncallId}/layers/{layerId}

HTTPcURLJavaScriptPython

DELETE /on-calls/{oncallId}/layers/{layerId} HTTP/1.1
Host: api.spike.sh
x-api-key: text
Accept: */*

{}

Is a user on-call?

get

Check whether a personal is currently oncall or not

Query parameters

idstringRequired

Header parameters

x-api-keystringRequired

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

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/oncalls/am-i-on-call

HTTPcURLJavaScriptPython

GET /oncalls/am-i-on-call?id=text HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch upcoming shifts from multiple schedules

get

Fetch upcoming shifts from multiple schedules

Query parameters

idstringRequired

Header parameters

x-api-keystringRequired

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

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/oncalls/upcoming-shifts

HTTPcURLJavaScriptPython

GET /oncalls/upcoming-shifts?id=text HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch all currently active on-call shifts

get

Get a list of users who are currently on call

Header parameters

x-api-keystringRequired

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

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/oncalls/all-active-on-call-shifts

HTTPcURLJavaScriptPython

GET /oncalls/all-active-on-call-shifts HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}