Skip to main content

Get registered notification channels

POST 
/api/v1/notifications/get-registered-channels

Returns the list of notification channels and their registration status for the authenticated user.

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: Keep push notifications attached to the signed-in user

Request​

Responses​

Channels retrieved successfully

Read the notification channels registered for the selected user.​

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

Request example

{}

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

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

Response example

{
  "channels": [
    {
      "channel": "CHANNEL_PUSH",
      "registered": true,
      "credentialCount": 1
    }
  ]
}

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

SectionStable reference
Get registered notification channelsDOC-CP-notifications-api-getRegisteredChannels#overview
RequestDOC-CP-notifications-api-getRegisteredChannels#request
ResponsesDOC-CP-notifications-api-getRegisteredChannels#responses