BookStackInstall

Overview

This node integrates with the BookStack API to manage various BookStack resources such as users, books, pages, chapters, shelves, roles, attachments, and tags. Specifically for the User resource with the Get Many operation, it retrieves a list of user records from the BookStack system.

The node supports two modes for specifying the request:

• Automatic mode: You provide a natural language description of what you want to do (e.g., "List all users"), and the node attempts to infer the correct resource and operation.
• Manual mode: You explicitly select the resource ("User") and operation ("Get Many").

This node is useful in scenarios where you want to programmatically fetch multiple users from BookStack, for example:

• Synchronizing user data with another system.
• Generating reports on user activity or roles.
• Automating administrative tasks involving user management.

Properties

Note: Since the Resource is fixed to "User" and Operation to "Get Many" per your input, other properties related to different resources or operations are not relevant here.

Output

The output is an array of JSON objects representing the users retrieved from the BookStack API. Each item corresponds to one user record as returned by the API under the data property.

The structure of each user object depends on the BookStack API's user schema but typically includes fields like user ID, name, email, roles, and other metadata.

No binary data output is produced by this operation.

Dependencies

• Requires connection to a BookStack instance via its API.
• Requires an API token credential with appropriate permissions to read user data.
• The node expects the base URL and authentication tokens to be configured in the credentials.
• Pagination is supported using offset-based pagination parameters (count and offset) with a default page size of 100.

Troubleshooting

• Authentication errors: Ensure that the API token and base URL are correctly set in the credentials. Invalid or expired tokens will cause authorization failures.
• Empty results: If no users are returned, verify that the BookStack instance contains users and that the authenticated token has permission to view them.
• Incorrect automatic detection: When using automatic mode, ambiguous or unclear request descriptions may lead to incorrect resource or operation inference. In such cases, switch to manual mode and explicitly select "User" and "Get Many".
• API rate limits or connectivity issues: Network problems or API rate limiting can cause request failures. Check network connectivity and API usage policies.

Links and References

• BookStack API Documentation
• BookStack Official Website