API: Include cover image details for book & shelf list responses #4926

New Issue

OVERLORD · 2026-02-05T09:26:56+03:00

OVERLORD commented

2026-02-05 09:26:56 +03:00

Originally created by @ln-ws on GitHub (Aug 26, 2024).

Describe the feature you'd like

When making a READ request to the /books/{id} endpoint, the response includes a cover object containing the cover image data for the specified book. However, when making a LIST request to the /books endpoint, the response does not include this cover object.

Including the cover object in the LIST response would allow users to retrieve cover image data for all books in a single request, rather than needing to make separate requests for each book's cover image. This enhancement would reduce the overhead of fetching cover images and improve the efficiency of implementing book search functionalities.

Describe the benefits this would bring to existing BookStack users

Reduces the overhead associated with making multiple requests to fetch cover images.
Simplifies API usage by providing a more comprehensive response in a single request.

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

Yes, it is currently possible to achieve this by making individual requests for each book's cover image. However, this method increases the number of API calls and associated overhead.

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?

3 months to 1 year

Additional context

No response

Originally created by @ln-ws on GitHub (Aug 26, 2024). ### Describe the feature you'd like When making a `READ` request to the `/books/{id}` endpoint, the response includes a cover object containing the cover image data for the specified book. However, when making a `LIST` request to the `/books` endpoint, the response does not include this cover object. Including the cover object in the `LIST` response would allow users to retrieve cover image data for all books in a single request, rather than needing to make separate requests for each book's cover image. This enhancement would reduce the overhead of fetching cover images and improve the efficiency of implementing book search functionalities. ### Describe the benefits this would bring to existing BookStack users - Reduces the overhead associated with making multiple requests to fetch cover images. - Simplifies API usage by providing a more comprehensive response in a single request. ### Can the goal of this request already be achieved via other means? Yes, it is currently possible to achieve this by making individual requests for each book's cover image. However, this method increases the number of API calls and associated overhead. ### 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? 3 months to 1 year ### Additional context _No response_

OVERLORD added the 🔨 Feature Request label 2026-02-05 09:26:56 +03:00

OVERLORD closed this issue

2026-02-05 09:26:57 +03:00

OVERLORD commented

2026-02-05 09:26:58 +03:00

@ssddanbrown commented on GitHub (Oct 14, 2024):

Thanks for the request @ln-ws,
I agree with this addition it's something we already do in the UI (list books with cover images).
I'm going to update this to also mention shelves since it's the same scenario there.
I've assigned this for the next feature release.

@ssddanbrown commented on GitHub (Oct 14, 2024): Thanks for the request @ln-ws, I agree with this addition it's something we already do in the UI (list books with cover images). I'm going to update this to also mention shelves since it's the same scenario there. I've assigned this for the next feature release.

OVERLORD commented

2026-02-05 09:26:59 +03:00

@ssddanbrown commented on GitHub (Dec 13, 2024):

Cover images have now been added to book & shelf list responses as part of commit 7e1a8e5ec6.
This will be part of the next feature release.

@ssddanbrown commented on GitHub (Dec 13, 2024): Cover images have now been added to book & shelf list responses as part of commit 7e1a8e5ec676a2f9a27acef71da6d6c0b5916384. This will be part of the next feature release.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#4926