How to Retrieve the List of Group details using REST API

Groups are collections of users to which permissions can be assigned. This article provides comprehensive guidance on how to retrieve the list of groups 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/groups

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v5.0/groups

Request Type

• GET: This request type is used to retrieve the list of groups.

Example Request

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

For more information on managing groups, please refer to this documentation.

Responses

• 200: List of groups has been retrieved successfully.
• 204: Group list is empty.
• 400: Page does not exist.
• 401: Access denied.
• 405: Request type was not GET.

Reference

• How to get the dashboard list based on group for the specific user.
• How to retrieve the list of categories in the dashboard listing page via REST API.
• How to Add and Delete Groups using the REST API.