Get notification settings for a user

GET/v2/notification-settings/

API version

v2

Request method

GET

Operation ID

notifications-get-notification-settings

---

Settings are provided for each message type: Channels for each message type can be active and editable.

Request

No request parameters.

Responses

Format

application/json

Description

Channel settings per message type

Schema documentation

• messageTypesobject

  required
  • *object
    • channelsobject

      required
      • emailobject

        required
        • activeboolean

          required
        • editableboolean

          required
      • frontendNotificationobject

        required
        • activeboolean

          required
        • editableboolean

          required

Example

Content-Type: application/json

{
  "messageTypes": {
    "string": {
      "channels": {
        "email": {
          "active": true,
          "editable": true
        },
        "frontendNotification": {
          "active": true,
          "editable": true
        }
      }
    }
  }
}

JSON Schema

{
  "properties": {
    "messageTypes": {
      "additionalProperties": {
        "properties": {
          "channels": {
            "properties": {
              "email": {
                "properties": {
                  "active": {
                    "type": "boolean"
                  },
                  "editable": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "active",
                  "editable"
                ],
                "type": "object"
              },
              "frontendNotification": {
                "properties": {
                  "active": {
                    "type": "boolean"
                  },
                  "editable": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "active",
                  "editable"
                ],
                "type": "object"
              }
            },
            "required": [
              "email",
              "frontendNotification"
            ],
            "type": "object"
          }
        },
        "required": [
          "channels"
        ],
        "type": "object"
      },
      "type": "object"
    }
  },
  "required": [
    "messageTypes"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/notification-settings

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.notificationsGetNotificationSettings({});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new NotificationsGetNotificationSettingsRequest());
$response = $client->notification()->notificationsGetNotificationSettings($request);

var_dump($response->getBody();