List all unread notifications

GET/notifications/

API version

v2

Request method

GET

Operation ID

notifications-list-notifications

---

Request

Responses

Response headers

• X-Pagination-Limitnumber

  The limit used to select the resources for the response

• X-Pagination-Skipnumber

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountnumber

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

List of notifications

Schema documentation

• Array[
• *object
  • createdAtstring (date-time)

    required
  • idstring (uuid)

    required
  • readboolean

    required
  • referenceobject

    required
    • aggregatestring

      required
    • domainstring

      required
    • idstring

      required
    • parentsarray of object
      • Array[
      • *object
        • aggregatestring

          required
        • domainstring

          required
        • idstring

          required
      ]
• severitystring (one of: success, info, warning, error)

  required
• typestring

  required

]

Example

[
  {
    "createdAt": "2024-11-23T00:28:37.049Z",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "read": true,
    "reference": {
      "aggregate": "string",
      "domain": "string",
      "id": "string",
      "parents": [
        {
          "aggregate": "string",
          "domain": "string",
          "id": "string"
        }
      ]
    },
    "severity": "success",
    "type": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "read": {
        "type": "boolean"
      },
      "reference": {
        "properties": {
          "aggregate": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "parents": {
            "items": {
              "properties": {
                "aggregate": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "aggregate",
                "domain"
              ],
              "type": "object"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "aggregate",
          "domain"
        ],
        "type": "object"
      },
      "severity": {
        "enum": [
          "success",
          "info",
          "warning",
          "error"
        ],
        "type": "string"
      },
      "type": {
        "type": "string"
      }
    },
    "required": [
      "id",
      "type",
      "reference",
      "severity",
      "read",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/notifications?status=unread&limit=50&page=1

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.notification.notificationsListNotifications({
  "queryParameters": {
    "status": "unread",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsListNotifications\NotificationsListNotificationsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new NotificationsListNotificationsRequest())
  ->withStatus("unread")
  ->withLimit(50)
  ->withPage(1);
$response = $client->notification()->notificationsListNotifications($request);

var_dump($response->getBody();