---
title: "Get Workspace Notification Summary"
method: POST
path: "/workspace-notification-summary/{id}/get-item"
tags: ["Workspace Notification Summary"]
---

# Get Workspace Notification Summary

`POST /workspace-notification-summary/{id}/get-item`

## Request

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

Endpoint to retrieve a single Workspace Notification Summary by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` WorkspaceNotificationSummarySelectSchema: Select schema for WorkspaceNotificationSummary. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `workspaceType` boolean
    - `summaryType` boolean
    - `recurringInterval` boolean
    - `numberOfDaysOfData` boolean
    - `sendFirstReportAt` boolean
    - `timezone` boolean
    - `channelNames` boolean
    - `teamName` boolean
    - `summaryItems` boolean
    - `filters` boolean
    - `filterCondition` boolean
    - `nextSendAt` boolean
    - `lastSentAt` boolean
    - `isEnabled` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` WorkspaceNotificationSummary
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Name of the Summary Rule. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `description` string: Description of the Summary Rule. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `workspaceType` 'Slack' | 'MicrosoftTeams' | 'Mattermost', required: Type of Workspace - Slack, Microsoft Teams, etc. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `summaryType` 'Incident' | 'Alert' | 'Incident Episode' | 'Alert Episode', required: Type of summary - Incident, Alert, Incident Episode, or Alert Episode. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `recurringInterval` object: How often should the summary be sent? Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `numberOfDaysOfData` number, required: How many days of data to include in the summary. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `sendFirstReportAt` object: When should the first summary report be sent? Subsequent reports will follow the recurring interval from this date. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `timezone` string: The IANA time zone the summary's schedule is read in, such as Europe/Berlin or America/New_York. The summary goes out at the same time of day there all year, also after the clocks change for daylight saving time. Left out when the summary is created, it is the time zone in the creator's profile, or UTC when no person creates it (an API key or a workflow). A summary without one is read in UTC. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `channelNames` object: List of channel names to post the summary to. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `teamName` string: Microsoft Teams team name (only for Microsoft Teams). Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `summaryItems` object: Checklist of items to include in the summary. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `filters` object: Filter conditions for which items to include in the summary. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `filterCondition` 'All' | 'Any': How to combine filters - Any or All. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `nextSendAt` object: When the next summary should be sent. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `lastSentAt` object: When the last summary was sent. Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `isEnabled` boolean, required: Is this summary rule enabled? Permissions - Create: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Create Workspace Notification Summary], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [Project Admin, Project Owner, Project Member, Settings Admin, Settings Member, Edit Workspace Notification Summary]
    - `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 Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Admin, Project Owner, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Workspace Notification Summary], 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)