SPspectate
Escalation paths

List escalation paths

Returns the team's paths with their steps, the default path first, then by name.

get/escalation-paths

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Paths per page, 1 to 100.

Response

Paginated set of EscalationPath

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "On-call engineers",
      "working_hours": {
        "timezone": "Europe/Amsterdam",
        "start_time": "09:00",
        "end_time": "17:00",
        "description": "Mon–Fri 09:00–17:00 (Europe/Amsterdam)"
      },
      "steps": [
        {
          "key": "notify_on_call-1",
          "delay_minutes": 5,
          "channel": {
            "name": "On-call email"
          },
          "schedule": {
            "name": "Primary"
          },
          "rotation": {
            "name": "Primary"
          },
          "users": [
            {
              "name": "Jane Doe",
              "email": "jane@example.com"
            }
          ],
          "conditions": [
            {
              "key": "env",
              "description": "Severity is Critical or High"
            }
          ]
        }
      ],
      "warnings": [
        {
          "message": "Channel Ops Slack is disabled and will be skipped."
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.