---
title: "Preview team escalation schedule"
method: POST
path: "/api/public/v1/team-escalations/{id}/preview"
tags: ["TeamEscalationsResource"]
---

# Preview team escalation schedule

`POST /api/public/v1/team-escalations/{id}/preview`

## Request

- Base URL: `https://allquiet.app` (the document declares no server; this is the origin it was published from)
- URL: `https://allquiet.app/api/public/v1/team-escalations/{id}/preview`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/allquiet/apis/all-quiet-public-api/docs/api/public/v1/team-escalations/:id/preview/post.ts> (a function with typed inputs; its response is checked against the schema)

Calculates on-call schedule segments, rotation handoffs, and human-readable schedule and rotation descriptions for draft escalation tiers over a date range. Nothing is persisted.

**Required API key permissions**

- **Scope:** `team-escalations:get`
- **Accepted key types:** organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
- **Access:** Access is checked against the specific resource (team or organization reachability).
- **Required team role (user-linked keys only):** Member
- Organization API keys are not subject to organization or team role checks.
- **Notes:** Nothing is persisted. Membership ids in the request must belong to the team.

## Path parameters

- `id` string, uuid, required

## Request body

- AllQuietApiPublicTeamEscalationsTeamEscalationsPreviewRequest
  - `start` string, date, required
  - `end` string, date, required
  - `escalationTiers` AllQuietApiPublicTeamEscalationsTeamResourceTier[], nullable
    - `autoEscalationAfterMinutes` integer, nullable
    - `autoEscalationMode` string, nullable
    - `autoEscalationEnabled` boolean, nullable
    - `autoEscalationSeverities` string[], nullable
    - `repeats` integer, nullable
    - `repeatsAfterMinutes` integer, nullable
    - `repeatsTierEscalationMode` string, nullable
    - `schedules` AllQuietApiPublicTeamEscalationsTeamResourceSchedule[], nullable
      - `displayName` string, nullable
      - `scheduleSettings` AllQuietApiPublicTeamEscalationsTeamResourceScheduleSettings
        - `start` string, time, nullable
        - `end` string, time, nullable
        - `selectedDays` string[], nullable
        - `weeklySchedules` AllQuietApiTeamsModelsTimeFilter[], nullable
          - `selectedDays` string[], nullable
          - `from` string, time, nullable
          - `until` string, time, nullable
          - `duration` string, date-span
        - `effectiveFrom` string, date, nullable
        - `effectiveUntil` string, date, nullable
      - `rotationSettings` AllQuietApiPublicTeamEscalationsTeamResourceRotationSettings
        - `repeats` string, required
        - `startsOnDayOfWeek` string, nullable
        - `startsOnTime` string, time, nullable
        - `startsOnDateOfMonth` integer, nullable
        - `customRepeatUnit` string, nullable
        - `customRepeatValue` integer, nullable
        - `effectiveFrom` string, date, nullable
        - `autoRotationSize` integer, nullable
        - `rotationMode` string, nullable
      - `roundRobinSettings` AllQuietApiTeamsModelsRoundRobinSettings
        - `roundRobinSize` integer, nullable
      - `rotations` AllQuietApiPublicTeamEscalationsTeamResourceRotation[], nullable
        - `members` AllQuietApiPublicTeamEscalationsTeamResourceRotationMember[], nullable
          - `teamMembershipId` string, uuid, required
    - `autoEscalationTimeFilters` AllQuietApiTeamsModelsTimeFilter[], nullable
      - `selectedDays` string[], nullable
      - `from` string, time, nullable
      - `until` string, time, nullable
      - `duration` string, date-span
    - `autoAssignToTeams` string[], nullable
    - `autoAssignToTeamsSeverities` string[], nullable
    - `autoAssignToTeamsTimeFilters` AllQuietApiTeamsModelsTimeFilter[], nullable
      - `selectedDays` string[], nullable
      - `from` string, time, nullable
      - `until` string, time, nullable
      - `duration` string, date-span
    - `autoAssignToTeamsRepeatAlerts` boolean, nullable
  - `tierSettings` AllQuietApiTeamsModelsTierSettings
    - `repeats` integer, nullable
    - `repeatsAfterMinutes` integer, nullable
    - `autoEscalationMode` string, nullable

## Response `200`

OK

- AllQuietApiPublicTeamEscalationsTeamEscalationsPreviewResponse
  - `teamId` string, uuid
  - `start` string, date
  - `end` string, date
  - `timeZoneId` string, nullable
  - `schedules` AllQuietApiPublicTeamEscalationsTeamEscalationsPreviewSchedule[], nullable
    - `tierIndex` integer
    - `scheduleIndex` integer
    - `displayName` string, nullable
    - `isRotating` boolean
    - `days` AllQuietApiPublicTeamEscalationsTeamEscalationsPreviewDay[], nullable
      - `date` string, date
      - `segments` AllQuietApiPublicTeamEscalationsTeamEscalationsPreviewSegment[], nullable
        - `start` string, time, nullable
        - `end` string, time, nullable
        - `rotationIndex` integer, nullable
        - `members` AllQuietApiPublicTeamEscalationsTeamResourceRotationMember[], nullable
          - `teamMembershipId` string, uuid, required
    - `handoffs` AllQuietApiPublicTeamEscalationsTeamEscalationsPreviewHandoff[], nullable
      - `date` string, date
      - `time` string, time
      - `fromRotationIndex` integer, nullable
      - `toRotationIndex` integer, nullable
      - `fromMembers` AllQuietApiPublicTeamEscalationsTeamResourceRotationMember[], nullable
        - `teamMembershipId` string, uuid, required
      - `toMembers` AllQuietApiPublicTeamEscalationsTeamResourceRotationMember[], nullable
        - `teamMembershipId` string, uuid, required
    - `scheduleDescription` string, nullable
    - `rotationDescription` string, nullable

---

[API](https://skmtc.dev/allquiet/apis/all-quiet-public-api.md) - [All operations](https://skmtc.dev/allquiet/apis/all-quiet-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/allquiet/apis/all-quiet-public-api/revisions/a69168a82f2c?raw)