---
title: "Get Incident Episode"
method: POST
path: "/incident-episode/{id}/get-item"
tags: ["Incident Episode"]
---

# Get Incident Episode

`POST /incident-episode/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/incident-episode/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/incident-episode/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Incident Episode by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` IncidentEpisodeSelectSchema: Select schema for IncidentEpisode. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `title` boolean
    - `description` boolean
    - `episodeNumber` boolean
    - `episodeNumberWithPrefix` boolean
    - `currentIncidentStateId` boolean
    - `incidentSeverityId` boolean
    - `rootCause` boolean
    - `lastIncidentAddedAt` boolean
    - `resolvedAt` boolean
    - `allIncidentsResolvedAt` boolean
    - `firstPagedAt` boolean
    - `assignedToUserId` boolean
    - `assignedToTeamId` boolean
    - `onCallDutyPolicies` OnCallDutyPolicyRelationSelectSchema: What a select may name of the OnCallDutyPolicy records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `repeatPolicyIfNoOneAcknowledgesNoOfTimes` boolean
    - `isOnCallPolicyExecuted` boolean
    - `incidentCount` boolean
    - `titleTemplate` boolean
    - `descriptionTemplate` boolean
    - `isManuallyCreated` boolean
    - `labels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `name` boolean
      - `projectId` boolean
      - `color` boolean
      - `isArchived` boolean
    - `createdByUserId` boolean
    - `isOwnerNotifiedOfEpisodeCreation` boolean
    - `groupingKey` boolean
    - `incidentGroupingRuleId` boolean
    - `remediationNotes` boolean
    - `postmortemNote` boolean
    - `postUpdatesToWorkspaceChannels` boolean
    - `isVisibleOnStatusPage` boolean
    - `declaredAt` boolean
    - `shouldStatusPageSubscribersBeNotifiedOnEpisodeCreated` boolean
    - `subscriberNotificationStatusMessage` boolean
    - `isPrivate` boolean

## Response `200`

Successful response

- object
  - `data` IncidentEpisode
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `title` string, required: Title of this incident episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `description` string: Description of this incident episode. This is in markdown format. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `episodeNumber` number: Auto-incrementing episode number per project. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `episodeNumberWithPrefix` string: Episode number with prefix (e.g., 'IE-42' or '#42'). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `currentIncidentStateId` string, uuid, required: Current Incident State ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `incidentSeverityId` string, uuid: Incident Severity ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `rootCause` string: User-documented root cause of this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `lastIncidentAddedAt` object: When the last incident was added to this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `resolvedAt` object: When this episode was resolved. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `allIncidentsResolvedAt` object: When all incidents in this episode were first detected as resolved. Used for resolve delay calculation. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `firstPagedAt` object: When an on-call policy or a direct page first notified someone about this episode. Empty until someone is paged. Set by OneUptime. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `assignedToUserId` string, uuid: User ID who is assigned to this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `assignedToTeamId` string, uuid: Team ID that is assigned to this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `onCallDutyPolicies` object[]: List of on-call duty policies to execute for this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
      - `_id` string, uuid: Unique identifier for the entity
    - `isOnCallPolicyExecuted` boolean, required: Whether the on-call policy has been executed for this episode. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `incidentCount` number, required: Denormalized count of incidents in this episode. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `titleTemplate` string: Template used to generate the episode title. Stored for dynamic variable updates. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `descriptionTemplate` string: Template used to generate the episode description. Stored for dynamic variable updates. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `isManuallyCreated` boolean, required: Whether this episode was manually created vs auto-created by a rule. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
      - `_id` string, uuid: Unique identifier for the entity
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `isOwnerNotifiedOfEpisodeCreation` boolean, required: Are owners notified when this episode is created? Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `groupingKey` string: Key used for grouping incidents into this episode. Generated from groupByFields of the matching rule. When a private incident opened the episode, its title is in the key only as a keyed hash. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `incidentGroupingRuleId` string, uuid: ID of the Incident Grouping Rule that created this episode (if applicable). Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `remediationNotes` string: User-documented remediation steps and notes for this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `postmortemNote` string: User-documented postmortem summary for this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `postUpdatesToWorkspaceChannels` object: Workspace channels to post episode updates to (e.g., Slack, Microsoft Teams). Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `isVisibleOnStatusPage` boolean, required: Should this episode be visible on the status page? Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `declaredAt` object: When this episode was declared. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]
    - `shouldStatusPageSubscribersBeNotifiedOnEpisodeCreated` boolean: Should status page subscribers be notified when this episode is created? Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `subscriberNotificationStatusOnEpisodeCreated` 'Skipped' | 'Pending' | 'InProgress' | 'Success' | 'Failed': Status of notification sent to subscribers when this episode was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `subscriberNotificationStatusMessage` string: Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [No access - you don't have permission for this operation]
    - `isPrivate` boolean: If true, this incident episode is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Episode], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Episode]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)
