BookStack

Consume BookStack API

Actions31

Book Actions
Page Actions
Chapter Actions
Shelf Actions
User Actions
Role Actions
Attachment Actions
Tag Actions

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, the Page - Get operation retrieves detailed information about a single page resource by its unique ID.

Common scenarios for this node include:

Fetching the content and metadata of a specific page in a documentation or knowledge base system.
Automating workflows that require retrieving page details for processing or display.
Integrating BookStack page data into other systems or reports.

For example, you could use this node to get the HTML content and metadata of a page to display it on a website or to back up page data regularly.

Properties

Name	Meaning
ID	The unique identifier of the page resource to retrieve. This is required to specify which page to fetch.

Output

The node outputs JSON data representing the requested page resource. The structure corresponds to the BookStack API's page object, typically including fields such as:

id: The page's unique ID.
name: The title of the page.
html: The HTML content of the page.
book_id: The ID of the book the page belongs to.
chapter_id: (Optional) The ID of the chapter the page belongs to.
Other metadata fields like creation date, update date, and permissions.

No binary data output is produced by this operation.

Dependencies

Requires an API key credential for authenticating with the BookStack API.
The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
The BookStack API must be accessible from the n8n environment.

Troubleshooting

Missing or invalid ID: If the ID property is empty or incorrect, the API will return an error indicating the resource was not found. Ensure the ID is correct and exists in BookStack.
Authentication errors: If the API key or token is missing or invalid, the request will fail with an authorization error. Verify the credentials are correctly set up.
Network issues: Connectivity problems to the BookStack server will cause request failures. Check network access and the base URL configuration.
API changes: If the BookStack API version changes, some fields or endpoints might differ. Confirm compatibility with your BookStack version.