For the complete documentation index, see llms.txt. This page is also available as Markdown.

Incidents

Create and read incidents. Incident status is one of NACK (triggered), ACK (acknowledged) or RES (resolved).

Fetch incidents

get

Get a list of all the incidents for a team.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

A paginated envelope — NOT a bare array. The response also carries dashboard-only keys (org, integrations, services, escalations, incidentStatuses, *Filtered, totalFilters, featureFlag, jiraConnected, clickupConnected, linearConnected, taskManagementFlag, videoConferencingFlag, helpdeskFlag, meetConnected, zoomConnected, filtersApplied, userIsAuthorizedToTakeActionOnIncidents) that are not part of the supported contract.

application/json

Envelope object — NOT a bare array.

totalIncidentsnumberOptional
totalOpenIncidentsnumberOptional
get/incidents

Get all incident occurrences

get

Fetch all incident occurrences with filtering options for date range, teams, status, service, integration, and pagination.

Query Parameters:

  • start (required): Start date in ISO 8601 format (e.g., 2026-01-01T00:00:00Z)

  • end (required): End date in ISO 8601 format (e.g., 2026-02-01T23:59:59Z)

  • teams: Comma-separated team IDs

  • status: Comma-separated status values (ACK=Acknowledged, RES=Resolved, NACK=Not Acknowledged)

  • service: Comma-separated service IDs

  • integration: Integration ID

  • page: Page number for pagination (default: 1)

  • perPage: Number of results per page (default: 25, max: 100)

Example:

GET /incidents/all-occurrences?start=2026-01-01T00:00:00Z&end=2026-02-01T23:59:59Z&teams=64a1b2c3d4e5f6789012345a&status=ACK,RES&page=1&perPage=25
Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

Query parameters
startstringRequired

Start date in ISO 8601 format

Example: 2026-01-01T00:00:00Z
endstringRequired

End date in ISO 8601 format

Example: 2026-02-01T23:59:59Z
teamsstringOptional

Comma-separated team IDs (optional)

Example: 64a1b2c3d4e5f6789012345a,64a1b2c3d4e5f6789012345b
statusstringOptional

Comma-separated status values (optional)

Example: ACK,RES,NACK
servicestringOptional

Comma-separated service IDs (optional)

Example: 64a1b2c3d4e5f6789012345c,64a1b2c3d4e5f6789012345d
integrationstringOptional

Integration ID (optional)

Example: 64a1b2c3d4e5f6789012345e
pagestringOptional

Page number for pagination

Example: 1
perPagestringOptional

Results per page (default: 25, max: 100)

Example: 25
Header parameters
x-api-keystringRequired

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

Responses
200

A bare JSON array of incident occurrences — not wrapped in an envelope.

application/json
_idstringOptional
counterIdstringOptional

Human-facing id, <teamUid>-<counter>. Accepted anywhere an incident id is taken.

messagestringOptional
statusstring · enumOptional

Lifecycle state of the incident. NACK = triggered (nobody has acknowledged it yet). ACK = acknowledged (a responder is on it). RES = resolved. These three literals are the only values the API ever returns or accepts — there is no triggered/acknowledged/resolved spelling.

Example: NACKPossible values:
prioritystring · enumOptionalPossible values:
severitystring · enumOptionalPossible values:
counternumberOptional
orgstringOptional
teamsstring[]Optional
integrationobjectOptional
serviceobjectOptional
escalationobjectOptional
respondersobject[]Optional
createdAtstring · date-timeOptional
NACK_atstring · date-timeOptional
get/incidents/all-occurrences

Fetch incident info

get

Get details of an incident. Includes incident title, metadata, priority, severity, and activity log

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json

Envelope. Additional dashboard-only keys (muteOptions, timeToEndmute, showRepeatedIncidents, featureFlag, *Connected, *FeatureFlag) are also present.

orgobjectOptional
durationstringOptional
metadataobjectOptional
groupedIncidentobjectOptional
repeatedIncidentsobject[]Optional
commentsobject[]Optional
get/incidents/{counterId}

Create an incident

post

