The Folders endpoint fetches folders and enables inspecting and traversing the folder structure, including sub-folders.
Introduction
The Delivery API 2.0's Folders endpoint fetches folders and enables inspecting and traversing the folder structure, including sub-folders.
API Base URL
https://<your_brx_host>.bloomreach.io/delivery/site/v2/folders
Authorization
The Delivery API 2.0 Folders endpoint is public by default. Optionally, customers can configure the endpoint to be accessible only for authorized access using a JSON Web Token (JWT).
Reference
- Get folder by id or path
- Schemas
- Open API Specification (JSON) (Open in Swagger)
- Delivery API 2.0 Development Aids
- Delivery API 2.0 Query Operators
Example Queries
- Get documents in a folder:
https://developers.bloomreach.io/delivery/site/v2/folders/documents/mychannel - Get documents in a folder specifying the limit of returned results (limit<=100):
https://developers.bloomreach.io/delivery/site/v2/folders/documents/mychannel?limit=100 - Get documents in a folder specifying the offset of returned results:
https://developers.bloomreach.io/delivery/site/v2/folders/documents/mychannel?offset=10 - Get documents in a folder sorted alphabetically:
https://developers.bloomreach.io/delivery/site/v2/folders/documents/mychannel?sorted=true