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

# Get Incident Template

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

## Request

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

Endpoint to retrieve a single Incident Template by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` IncidentTemplateSelectSchema: Select schema for IncidentTemplate. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `title` boolean
    - `templateName` boolean
    - `templateDescription` boolean
    - `description` boolean
    - `slug` boolean
    - `createdByUserId` 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
    - `hosts` HostRelationSelectSchema: What a select may name of the Host records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `description` boolean
      - `hostIdentifier` boolean
      - `otelCollectorStatus` boolean
      - `agentVersion` boolean
      - `lastSeenAt` boolean
      - `osType` boolean
      - `osVersion` boolean
      - `hostId` boolean
      - `hostArch` boolean
      - `hostType` boolean
      - `hostIpAddresses` boolean
      - `cpuCores` boolean
      - `totalMemoryBytes` boolean
      - `processCount` boolean
      - `containerRuntime` boolean
      - `deploymentEnvironment` boolean
      - `runtimeName` boolean
      - `runtimeVersion` boolean
      - `cloudProvider` boolean
      - `cloudPlatform` boolean
      - `cloudRegion` boolean
      - `cloudAccountId` boolean
      - `latestCpuPercent` boolean
      - `latestMemoryPercent` boolean
      - `latestSwapPercent` boolean
      - `latestDiskPercent` boolean
      - `latestDiskMountpoint` boolean
      - `latestInodesPercent` boolean
      - `latestInodesMountpoint` boolean
      - `latestLoadAverage15m` boolean
      - `bootedAt` boolean
      - `failedSystemdUnitCount` boolean
      - `failedSystemdUnits` boolean
      - `readingsUpdatedAt` boolean
    - `kubernetesClusters` KubernetesClusterRelationSelectSchema: What a select may name of the KubernetesCluster records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `description` boolean
      - `clusterIdentifier` boolean
      - `provider` boolean
      - `otelCollectorStatus` boolean
      - `agentVersion` boolean
      - `lastSeenAt` boolean
      - `aiAccessRunnerId` boolean
    - `dockerHosts` DockerHostRelationSelectSchema: What a select may name of the DockerHost records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `description` boolean
      - `hostIdentifier` boolean
      - `otelCollectorStatus` boolean
      - `agentVersion` boolean
      - `lastSeenAt` boolean
      - `osType` boolean
      - `osVersion` boolean
    - `podmanHosts` PodmanHostRelationSelectSchema: What a select may name of the PodmanHost records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `description` boolean
      - `hostIdentifier` boolean
      - `otelCollectorStatus` boolean
      - `agentVersion` boolean
      - `lastSeenAt` boolean
      - `osType` boolean
      - `osVersion` boolean
    - `services` ServiceRelationSelectSchema: What a select may name of the Service records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `description` boolean
      - `serviceColor` boolean
      - `serviceLanguage` boolean
      - `techStack` boolean
      - `lastSeenAt` boolean
      - `serviceVersion` boolean
      - `deploymentEnvironment` boolean
      - `serviceNamespace` boolean
      - `runtimeName` boolean
      - `runtimeVersion` boolean
      - `telemetrySdkLanguage` boolean
      - `cloudProvider` boolean
      - `cloudPlatform` boolean
      - `cloudRegion` boolean
      - `cloudAccountId` 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
    - `statusPages` StatusPageRelationSelectSchema: What a select may name of the StatusPage records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `smtpConfigId` boolean
      - `callSmsConfigId` boolean
      - `defaultBarColor` boolean
      - `subscriberEmailNotificationFooterText` 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
    - `incidentSeverityId` boolean
    - `changeMonitorStatusToId` boolean
    - `initialIncidentStateId` boolean
    - `customFields` boolean
    - `customFieldSettings` boolean

## Response `200`

Successful response

- object
  - `data` IncidentTemplate
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `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 Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [No access - you don't have permission for this operation]
    - `title` string, required: Title of this incident. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `templateName` string, required: Name of the Incident Template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `templateDescription` string, required: Description of the Incident Template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `description` string: Short description of this incident. This is in markdown and will be visible on the status page. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `slug` string, required: Friendly globally unique name for your object. 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 Template], Update: [No access - you don't have permission for this operation]
    - `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 Template], Update: [No access - you don't have permission for this operation]
    - `monitors` object[]: List of monitors affected by this incident. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `hosts` object[]: List of hosts to pre-populate on incidents created from this template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `kubernetesClusters` object[]: List of Kubernetes clusters to pre-populate on incidents created from this template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `dockerHosts` object[]: List of Docker hosts to pre-populate on incidents created from this template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `podmanHosts` object[]: List of Podman hosts to pre-populate on incidents created from this template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `services` object[]: List of services to pre-populate on incidents created from this template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `onCallDutyPolicies` object[]: List of on-call duty policies affected by this incident template. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `statusPages` object[]: Limit incidents declared from this template to these status pages. Leave empty to reach every status page that lists the incident's monitors. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `isScopedToStatusPages` boolean, required: Whether incidents declared from this template are limited to the status pages in Status Pages. Derived from Status Pages; any value sent for it is ignored. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
      - `_id` string, uuid: Unique identifier for the entity
    - `incidentSeverityId` string, uuid: Incident Severity ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `changeMonitorStatusToId` string, uuid: Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the incident is created. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `initialIncidentStateId` string, uuid: Relation to Incident State Object ID. Incidents created from this template will start in this state. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `customFields` object: The custom field values incidents declared from this template start with, keyed by each incident custom field's name. They are merged one field at a time under the values the request or the Declare Incident form supplies. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]
    - `customFieldSettings` object: How the Declare Incident form treats each incident custom field when an incident is declared from this template, keyed by the field's template variable key (variableKey). Each value is Required (asked, must be filled in), Optional (asked, may be left empty), Hidden (not asked; the field keeps this template's value) or Default. A field that is not listed, or is Default, follows its own Show on Create and Required on Create settings. Only the dashboard's Declare Incident form applies these settings: incidents created through the API are not checked against them. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Template], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Template]

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