On Call

Fetch on-calls

get

Get list of on-call schedules for a team

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this 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: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Fetch an on-call

get

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

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

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

Path parameters

oncallIdstringRequired

oncallId parameter

Query parameters

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

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: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Is a user on-call?

get

Check whether a personal is currently oncall or not

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

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

Query parameters

idstringRequired

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: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Fetch upcoming shifts from multiple schedules

get

Fetch upcoming shifts from multiple schedules

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

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

Query parameters

idstringRequired

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: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Fetch all currently active on-call shifts

get

Get a list of users who are currently on call

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this 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: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}