Introduction
The Delivery API 2.0's Documents endpoint fetches documents and queries the content repository.
API base URL
https://<your_brx_host>.bloomreach.io/delivery/site/v2/documentsAuthorization
The Delivery API 2.0 Documents 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 document by id or path
- Get documents by query
- Schemas
- Open API Specification (JSON) (Open in Swagger)
- Delivery API 2.0 Development Aids
- Delivery API 2.0 Query Operators
Example queries
- Fetch a document by its UUID
https://developers.bloomreach.io/delivery/site/v2/documents/cc13de86-40c9-4c23-ae1e-454f8ce8617b - Get all the documents:
https://developers.bloomreach.io/delivery/site/v2/documents - Get all the documents, specifying limit and offset:
https://developers.bloomreach.io/delivery/site/v2/documents?limit={{limit}}&offset={{offset}} - Get all the documents under a specific folder:
https://developers.bloomreach.io/delivery/site/v2/documents?folder=/brxsaas - Filter documents by ID:
https://developers.bloomreach.io/delivery/site/v2/documents?id=a65ca12c-f7e0-40e1-966e-803f5080d755,68c0af53-3e15-49b3-8825-8dc55739d589 - Filter documents by path:
https://developers.bloomreach.io/delivery/site/v2/documents?path=/content/documents/brxsaas/pages/categories,/content/documents/brxsaas/pages/home - Filter documents by published timestamp:
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified=1602703215008 - Filter documents published after a certain timestamp:
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified(gt)=1602703215008 - Filter documents published before a certain timestamp:
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified(lt)=1602703215008 - Filter documents published before or at a certain timestamp (less or equal than):
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified(lte)=1602703215008 - Filter documents published after or at a certain timestamp (greater or equal than):
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified(gte)=1602703215008 - Filter documents by namespace:
https://developers.bloomreach.io/delivery/site/v2/documents?namespace=brxsaas - Filter documents by locale:
https://developers.bloomreach.io/delivery/site/v2/documents?locale=en_US - Filter documents by content type:
https://developers.bloomreach.io/delivery/site/v2/documents?contentType=content - Filter documents by free text search query:
https://developers.bloomreach.io/delivery/site/v2/documents?q=nuts - Filter documents with free text search in a specific field (e.g. title):
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts - Filter documents with free text search in a specific field (e.g. title) and then order by a field name in ascending order:
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts&orderBy=fields.title%20ascending - Filter documents with free text search in a specific field (e.g. title) and then order by a field name in descending order:
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts&orderBy=fields.title%20descending - Filter documents with free text search in a specific field (e.g., title) and then order by a field name in descending order and case insensitive:
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts&orderBy=fields.title%20desc-ci - Filter documents with free text search in a specific field (e.g., title) and then order by a field name in ascending order and case insensitive:
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts&orderBy=fields.title%20asc-ci - Filter documents with free text search in a specific field (e.g., title) and then order by two fields in ascending order and case insensitive:
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts&orderBy=fields.title,%20fields.introduction%20asc-ci - Filter documents with free text search in a specific field (e.g., title) and then order by two fields:
https://developers.bloomreach.io/delivery/site/v2/documents?q(title)=nuts&orderBy=lastModified%20desc,%20locale%20asc-ci,%20fields.title - Filter documents that have a specific value in a field (e.g., title). It searches in all the namespaces for that field:
https://developers.bloomreach.io/delivery/site/v2/documents?fields.title=How%20to%20use%20Acorn%20nuts? - Filter documents that have a specific value in a field ignoring case(e.g., title). It searches in all the namespaces for that field:
https://developers.bloomreach.io/delivery/site/v2/documents?fields.title(ci)=how%20to%20use%20acorn%20nuts? - Filter documents that don't have a specific value in a field (e.g., title). Currently, it searches in a specific namespace for the absence of that field value:
https://developers.bloomreach.io/delivery/site/v2/documents?fields.title(ne)=How%20to%20use%20Acorn%20nuts?&namespace=brxsaas - Filter documents that don't have a specific value in a field (e.g., title), ignoring the case. Currently, it searches in a specific namespace for the absence of that field value:
https://developers.bloomreach.io/delivery/site/v2/documents?fields.title(ne-ci)=how%20to%20use%20acorn%20nuts?&namespace=brxsaas - Filter documents of content type "content" with a date field with a null value:
https://developers.bloomreach.io/delivery/site/v2/documents?contentType=content&fields.date(lt)=0 - Filter documents of content type "content" with a date field with a non-null value:
https://developers.bloomreach.io/delivery/site/v2/documents?contentType=content&fields.date(gt)=0 - Debugging the query:
https://developers.bloomreach.io/delivery/site/v2/documents/?debug=true - Filter documents by free text query using wildcard:
https://developers.bloomreach.io/delivery/site/v2/documents/?q=bar*el - Flattened response format:
https://developers.bloomreach.io/delivery/site/v2/documents/?q=bolt&format=flattened - Inlined response format:
https://developers.bloomreach.io/delivery/site/v2/documents/?q=bolt&format=inlined