Creates an incident and sends alerts. The body must contain integrationWebhook — the integration token (or its full https://hooks.spike.sh/{token}/push-events URL). Routing (service and escalation policy) comes from that integration, so this endpoint has NO integration or escalation field. title, priority, severity and metadata are forwarded to the webhook. Omitting integrationWebhook returns 422.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Body

The handler only reads integrationWebhook; every other field is forwarded verbatim to the integration webhook at https://hooks.spike.sh/{token}/push-events, which turns it into the incident. There is no integration or escalation field on this endpoint — routing is determined by the integration the token belongs to.

integrationWebhookstringRequired

REQUIRED. The integration token (from GET /integrations), or the full webhook URL https://hooks.spike.sh/{token}/push-events. A bare token is expanded to the full URL. Omitting this returns 422.

Example: a1b2c3d4e5f6a7b8c9d0
titlestringOptional

Incident title. Becomes the incident message.

Example: High CPU on api-prod-3
messagestringOptional

Alias for title.

Example: High CPU on api-prod-3
metadataobjectOptional

Arbitrary key/value context attached to the incident.

Example: {"instanceId":"i-0abc123","region":"us-east-1"}
prioritystring · enumOptionalExample: p1Possible values:
severitystring · enumOptionalExample: sev1Possible values:
Responses
200

The incident as returned by the escalation engine.

application/json
existingIncidentobject · nullableOptional

Set when the event de-duplicated onto an already-open incident.

newIncidentbooleanOptional
isSuppressedbooleanOptional
autoResolvedbooleanOptional
doNotCreateIncidentbooleanOptional
post/incidents/create

Fetch previous occurances of an incident

get

Fetches previous occurances of an incident.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
currentPagenumberOptional
perPagenumberOptional
totalnumberOptional
get/incidents/{counterId}/get-previous-incidents

Fetch a previous occurance of an incident

get

Fetches a previous occurance of an incident with it's details.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

_idstringRequired

_id parameter

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
orgobjectOptional
durationstringOptional
metadataobjectOptional
groupedIncidentobjectOptional
get/incidents/{counterId}/previous-incident/{_id}

Add responder to an incident

post

Add a responder to an incident. Accepts an array of incident counterIds (116, prim-122) and user ids.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Body

ids is an ARRAY of incident counterIds or _ids. Also answers on /incidents/reassign/multi.

idsstring[]RequiredExample: ["eng-116"]
userstringRequired

The User _id of the responder. Must belong to your organisation.

Example: 6a3c2d5e0f9b8c7d6e5f4a32
Responses
200

On success { reassigned: true }. When the user is already a responder the handler still answers 200 but with { reassigned: false, alreadyAssigned: true, message }.

application/json
reassignedbooleanOptional
alreadyAssignedbooleanOptional
messagestringOptional
post/incidents/reassign

Fetch incident context

get

Fetches an overview of an incident

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
durationstringOptional
groupedIncidentobjectOptional
get/incidents/{counterId}/incident-context

Fetch incident activity log

get

Get the activity log for an incident

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

The incident counterId, e.g. eng-116.

Example: eng-116
Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

An envelope of { incident, activities } — NOT a bare array of activities.

application/json
get/incidents/{counterId}/activity-log

Remove responder from an incident

post

Remove a responder from an incident. Accepts an array of incident counterIds (116, prim-122) and user ids.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Body

ids is an ARRAY of incident counterIds or _ids. Also answers on /incidents/remove-responder/multi.

idsstring[]RequiredExample: ["eng-116"]
userstringRequired

The User _id of the responder. Must belong to your organisation.

Example: 6a3c2d5e0f9b8c7d6e5f4a32
Responses
200

Successful response

application/json
removedbooleanOptional
post/incidents/remove-responder

Fetch all the acknowledged incidents

get
Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

A bare JSON array of acknowledged incidents.

application/json
_idstringOptional
counterIdstringOptional

Human-facing id, <teamUid>-<counter>. Accepted anywhere an incident id is taken.

messagestringOptional
statusstring · enumOptional

Lifecycle state of the incident. NACK = triggered (nobody has acknowledged it yet). ACK = acknowledged (a responder is on it). RES = resolved. These three literals are the only values the API ever returns or accepts — there is no triggered/acknowledged/resolved spelling.

Example: NACKPossible values:
prioritystring · enumOptionalPossible values:
severitystring · enumOptionalPossible values:
counternumberOptional
orgstringOptional
teamsstring[]Optional
integrationobjectOptional
serviceobjectOptional
escalationobjectOptional
respondersobject[]Optional
createdAtstring · date-timeOptional
NACK_atstring · date-timeOptional
get/incidents/acknowledged

Fetch all the triggered incidents

get
Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

A bare JSON array of triggered (NACK) incidents.

application/json
_idstringOptional
counterIdstringOptional

Human-facing id, <teamUid>-<counter>. Accepted anywhere an incident id is taken.

messagestringOptional
statusstring · enumOptional

Lifecycle state of the incident. NACK = triggered (nobody has acknowledged it yet). ACK = acknowledged (a responder is on it). RES = resolved. These three literals are the only values the API ever returns or accepts — there is no triggered/acknowledged/resolved spelling.

Example: NACKPossible values:
prioritystring · enumOptionalPossible values:
severitystring · enumOptionalPossible values:
counternumberOptional
orgstringOptional
teamsstring[]Optional
integrationobjectOptional
serviceobjectOptional
escalationobjectOptional
respondersobject[]Optional
createdAtstring · date-timeOptional
NACK_atstring · date-timeOptional
get/incidents/triggered

Fetch incidents assigned to a user

get
Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Query parameters
idstringRequired
Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
get/incidents/assigned-to-user

Fetch incident bar overview

get

Get an overview of the incidents in the team. This includes the total number of incidents, number of open incidents and the number of incidents assigned

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Query parameters
idstringRequired
Header parameters
x-api-keystringRequired

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

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
affectedServicesobject[]Optional
get/incidents/overview

Last updated