---
title: "Get a notification"
method: GET
path: "/notifications/{id}"
tags: ["Notifications"]
---

# Get a notification

`GET /notifications/{id}`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/notifications/{id}`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Retrieves a specified notification.

## Path parameters

- `id` string, required

## Response `200`

When request is successful. Returns a 'Notification' object.

- Notification
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `id` string, nullable: Unique identifier of the notification.
  - `createdByUserId` string, nullable: The user that created this notification.
  - `createdDate` string, nullable: Staff id to notify.
  - `icon` string, nullable: The icon to display for the notification.
  - `iconColor` string, nullable: The icon hex color to display for the notification.
  - `message` string, nullable: The message to display for the notification.
  - `toastyIcon` string, nullable: The icon to display for the toast notification.
  - `toastyMessage` string, nullable: The message to display for the message.
  - `isRead` boolean: True if the notification has been forcefully read by the user. This is different to the <seealso cref="P:ItOps.NotificationCentre.Api.Resources.Notification.HasBeenSeen" /> property - which is not forceful.
  - `hasBeenSeen` boolean: True if the notification was "seen" by the user. This is different to the forceful "read" state.
  - `creationTimestamp` string, date-time: The time the notification was created.
  - `updatedDate` string, date-time: The last time the notification was modified (marked as read, deleted etc).
  - `isDeleted` boolean: True if the notification has been deleted.

## Other responses

- `400`: When an unsupported request is made.
- `403`: When notification with specified id is not associated with authenticated client.
- `404`: When notification with specified id does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)