Administration

Notifications

Org notifications only

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/notifications/user`	Get user notifications
GET	`/api/notification`	Get notification
PATCH	`/api/notification/{id}`	Patch notification
PATCH	`/api/notification/mark-all-read`	Mark all notifications read

Get user notifications

GET/api/notifications/user

Get notifications for the currently authenticated user.

Access. Send a bearer token or an API key. The caller needs the Settings view permission.

Parameters

Name	In	Type	Required	Description
`includeRead`	query	`boolean`	No	Default: `false`.

Response

200. Returns a PagedResult envelope. Each item in data is NotificationResponse.

Request

curl -X GET "https://api.miridia.io/api/notifications/user" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "count": 0,
  "totalCount": 0,
  "page": 0,
  "finalPage": 0,
  "pageSize": 0,
  "hasMore": true,
  "statusCode": "OK",
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "message": "string",
      "readNotification": true,
      "priority": "Low",
      "type": "Default",
      "level": "Standard",
      "actionLink": "string",
      "entityType": "Customer",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateCreated": "2026-09-29T08:00:00Z",
      "dateModified": "2026-09-29T08:00:00Z",
      "user": {}
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Get notification

GET/api/notification

Get a single notification by id. Returns 404 if the notification does not exist.

Access. Send a bearer token or an API key. Any signed-in member can call this operation.

Parameters

Name	In	Type	Required	Description
`id`	query	`string (uuid)`	No

Response

200. Returns a SingleResult envelope. The data field is NotificationResponse.

Request

curl -X GET "https://api.miridia.io/api/notification" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "message": "string",
    "readNotification": true,
    "priority": "Low",
    "type": "Default",
    "level": "Standard",
    "actionLink": "string",
    "entityType": "Customer",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dateCreated": "2026-09-29T08:00:00Z",
    "dateModified": "2026-09-29T08:00:00Z",
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string"
    }
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Patch notification

PATCH/api/notification/{id}

Partially update a notification (currently only the read state).

Access. Send a bearer token or an API key. Any signed-in member can call this operation.

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape PatchNotificationRequest. Payload for partially updating a notification. Currently only the read state is patchable.

Field	Type	Required	Description
`read`	`boolean`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X PATCH "https://api.miridia.io/api/notification/{id}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "read": true
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Mark all notifications read

PATCH/api/notification/mark-all-read

Marks all of the currently-authenticated user's unread notifications as read, in a single bulk update.

Access. Send a bearer token or an API key. Any signed-in member can call this operation.

Response

200. Returns a SingleResult envelope. The data field is integer (int32).

Request

curl -X PATCH "https://api.miridia.io/api/notification/mark-all-read" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": 0,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Models

The operations on this page use these object types. Select a type to see its fields.

NotificationResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`message`	`string`
`readNotification`	`boolean`
`priority`	`enum NotificationPriority`	One of: `Low`, `Medium`, `High`, `Maximum`.
`type`	`enum NotificationType`	One of: `Default`, `Business`, `User`.
`level`	`enum NotificationLevel`	One of: `Standard`, `Info`, `Warning`, `Error`, `Success`, `Recommendation`.
`actionLink`	`string`
`entityType`	`enum DispatchEntityType`	One of: `None`, `Customer`, `Contact`, `Product`, `Order`, `Shipment`, `IntegrationProvider`, `Address`, `Business`, `Notification`, `Package`, `Supplier`, `User`, `WorkOrder`, `TransferOrder`, `PurchaseOrder`, `Bom`, `Vehicle`.
`entityId`	`string (uuid)`
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`
`user`	`PrimitiveUserResponse`

PrimitiveUserResponse

Field	Type	Description
`id`	`string (uuid)`
`displayName`	`string`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`

Users

The users operations of the Core API.

Push notifications

The push notifications operations of the Core API.