Get Notifications
For detailed technical specifications, please refer to the Swagger documentation.
Fetch notifications
GET /notifications
Returns an array of notifications for one or more HER-Ids.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
HerIds |
integer[] |
Yes | One or more receiver HER-Ids to fetch notifications for. Max 1500 HER-Ids can be provided in one request. |
NotificationsToFetch |
integer |
No | Number of notifications to return. Default is 100. Must be between 1 and 1000 if provided. |
Offset |
integer |
Yes | Offset of the last notification received from this endpoint, ensures only newer notifications are returned. |
Response
The response contains a notifications array. Each notification object has the following fields:
| Field | Type | Description |
|---|---|---|
relatedMessageId |
guid |
ID of the related message. Use this ID when interacting with the message-endpoints. |
type |
string |
Type of notification. Either NewMessage or RefusedMessage. |
notificationReceiverHerId |
integer |
The HER-Id of the receiver this notification is for. |
notificationTriggeredByHerId |
integer |
The HER-Id of the party that triggered the notification (e.g. the sender). |
description |
string |
Human-readable description of the notification event. |
createdAt |
datetime |
Timestamp for when the notification was created. |
offset |
integer |
The offset value for this notification. Use this as the Offset parameter in subsequent requests. |
Notification Types
NewMessage
A new business document has been received and is ready for download. Use relatedMessageId to get message data from the GET /messages/{id}/*-endpoints.
RefusedMessage
not yet enabled in Test and Production
Example Response
{
"notifications": [
{
"id": "843eed10-6b56-496b-8664-ce71167c6b5c",
"relatedMessageId": "0d5c8d05-ab57-4b2b-b480-c46c69cdf789",
"type": "NewMessage",
"notificationReceiverHerId": 6789,
"notificationTriggeredByHerId": 9876,
"description": "New message received. (EPIKRISE).",
"createdAt": "2026-04-14T06:17:00+00:00"
}
]
}