Notifications API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• DELETE /notifications — Delete notifications
• GET /notifications — Retrieve notifications
• PUT /notifications — Update notifications
• DELETE /notifications/{id} — Delete a notification
• GET /notifications/{id} — Get a notification
• PUT /notifications/{id} — Update a notification

Delete notifications

DELETE /api/notifications

Delete a list of notifications at once.

Authentication: API key. Permission: notification.delete.

Request body

Required.

Field definitions: NotificationDeleteAllDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/NotificationDeleteAllDto"
    }
  }
}

Responses

{
  "204": {
    "description": ""
  }
}

Retrieve notifications

GET /api/notifications

Retrieve a list of notifications.

Authentication: API key. Permission: notification.read.

Parameters

Name	Where	Required	Description
id	query	No	Filter by notification ID
level	query	No
type	query	No
unread	query	No	Filter by unread status

Parameter types, defaults and constraints

Field definitions: NotificationLevel, NotificationType

[
  {
    "name": "id",
    "required": false,
    "in": "query",
    "description": "Filter by notification ID",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  {
    "name": "level",
    "required": false,
    "in": "query",
    "schema": {
      "$ref": "#/components/schemas/NotificationLevel"
    }
  },
  {
    "name": "type",
    "required": false,
    "in": "query",
    "schema": {
      "$ref": "#/components/schemas/NotificationType"
    }
  },
  {
    "name": "unread",
    "required": false,
    "in": "query",
    "description": "Filter by unread status",
    "schema": {
      "type": "boolean"
    }
  }
]

Responses

Field definitions: NotificationDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/NotificationDto"
          },
          "type": "array"
        }
      }
    },
    "description": ""
  }
}

Update notifications

PUT /api/notifications

Update a list of notifications. Allows to bulk-set the read status of notifications.

Authentication: API key. Permission: notification.update.

Request body

Required.

Field definitions: NotificationUpdateAllDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/NotificationUpdateAllDto"
    }
  }
}

Responses

{
  "204": {
    "description": ""
  }
}

Delete a notification

DELETE /api/notifications/{id}

Delete a specific notification.

Authentication: API key. Permission: notification.delete.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

{
  "204": {
    "description": ""
  }
}

Get a notification

GET /api/notifications/{id}

Retrieve a specific notification identified by id.

Authentication: API key. Permission: notification.read.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

Field definitions: NotificationDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/NotificationDto"
        }
      }
    },
    "description": ""
  }
}

Update a notification

PUT /api/notifications/{id}

Update a specific notification to set its read status.

Authentication: API key. Permission: notification.update.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Request body

Required.

Field definitions: NotificationUpdateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/NotificationUpdateDto"
    }
  }
}

Responses

Field definitions: NotificationDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/NotificationDto"
        }
      }
    },
    "description": ""
  }
}