Category / Section
How to Get a Specific Pinboard details via REST API
Published:
This article provides comprehensive guidance on how to get a specific pinboard details 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/pinboard/{name}
Bold BI Cloud Server
For Bold BI Cloud instances, the endpoint is:
https://{yourdomain}/bi/api/v5.0/pinboard/{name}
Request Type
- GET: This request type is used to get a specific pinboard details.
Example Request
Here is an example of how to structure your GET request:
Responses
- 200: Pinboard detail have been retrieved successfully.
- 400: The content of the request body is missing or incomplete.
- 401: Access denied.
- 405: Request type was not GET.
- 406: The content of the request body is invalid.
- 405: Failed to retrieve the pinboard detail.