Notification Settings Types

Notification Settings Types

This endpoint returns the available notification setting types for the authenticated user profile, along with the current enabled/disabled state for both email and push notifications per notification type. It is used to inspect how each category of notification is currently configured. The response maps each notification type to a human-readable display name and its associated channel enablement flags.

Endpoint

GET /settings/notificationSettingsTypes

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when building notification preference screens in a partner application to display what notification categories exist and how they are currently configured for a user. It is also useful when synchronizing notification settings state before presenting an update form to the end user. Call this before submitting any notification settings updates to ensure you have the current state.

Response

200 OK

FieldTypeDescription
idinteger (int32)Unique identifier of the notification settings record
userProfileIdinteger (int32)Identifier of the user profile this setting belongs to
emailEnabledbooleanIndicates whether email notifications are enabled for this notification type
pushEnabledbooleanIndicates whether push notifications are enabled for this notification type
notificationTypeinteger (int32)Numeric code representing the notification category (enum: 0, 1, 2, 3)
notificationTypeDisplayNamestring / nullHuman-readable label for the notification type (read-only)
{
  "id": 101,
  "userProfileId": 4892,
  "emailEnabled": true,
  "pushEnabled": false,
  "notificationType": 1,
  "notificationTypeDisplayName": "Transaction Alerts"
}

Error Codes

CodeWhen it happens
400Missing required fields or validation error
401Token missing, expired, or invalid
403Insufficient permissions
404Resource not found
500Internal server error

Common Mistakes

  • Calling this endpoint without a valid Bearer token will result in a 401 response; ensure the token has not expired (lifetime is 10 minutes).
  • Treating notificationType as a string — it is an integer enum with values 0, 1, 2, or 3; use the notificationTypeDisplayName field for display purposes only.
  • Assuming the response is a list — this endpoint returns a single notification settings type object; iterate by calling relevant settings update endpoints per type as needed.

Related Endpoints

  • POST https://api.banking.netevia.dev/api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an expiring Bearer token

Example

curl -X GET https://api.banking.netevia.dev/settings/notificationSettingsTypes \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json