BookStack icon

BookStack

Manage BookStack resources
Join our community

Actions22

Overview

This node integrates with BookStack, a platform for organizing and managing documentation and knowledge bases. Specifically, the Book - Get Many operation retrieves multiple book records from BookStack with flexible sorting, filtering, pagination, and offset options.

Typical use cases include:

  • Fetching a list of books to display in dashboards or reports.
  • Synchronizing book metadata with other systems.
  • Filtering books by specific criteria such as creation date or tags.
  • Paginating through large collections of books efficiently.

For example, you could retrieve the first 100 books sorted by their creation date in descending order, or filter books whose names contain a certain keyword.

Properties

Name Meaning
Sort By Field to sort the results by (e.g., name, created_at, updated_at).
Sort Direction Direction of sorting: Ascending or Descending.
Filters One or more filters to apply on fields. Each filter includes:
- Field: The field name to filter on.
- Operation: Comparison operator (Equals, Greater Than, Greater Than or Equals, Less Than, Less Than or Equals, Like, Not Equals).
- Value: The value to compare against.
Count Maximum number of results to return (minimum 1, maximum 500).
Offset Number of results to skip before starting to return results (for pagination).

Output

The output is an array of JSON objects representing books retrieved from BookStack. Each object contains the properties of a book as returned by the BookStack API, such as:

  • Book ID
  • Name
  • Description
  • Tags
  • Creation and update timestamps
  • Other metadata fields supported by BookStack

No binary data is output by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the BookStack API.
  • The node uses HTTP requests to communicate with the BookStack REST API endpoints.
  • No additional external dependencies beyond the BookStack API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Using unsupported or misspelled field names in filters or sorting may result in API errors or empty results.
    • Requesting a count above 500 will be rejected due to API limits.
    • Providing invalid filter operations or values can cause query failures.

  • Error messages:

    • Errors from the BookStack API are surfaced with their message text.
    • If required parameters like count or offset are out of bounds, the node may throw validation errors.
    • Network or connectivity issues will result in request failures.

  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check field names and filter syntax.
    • Keep count within allowed range.
    • Ensure network access to the BookStack server.

Links and References

Discussion