BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API, allowing users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. It supports a variety of operations including creating, retrieving, updating, deleting, copying, and moving these resources.

For the User resource with the Get operation, the node fetches detailed information about a specific user by their ID. This is useful in scenarios where you need to retrieve user details for display, auditing, or further processing within an automation workflow.

Practical examples:

  • Retrieve a user's profile information to personalize content or notifications.
  • Fetch user details to verify permissions or roles before performing other actions.
  • Integrate user data into reports or dashboards.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation: "Set Automatically" or "Set Manually".
Request Description (Shown if "Set Automatically") Describe your request in natural language; the system will auto-select resource and operation. Example: "Get user with ID 123".
ID The unique identifier of the user to retrieve. Required for Get operation.

Output

The node outputs JSON data representing the user resource retrieved from the BookStack API. The structure corresponds directly to the API's user object, typically including fields such as user ID, name, email, roles, avatar URL, and other user metadata.

No binary data output is involved in this operation.

Example output snippet (simplified):

{
  "id": 123,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "roles": [
    {
      "id": 1,
      "name": "Admin"
    }
  ],
  "avatar": "https://example.com/avatar.jpg"
}

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API token credential configured in n8n with base URL and authentication tokens.
  • The node uses HTTP requests authenticated with a token header.

Troubleshooting

  • Common issues:

    • Invalid or missing user ID: The node requires a valid user ID for the Get operation; ensure the ID is correct and exists.
    • Authentication errors: Verify that the API token and base URL credentials are correctly set up.
    • Network connectivity: Ensure the BookStack server is reachable from the n8n environment.

  • Error messages:

    • "404 Not Found": The specified user ID does not exist. Check the ID value.
    • "401 Unauthorized" or "403 Forbidden": Authentication failed or insufficient permissions. Confirm API token validity and permissions.
    • "Invalid JSON response": Could indicate API changes or network issues; check API compatibility and connectivity.

Links and References

Discussion