BookStack

Consume BookStack API

Actions40

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. Specifically, for the User resource with the Get operation, it retrieves detailed information about a specific user by their ID.

Common scenarios where this node is beneficial include:

Fetching user details for display or processing within an automation workflow.
Integrating user data from BookStack into other systems or reports.
Automating user management tasks by retrieving user profiles dynamically.

Practical example:

You want to retrieve the profile information of a BookStack user by specifying their user ID to personalize notifications or audit user activity.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually".
Request Description	(Shown if "Set Automatically" is selected) A text description of what you want to do; the system uses this to automatically select the resource and operation. Example: "Get user details by ID 123".
ID	The unique identifier of the user resource to retrieve. Required for Get, Update, and Delete operations.

Output

The node outputs JSON data representing the user resource retrieved from the BookStack API. This JSON includes all available fields describing the user, such as username, email, roles, and other profile details as provided by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "roles": [
    {
      "id": 1,
      "name": "Admin"
    }
  ],
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-06-01T08:30:00Z"
}

Dependencies

Requires an API key credential for authenticating with the BookStack API.
The base URL of the BookStack instance must be configured in the credentials.
The node uses HTTP requests with token-based authentication to communicate with the BookStack API.

Troubleshooting

Missing or invalid ID: If the ID property is not set or incorrect, the API will return an error indicating the resource was not found. Ensure the correct user ID is provided.
Authentication errors: If the API key or token is invalid or missing, the node will fail with an authentication error. Verify that the API credentials are correctly configured.
Resource not found: If the specified user ID does not exist, the API returns a 404 error. Confirm the user ID exists in BookStack.
Automatic detection issues: When using "Set Automatically" mode with a request description, ambiguous or unclear descriptions may lead to incorrect resource or operation selection. Use clear and specific descriptions or switch to manual mode.