BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API, allowing users to manage and retrieve content from a BookStack instance. Specifically, for the Page - Get Many operation, it fetches multiple pages from the BookStack system. This is useful when you want to list or process many pages at once, such as generating reports, syncing content, or displaying page lists in other applications.

Typical use cases include:

Retrieving all pages within a book or chapter.
Fetching pages for bulk processing or export.
Integrating BookStack content into other workflows or dashboards.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: - Set Automatically: Describe your request in natural language, and the node will infer the resource and operation. - Set Manually: Explicitly select the resource and operation.
Request Description	(Shown only if "Set Automatically" is selected) A text description of what you want to do, e.g., "Create a new page about API documentation". The node uses this to automatically detect the intended resource and operation.

For this specific operation ("Get Many" on "Page"), the node will typically ignore manual inputs like ID and instead fetch multiple pages according to the API defaults and any implicit filters derived from the description.

Output

The output is an array of JSON objects representing the pages retrieved from BookStack. Each item corresponds to one page and contains all the fields returned by the BookStack API under the data property. Typical fields include page metadata such as:

Page ID
Name/title
HTML content
Associated book and chapter IDs
Creation and update timestamps
Other page-specific attributes

No binary data is output by this operation.

Dependencies

Requires connection to a BookStack instance via its API.
Needs an API token credential with appropriate permissions to read pages.
The base URL and authentication tokens must be configured in the node credentials.
Pagination is supported using offset-based pagination parameters (count and offset).

Troubleshooting

Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- If the BookStack base URL is incorrect or unreachable, HTTP requests will fail.
- Automatic detection may misinterpret ambiguous descriptions; switching to manual mode can resolve this.
- Large datasets might require handling pagination properly.
Error messages:
- Authentication errors usually indicate invalid or expired tokens.
- HTTP 404 errors suggest incorrect resource paths or IDs.
- Validation errors may occur if required parameters are missing in manual mode.

To resolve these, verify credentials, ensure the BookStack API is accessible, and confirm that input parameters match expected values.