GET
/
notifications
/
{id}
Get a notification
curl --request GET \
  --url https://api.smokeball.com/notifications/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "e2fd015b-8a60-42be-9ea4-b2ef7aa0289b",
  "createdByUserId": "db0b4298-67ef-4638-a92a-5bb830ea6af6",
  "createdDate": "\"832e778f-83df-454a-b344-768a862a7e67\"",
  "icon": "",
  "iconColor": "#25C9A4",
  "message": "[@staffId] has **assigned** you a Task.",
  "toastyIcon": "<string>",
  "toastyMessage": "<string>",
  "isRead": false,
  "hasBeenSeen": false,
  "creationTimestamp": "2023-11-07T05:31:56Z",
  "updatedDate": "2020-02-15T00:00:00Z",
  "isDeleted": false
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

Response

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

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the notification.

Example:

"e2fd015b-8a60-42be-9ea4-b2ef7aa0289b"

​
createdByUserId
string | null

The user that created this notification.

Example:

"db0b4298-67ef-4638-a92a-5bb830ea6af6"

​
createdDate
string | null

Staff id to notify.

Example:

"\"832e778f-83df-454a-b344-768a862a7e67\""

​
icon
string | null

The icon to display for the notification.

Example:

""

​
iconColor
string | null

The icon hex color to display for the notification.

Example:

"#25C9A4"

​
message
string | null

The message to display for the notification.

Example:

"[@staffId] has **assigned** you a Task."

​
toastyIcon
string | null

The icon to display for the toast notification.

​
toastyMessage
string | null

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.

Example:

false

​
hasBeenSeen
boolean

True if the notification was "seen" by the user.

This is different to the forceful "read" state.

Example:

false

​
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).

Example:

"2020-02-15T00:00:00Z"

​
isDeleted
boolean

True if the notification has been deleted.

Example:

false