Notifications

Get notification by ID

Get the notification with the given <strong>{id}</strong>. <br> Current user can only get notifications, where he is the recipient.

get/pimcore-studio/api/notifications/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/notifications/{id}
  • Auth: none declared

Path parameters

idinteger required
Example:83

Id of the notification

Response

Notification data as JSON

additionalAttributesobject

AdditionalAttributes

idinteger required

id

typestring required

type

titlestring required

title

readboolean required

read

hasAttachmentboolean required

has attachment

creationDateinteger required

creation date

senderstring nullable required

sender

messagestring nullable required

message

payloadstring nullable required

payload

attachmentTypestring nullable required

linked attachment type

attachmentIdinteger nullable required

linked attachment ID

attachmentFullPathstring nullable required

linked attachment fullPath

Example response

{
  "id": 23,
  "type": "info",
  "title": "Notification title",
  "hasAttachment": true,
  "creationDate": 1707312457,
  "sender": "Pimcore Admin",
  "message": "Notification message",
  "payload": "{\"key\": \"value\"}",
  "attachmentType": "object",
  "attachmentId": 3669,
  "attachmentFullPath": "/path/to/attachment.jpg"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.