Actions31
Overview
This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the User resource with the Get operation, it retrieves detailed information about a single user by their unique ID.
Common scenarios where this node is beneficial include:
- Fetching user details to display or process within an automation workflow.
- Integrating user data from BookStack into other systems or reports.
- Validating user existence or attributes before performing further actions.
For example, you might use this node to get a user's profile information by providing their ID, then use that data to customize notifications or access controls in your workflow.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the user to retrieve. This is required for the Get, Update, and Delete operations. |
Output
The node outputs JSON data representing the requested user resource. The structure corresponds directly to the user object returned by the BookStack API's GET /users/{id} endpoint. It typically includes fields such as user ID, name, email, role, and other user-specific metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the BookStack API. This credential must provide:
- A base URL for the BookStack instance.
- An authentication token composed of two parts (token ID and token secret).
- The node uses HTTP requests with JSON content type headers.
- Pagination support exists but is not relevant for the single-user Get operation.
Troubleshooting
- Missing or invalid ID: If the ID property is empty or incorrect, the API will return an error indicating the user was not found. Ensure the ID is correct and corresponds to an existing user.
- Authentication errors: If the API token is missing, expired, or invalid, the request will fail with an authorization error. Verify that the API credentials are correctly configured in n8n.
- Network or connectivity issues: Failures to reach the BookStack server may occur due to network problems or incorrect base URL configuration. Confirm the base URL is accessible and correct.
- API rate limits or permissions: If the API user lacks permission to read user data, the request will be denied. Check the API user's permissions in BookStack.