Actions40
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API, allowing users to manage BookStack resources such as Users, Books, Pages, Chapters, Shelves, Roles, Attachments, and Tags. Specifically for the User - Get operation, it retrieves detailed information about a single user by their ID.
Common scenarios where this node is beneficial include:
- Fetching user details for display or processing within an automation workflow.
- Integrating BookStack user data into other systems or reports.
- Automating user management tasks by retrieving user info before updates or deletions.
Practical example:
- You want to get the profile information of a specific user in your BookStack instance by providing their user ID, then use that data to send a notification or update another system.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown if "Set Automatically" is chosen) Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Get user with ID 123". |
| ID | The unique identifier of the user resource to retrieve. Required for operations: Get, Update, Delete. |
Output
The node outputs JSON data representing the requested user resource from BookStack. The structure corresponds directly to the BookStack API's user object, typically including fields such as user ID, name, email, roles, avatar URL, and other profile details.
If the node encounters an error (e.g., invalid ID), the output JSON will contain an error field describing the issue.
No binary data output is produced by this operation.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API authentication token credential configured in n8n with:
- Base URL of the BookStack API.
- Token and token secret for authorization.
- The node uses HTTP requests authenticated with these credentials to interact with the BookStack API.
Troubleshooting
Common issues:
- Providing an invalid or non-existent user ID will result in an error response from the API.
- Incorrect or missing API credentials will cause authentication failures.
- Network connectivity problems to the BookStack server can cause request timeouts or errors.
Error messages:
"error": "Resource not found"— The specified user ID does not exist. Verify the ID."error": "Unauthorized"— Authentication failed. Check API token and base URL."error": "Request failed"— General failure; check network and API availability.
Resolutions:
- Double-check the user ID input.
- Ensure API credentials are correctly set up and valid.
- Confirm the BookStack server is reachable and operational.