--- title: "Get Alert Episode" method: POST path: "/alert-episode/{id}/get-item" tags: ["Alert Episode"] --- # Get Alert Episode `POST /alert-episode/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/alert-episode/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Alert Episode by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` AlertEpisodeSelectSchema: Select schema for AlertEpisode. 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 - `currentAlertStateId` boolean - `alertSeverityId` boolean - `rootCause` boolean - `lastAlertAddedAt` boolean - `resolvedAt` boolean - `allAlertsResolvedAt` boolean - `firstPagedAt` boolean - `assignedToUserId` boolean - `assignedToTeamId` boolean - `alertGroupingRuleId` 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 - `alertCount` 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 - `remediationNotes` boolean - `postUpdatesToWorkspaceChannels` boolean - `isPrivate` boolean ## Response `200` Successful response - object - `data` AlertEpisode - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [No access - you don't have permission for this operation] - `title` string, required: Title of this alert episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `description` string: Description of this alert episode. This is in markdown format. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `episodeNumber` number: Auto-incrementing episode number per project. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [No access - you don't have permission for this operation] - `episodeNumberWithPrefix` string: Episode number with prefix (e.g., 'AE-42' or '#42'). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [No access - you don't have permission for this operation] - `currentAlertStateId` string, uuid, required: Current Alert State ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `alertSeverityId` string, uuid: Alert Severity ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `rootCause` string: User-documented root cause of this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `lastAlertAddedAt` object: When the last alert was added to this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `resolvedAt` object: When this episode was resolved. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `allAlertsResolvedAt` object: When all alerts 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `assignedToTeamId` string, uuid: Team ID that is assigned to this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `alertGroupingRuleId` string, uuid: Alert Grouping Rule ID that created this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `onCallDutyPolicies` object[]: List of on-call duty policies to execute for this episode. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [No access - you don't have permission for this operation] - `alertCount` number, required: Denormalized count of alerts in this episode. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [No access - you don't have permission for this operation] - `groupingKey` string: Key used for grouping alerts into this episode. Generated from groupByFields of the matching rule. When a private alert opened the episode, its title is in the key only as a keyed hash. Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `postUpdatesToWorkspaceChannels` object: Workspace channels to post episode updates to (e.g., Slack, Microsoft Teams). Permissions - Create: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert Episode] - `isPrivate` boolean: If true, this alert 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, Alert Admin, Alert Member, Create Alert Episode], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode], Update: [Project Owner, Project Admin, Project Member, Alert Admin, Alert Member, Edit Alert 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)