What do you mean by "The API is currently in a limited preview stage to ensure the foundations are correct, It will be expanded upon in future releases." #2693

New Issue

OVERLORD · 2026-02-05T04:49:24+03:00

OVERLORD commented

2026-02-05 04:49:24 +03:00

Originally created by @papagei89 on GitHub (Mar 4, 2022).

Attempted Debugging

I have read the debugging page

Searched GitHub Issues

I have searched GitHub for the issue.

Describe the Scenario

Can we use the API in production ?
Does it only have limited features ?
Can we build upon it ?
Do you have API documentation outside of the software ?
Can we contribute to expanding the APIs ?
Thanks for the answers.

Exact BookStack Version

N/A

Log Content

No response

PHP Version

7.4

Hosting Environment

N/A

Originally created by @papagei89 on GitHub (Mar 4, 2022). ### Attempted Debugging - [X] I have read the debugging page ### Searched GitHub Issues - [X] I have searched GitHub for the issue. ### Describe the Scenario Can we use the API in production ? Does it only have limited features ? Can we build upon it ? Do you have API documentation outside of the software ? Can we contribute to expanding the APIs ? Thanks for the answers. ### Exact BookStack Version N/A ### Log Content _No response_ ### PHP Version 7.4 ### Hosting Environment N/A

OVERLORD added the 🐕 Support label 2026-02-05 04:49:24 +03:00

OVERLORD closed this issue

2026-02-05 04:49:29 +03:00

OVERLORD commented

2026-02-05 04:49:41 +03:00

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

Hi @papagei89,

Can we use the API in production ?

The limited preview message in our documentation was a bit outdated, from when the API was initially added. It's now considered supported as per the rest of BookStack. I have updated our documentation.

Can we build upon it ?

Sure, may people already are.

Does it only have limited features ?

Most of the core actions are now covered. I generally look to add some new endpoints on every release depending on what's been requested.

Do you have API documentation outside of the software ?

Not really. I you don't have access to your own instance to check it's API documentation you can view the API of our demo instance here: https://demo.bookstackapp.com/api/docs

I also have a repo containing examples of using the API for a range of use-cases in a variety of programming languages: https://github.com/BookStackApp/api-scripts

Can we contribute to expanding the APIs ?

Sure. If intending to develop the code for additional API endpoints, ideally you'd have some experience of PHP, Laravel and PHP testing. Please open an issue for discussion first to ensure it's something we'd merge to avoid potential disappointment if we were to reject your code.

There's a New API Endpoint or API Ability option when creating an issue that can be used specifically for API requests.

@ssddanbrown commented on GitHub (Mar 4, 2022): Hi @papagei89, > Can we use the API in production ? The `limited preview` message in our documentation was a bit outdated, from when the API was initially added. It's now considered supported as per the rest of BookStack. I have updated our documentation. > Can we build upon it ? Sure, may people already are. > Does it only have limited features ? Most of the core actions are now covered. I generally look to add some new endpoints on every release depending on what's been requested. > Do you have API documentation outside of the software ? Not really. I you don't have access to your own instance to check it's API documentation you can view the API of our demo instance here: https://demo.bookstackapp.com/api/docs I also have a repo containing examples of using the API for a range of use-cases in a variety of programming languages: https://github.com/BookStackApp/api-scripts > Can we contribute to expanding the APIs ? Sure. If intending to develop the code for additional API endpoints, ideally you'd have some experience of PHP, Laravel and PHP testing. Please open an issue for discussion first to ensure it's something we'd merge to avoid potential disappointment if we were to reject your code. There's a `New API Endpoint or API Ability` option when creating an issue that can be used specifically for API requests.

OVERLORD commented

2026-02-05 04:49:43 +03:00

@ssddanbrown commented on GitHub (Mar 7, 2022):

Since there's been no follow-up I'm going to close this. If any questions remain feel free to still comment here.

@ssddanbrown commented on GitHub (Mar 7, 2022): Since there's been no follow-up I'm going to close this. If any questions remain feel free to still comment here.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#2693