Category / Section
How to Retrieve the List of Slideshow Details using REST API
Published:
Users who have created access to the slideshow can add a new slideshow. This article provides comprehensive guidance on how to retrieve the list of slideshows via REST API in Bold BI.
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/slideshows
Bold BI Cloud Server
For Bold BI Cloud instances, the endpoint is:
https://{yourdomain}/bi/api/v5.0/slideshows
Request Type
- GET: This request type is used to retrieve the list of slideshows.
Example Request
Here is an example of how to structure your GET request:
For more information on slideshows, please refer to this documentation.
Responses
- 200: List of slideshows was retrieved successfully.
- 204: Items not found.
- 400: Page does not exist.
- 401: Access denied.
- 405: Request type was not GET.
- 417: Failed to retrieve the slideshows.