Inconsistency Between Documented and Actual API Responses: user_id Missing in /users Endpoint Responses #5178 #4928

New Issue

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

OVERLORD commented

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

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

Describe the Bug

The API documentation indicates that responses from the /users endpoint should include both id and user_id properties. However, in practice, the actual API responses only contain the id property, and the user_id property is missing.

Steps to Reproduce

Send a LIST request to the /users endpoint on your BookStack server.
Review the response returned by the server.
Notice that the user_id property is missing from the response, despite being documented.

Expected Behaviour

The response from the /users endpoint should include both id and user_id properties, where the user_id property matches the value of the id property for each user object within the data array.

Screenshots or Additional Context

No response

Browser Details

No response

Exact BookStack Version

v24.05.3

Originally created by @ln-ws on GitHub (Aug 26, 2024). ### Describe the Bug The API documentation indicates that responses from the `/users` endpoint should include both `id` and `user_id` properties. However, in practice, the actual API responses only contain the `id` property, and the `user_id` property is missing. ### Steps to Reproduce 1. Send a `LIST` request to the `/users` endpoint on your BookStack server. 2. Review the response returned by the server. 3. Notice that the `user_id` property is missing from the response, despite being documented. ### Expected Behaviour The response from the `/users` endpoint should include both `id` and `user_id` properties, where the `user_id` property matches the value of the `id` property for each user object within the data array. ### Screenshots or Additional Context _No response_ ### Browser Details _No response_ ### Exact BookStack Version v24.05.3

OVERLORD added the 🐛 Bug label 2026-02-05 09:26:58 +03:00

OVERLORD closed this issue

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

OVERLORD commented

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

@ssddanbrown commented on GitHub (Aug 26, 2024):

I'm deleting all above comments as I don't see any as relevant to the discussion, or they contain links to downloads on other sites that I'm not comfortable with having here, and/or they contain claims I'm not going to validate.
Any further links to external downloads (including archive links) will result in a block for BookStackApp projects.

@ssddanbrown commented on GitHub (Aug 26, 2024): I'm deleting all above comments as I don't see any as relevant to the discussion, or they contain links to downloads on other sites that I'm not comfortable with having here, and/or they contain claims I'm not going to validate. Any further links to external downloads (including archive links) will result in a block for `BookStackApp` projects.

OVERLORD commented

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

@ssddanbrown commented on GitHub (Aug 26, 2024):

Thanks for raising @ln-ws.
I can confirm the example response does not match the actual response.
I'll just look to remove the user_id from the example response. The id value should be used instead.

@ssddanbrown commented on GitHub (Aug 26, 2024): Thanks for raising @ln-ws. I can confirm the example response does not match the actual response. I'll just look to remove the `user_id` from the example response. The `id` value should be used instead.

OVERLORD commented

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

@ln-ws commented on GitHub (Aug 26, 2024):

Thank you

@ln-ws commented on GitHub (Aug 26, 2024): Thank you

OVERLORD commented

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

@ssddanbrown commented on GitHub (Aug 27, 2024):

Thanks again @ln-ws, this has been addressed as part of 1f2506221a to be part of the next patch release.

@ssddanbrown commented on GitHub (Aug 27, 2024): Thanks again @ln-ws, this has been addressed as part of 1f2506221ad7207b37bd093ca3233347d6d76ca1 to be part of the next patch 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#4928