Get notification preferences

POST 
/api/v1/notifications/get-preferences

Returns the authenticated user's notification preferences, including per-channel and per-category settings.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Manage notification preferences

Request

Responses

200

Preferences retrieved successfully

Read notification preferences for the selected user.

Section ID: DOC-CP-notifications-api-getPreferences#example-notifications-getPreferences-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-notifications-api-getPreferences#example-notifications-getPreferences-response

Response example

{
  "global": {
    "enabled": true,
    "channels": {
      "inApp": true,
      "push": true,
      "email": true,
      "sms": true,
      "chat": true
    }
  },
  "workflows": [
    {
      "workflowId": "example_123",
      "workflowName": "example",
      "critical": true,
      "tags": [
        "example"
      ],
      "channels": {
        "inApp": true,
        "push": true,
        "email": true,
        "sms": true,
        "chat": true
      }
    }
  ]
}

Document ID: DOC-CP-notifications-api-getPreferences. Section identities and revisions.

Section	Stable reference
Get notification preferences	DOC-CP-notifications-api-getPreferences#overview
Request	DOC-CP-notifications-api-getPreferences#request
Responses	DOC-CP-notifications-api-getPreferences#responses