Spike.sh
DashboardWebsiteHUB
Spike API docs
Spike API docs
  • Page
  • About
  • API reference
    • Incidents
      • Create
      • Get previous incidents
      • Incident context
      • Activity log
      • Triggered
      • Acknowledged
      • Assigned to user
      • Acknowledge
      • Resolve
      • Escalate
      • Priority
      • Severity
    • Services
      • Create
      • Affected
    • On calls
    • Integrations
      • Available
      • Create
      • Archive
    • Orgs
      • Members
      • Info
    • Teams
      • Get all teams
      • Get my teams
    • Oncalls
      • Am i on call
      • Upcoming shifts
    • Status page
      • All
      • Component
        • Create
      • Incidents
      • Planned maintenance
        • Upcoming
        • Create
      • Subscribers
      • Incident
        • New
  • Specification
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub

Page

NextAbout

Last updated 4 months ago

Was this helpful?

For questions, reach out to us at . You can find your API key on .

Key Points

  • Team-Based Scoping: Users, Escalations, Incidents, Services, Integrations, and On-call schedules are scoped to a team. A valid Team ID (x-team-id) is required in the header for most requests.

  • Authentication: Every API request must include an API key (x-api-key) in the headers. The Team ID is required for most, but not all, routes.

  • User-Specific Operations:

    • To perform actions for a user (e.g., fetching upcoming shifts), retrieve User IDs from org routes.

    • Some routes require a User ID as a query parameter.

  • The API does not support archiving operations.

developers@spike.sh
this page