---
title: "Get Alert On-Call Rule"
method: POST
path: "/alert-on-call-rule/{id}/get-item"
tags: ["Alert On-Call Rule"]
---

# Get Alert On-Call Rule

`POST /alert-on-call-rule/{id}/get-item`

## Request

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

Endpoint to retrieve a single Alert On-Call Rule by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` AlertOnCallRuleSelectSchema: Select schema for AlertOnCallRule. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `criteria` boolean
    - `whenToPage` boolean
    - `workingHours` boolean
    - `workingHoursTimezone` boolean
    - `aiHoldTimeInMinutes` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `isEnabled` boolean
    - `monitors` MonitorRelationSelectSchema: What a select may name of the Monitor records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `monitorTemplateId` boolean
      - `autoProvisionedNetworkDeviceId` boolean
      - `networkAlertPolicyId` boolean
      - `monitorType` boolean
      - `currentMonitorStatusId` boolean
      - `monitorSteps` boolean
    - `alertSeverities` AlertSeverityRelationSelectSchema: What a select may name of the AlertSeverity records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `color` boolean
      - `order` boolean
      - `isArchived` boolean
    - `alertLabels` 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
    - `monitorLabels` 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
    - `alertTitlePattern` boolean
    - `alertDescriptionPattern` boolean
    - `monitorNamePattern` boolean
    - `monitorDescriptionPattern` 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
    - `createdByUserId` boolean

## Response `200`

Successful response

- object
  - `data` AlertOnCallRule
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `version` number: Object version
    - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `whenToPage` 'Right Away' | 'Working Hours' | 'After OneUptime AI', required: When the on-call policies of this rule page: Right Away, as soon as a record matches it; Working Hours, only during the working hours of this rule - a record that matches it outside them is paged about when they begin; or After OneUptime AI, for alert and incident rules - when OneUptime AI may fix what the record is about, it responds first, and the policies page only if it has not resolved the record within the hold time. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `workingHours` object: When this rule may page, when When to Page is Working Hours: the same daily or weekly windows as an on-call schedule layer's restriction times, read in the time zone of this rule. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `workingHoursTimezone` string: The IANA time zone the working hours of this rule are in: Europe/London. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `aiHoldTimeInMinutes` number: When When to Page is After OneUptime AI: how many minutes OneUptime AI may hold the page while it investigates and fixes (1 to 30). Empty: 10. If OneUptime AI has not resolved the record by then, the policies page as usual. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Name of this alert on-call rule. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `description` string: Description of this alert on-call rule. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `isEnabled` boolean, required: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `monitors` object[]: Only trigger for alerts from these monitors. Leave empty to match alerts from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
      - `_id` string, uuid: Unique identifier for the entity
    - `alertSeverities` object[]: Only trigger for alerts with these severities. Leave empty to match alerts of any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
      - `_id` string, uuid: Unique identifier for the entity
    - `alertLabels` object[]: Only trigger for alerts that have at least one of these labels. Leave empty to match alerts regardless of alert labels. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
      - `_id` string, uuid: Unique identifier for the entity
    - `monitorLabels` object[]: Only trigger for alerts from monitors that have at least one of these labels. Leave empty to match alerts regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
      - `_id` string, uuid: Unique identifier for the entity
    - `alertTitlePattern` string: Regular expression pattern to match alert titles. Leave empty to match any title. Example: 'CPU.*high' matches titles containing 'CPU' followed by 'high'. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `alertDescriptionPattern` string: Regular expression pattern to match alert descriptions. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `monitorNamePattern` string: Regular expression pattern to match monitor names. Leave empty to match any monitor name. Example: 'prod-.*' matches monitors starting with 'prod-'. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `monitorDescriptionPattern` string: Regular expression pattern to match monitor descriptions. Leave empty to match any monitor description. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
    - `onCallDutyPolicies` object[]: On-call duty policies to execute when an alert matches this rule. Permissions - Create: [Project Owner, Project Admin, Create Alert On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert On-Call Rule]
      - `_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 On-Call Rule], Update: [No access - you don't have permission for this operation]

## 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)