General API call #4937

New Issue

OVERLORD · 2026-02-05T09:27:29+03:00

OVERLORD commented

2026-02-05 09:27:29 +03:00

Originally created by @sahara101 on GitHub (Aug 30, 2024).

API Endpoint or Feature

Hi,

A way to show an API json response where you get the total number of books, pages, shelves, etc in the same API call. Maybe /summary

Use-Case

I would love to be able too add Bookstack to Homepage. Right now with just one custom API URL possible I cannot combine the results.

Additional context

Here, by having a /summary API we could define both Total Books and Total Pages in the same widget for example.

Thanks!

Originally created by @sahara101 on GitHub (Aug 30, 2024). ### API Endpoint or Feature Hi, A way to show an API json response where you get the total number of books, pages, shelves, etc in the same API call. Maybe /summary ### Use-Case I would love to be able too add Bookstack to Homepage. Right now with just one custom API URL possible I cannot combine the results. ### Additional context <img width="388" alt="image" src="https://github.com/user-attachments/assets/ebf22237-8f3e-4f55-b2d7-9577be03d124"> Here, by having a /summary API we could define both Total Books and Total Pages in the same widget for example. Thanks!

OVERLORD added the 🔩 API Request label 2026-02-05 09:27:29 +03:00

OVERLORD closed this issue

2026-02-05 09:27:30 +03:00

OVERLORD commented

2026-02-05 09:27:31 +03:00

@chris-devel0per commented on GitHub (Sep 5, 2024):

What would be the Information you want to receive there?
Could you give some example of the response?

What would be the benefit of having that information? What do you exactly mean with "Homepage"?

@chris-devel0per commented on GitHub (Sep 5, 2024): What would be the Information you want to receive there? Could you give some example of the response? What would be the benefit of having that information? What do you exactly mean with "Homepage"?

OVERLORD commented

2026-02-05 09:27:33 +03:00

@sahara101 commented on GitHub (Sep 7, 2024):

Hi. I think total numbers of pages, books, shelves would be a start. I made this for now:

https://github.com/sahara101/bookstack-gethomepage-api

@sahara101 commented on GitHub (Sep 7, 2024): Hi. I think total numbers of pages, books, shelves would be a start. I made this for now: https://github.com/sahara101/bookstack-gethomepage-api

OVERLORD commented

2026-02-05 09:27:34 +03:00

@ssddanbrown commented on GitHub (Sep 7, 2024):

Thanks for the suggestion @sahara101 but I'm not keen on adding extra API endpoints for the primary purpose of adapting existing data you can get (totals) to suit specific business process (reduce to single API call).

@ssddanbrown commented on GitHub (Sep 7, 2024): Thanks for the suggestion @sahara101 but I'm not keen on adding extra API endpoints for the primary purpose of adapting existing data you can get (totals) to suit specific business process (reduce to single API call).

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#4937