BookStack API - Shelf Information in Book Read #5585

New Issue

OVERLORD · 2026-02-05T10:11:15+03:00

OVERLORD commented

2026-02-05 10:11:15 +03:00

Originally created by @sam-marteau on GitHub (Jan 29, 2026).

Describe the feature you'd like

When calling the "Book Read" REST request (book/{id}) it would be nice to have additional information to which shelves it is connected (at leaast shelf ID)

Describe the benefits this would bring to existing BookStack users

Since book permissions can be inherited from shelves, it would be nice to directly request shelf permitions without iterating through all shelfs and checking if they contain the respective book. So when new books are created it would be possible to set shelf inherited permissions more easily.

Can the goal of this request already be achieved via other means?

Currently i have a workflow like this:

Webhook Node → Receive bookId
HTTP Request → Get list of all shelves
SplitInBatches Node → Loop through each shelf
HTTP Request → Get books on each shelf
IF Node → Check if bookId exists on the shelf
HTTP Request → Get role permissions for the shelf if the book is found
Final Action → Process the role permissions

So instead of a tons of requests, i only would need 3 (+x depending on connected shelves):

Get book ID and connected shelf IDs
Get shelf permissions
Put respective permissions on the book

Have you searched for an existing open/closed issue?

I have searched for existing issues and none cover my fundamental request

How long have you been using BookStack?

Under 3 months

Additional context

i admit there there is a closed issue #3968
I would really like to ask you to reconsider this. Because there is the option in the GUI to copy permissions from shelf to book level. However, achieving this via the API is very complicated and resource-consuming.

Another solution would be, that books automatically inherit the permissions from the shelf with the most far-reaching permissions they are assigned to.

Originally created by @sam-marteau on GitHub (Jan 29, 2026). ### Describe the feature you'd like When calling the "Book Read" REST request (book/{id}) it would be nice to have additional information to which shelves it is connected (at leaast shelf ID) ### Describe the benefits this would bring to existing BookStack users Since book permissions can be inherited from shelves, it would be nice to directly request shelf permitions without iterating through all shelfs and checking if they contain the respective book. So when new books are created it would be possible to set shelf inherited permissions more easily. ### Can the goal of this request already be achieved via other means? Currently i have a workflow like this: 1. Webhook Node → Receive bookId 2. HTTP Request → Get list of all shelves 3. SplitInBatches Node → Loop through each shelf 4. HTTP Request → Get books on each shelf 5. IF Node → Check if bookId exists on the shelf 6. HTTP Request → Get role permissions for the shelf if the book is found 7. Final Action → Process the role permissions So instead of a tons of requests, i only would need 3 (+x depending on connected shelves): 1. Get book ID and connected shelf IDs 2. Get shelf permissions 3. Put respective permissions on the book ### Have you searched for an existing open/closed issue? - [x] I have searched for existing issues and none cover my fundamental request ### How long have you been using BookStack? Under 3 months ### Additional context i admit there there is a closed issue #3968 I would really like to ask you to reconsider this. Because there is the option in the GUI to copy permissions from shelf to book level. However, achieving this via the API is very complicated and resource-consuming. Another solution would be, that books automatically inherit the permissions from the shelf with the most far-reaching permissions they are assigned to.

OVERLORD added the 🔨 Feature Request label 2026-02-05 10:11:15 +03:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#5585