Add Tags and Plain Text Page Body to Pages Response API /api/pages #2196

New Issue

OVERLORD · 2026-02-05T03:16:56+03:00

OVERLORD commented

2026-02-05 03:16:56 +03:00

Originally created by @jblankenship30 on GitHub (Apr 14, 2021).

API Endpoint or Feature

For the /api/pages API that returns all pages available to the user, it would be nice to have the page tags and plain text body of the page included in the response.

Use-Case

An application would use the /api/pages API to return all pages available to the public user then using the NAME, TAGS, and BODY data points in the response can do an internal search for the desired page. Once the desired page has been found the APP can use the ID data point to call the /api/pages/{id} API for page HTML and additional page data.

Additional Context

I am trying to use Bookstack as a FAQ wiki within a custom Support Ticketing Software and wanting to search bookstack pages that match the issue subject being entered in the ticket app.

Originally created by @jblankenship30 on GitHub (Apr 14, 2021). #### API Endpoint or Feature For the /api/pages API that returns all pages available to the user, it would be nice to have the page tags and plain text body of the page included in the response. #### Use-Case An application would use the /api/pages API to return all pages available to the public user then using the NAME, TAGS, and BODY data points in the response can do an internal search for the desired page. Once the desired page has been found the APP can use the ID data point to call the /api/pages/{id} API for page HTML and additional page data. #### Additional Context I am trying to use Bookstack as a FAQ wiki within a custom Support Ticketing Software and wanting to search bookstack pages that match the issue subject being entered in the ticket app.

OVERLORD added the 🔩 API Request label 2026-02-05 03:16:56 +03:00

OVERLORD closed this issue

2026-02-05 03:17:05 +03:00

OVERLORD commented

2026-02-05 03:17:10 +03:00

@ssddanbrown commented on GitHub (Apr 4, 2022):

Thanks for the request @jblankenship30,

Since this was requested, we've since added a search API endpoint: https://www.bookstackapp.com/blog/bookstack-release-v21-11/#search-api-endpoints

I feel this much better suites the fundamental use-case being requested here, since it can search content and tags in a scalable manner. Adding detail to the /api/pages endpoint does not feel like the right solution for the use-case described since it expands the scope of this endpoint to any detail in which people may want to search upon, plus full listing and parsing of all pages is not really an efficient method of search, especially once your page count exceeds that returned on a single API request.

I'm therefore going to close this off but feel free to comment and/or request re-open if you feel the fundamental use-case is not met.

@ssddanbrown commented on GitHub (Apr 4, 2022): Thanks for the request @jblankenship30, Since this was requested, we've since added a search API endpoint: https://www.bookstackapp.com/blog/bookstack-release-v21-11/#search-api-endpoints I feel this much better suites the fundamental use-case being requested here, since it can search content and tags in a scalable manner. Adding detail to the `/api/pages` endpoint does not feel like the right solution for the use-case described since it expands the scope of this endpoint to any detail in which people may want to search upon, plus full listing and parsing of all pages is not really an efficient method of search, especially once your page count exceeds that returned on a single API request. I'm therefore going to close this off but feel free to comment and/or request re-open if you feel the fundamental use-case is not met.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#2196