How to get the user's notification settings details for the specific site via REST API ?

This article provides guidance on how to retrieve the user’s notification settings details for the specific site via REST API.

Authorization

To execute this action, please ensure that an access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/profile/notifications

By following these steps, you can easily find the Dashboard ID for your needs.

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v5.0/profile/notifications

Request Type

• GET: This request type is used to retrieve the user’s notification settings details for the specific site.

Example Request

Here is an example of how to structure your GET request:

Responses

The API will return different responses based on the outcome of the request:

• 200 OK: The user notification settings details have been retrieved successfully.

Sample Response:

{
   "InheritMailNotificationSettingsFromGlobalSettings": false,
   "InheritSystemNotificationSettingsFromGlobalSettings": false,
   "UserMailNotificationSettings": {
       "EnableNotificationForDashboardOwner": true,
       "EnableNotificationForAccessibleUser": true,
       "EnableNotificationOnUserMention": true,
       "EnableNotificationWhenWatchEnabled": true,
       "EnableUserScheduleNotification": true,
       "EnableUserProfileNotification": true,
       "EnableResourceShareNotification": true,
       "EnableUserSynchronizationNotification": true
   },
   "UserSystemNotificationSettings": {
       "EnableNotificationForDashboardOwner": true,
       "EnableNotificationForAccessibleUser": true,
       "EnableNotificationOnUserMention": true,
       "EnableNotificationWhenWatchEnabled": true
   }
} 

• 401 Unauthorized: Access denied. This indicates that the provided token is invalid or missing.
• 405 Method Not Allowed: This response indicates that the request type used is not allowed. Ensure that you are using the GET method.

Additional References

To know more about Bold BI APIs