Documentation for users API is incorrect
complete
G
Gunmetal Otter
In the swagger documentation for the /workgroups/users API (https://app.swaggerhub.com/apis-docs/magicplan/magicplanCloudApi/1.2#/), the response is specified as having a "data" property which is an array of objects.
In fact, the "data" property is an object that contains paging information, and a "users" key which is an array.
It would be useful to update the documentation to account for this, and include paging/filtering API parameters, since none are mentioned.
Log In
G
Gunmetal Otter
Glad to hear that, thank you Finneas Reich.
The new documentation doesn't mention any parameters for the users API. I notice there is an undocumented
page
parameter that allows us to do paging. Are there any filtering parameters?
Finneas Reich
Hi Gunmetal Otter , thanks for your feedback! I checked your reply with the team. We update the documentation again, please have a look: https://app.swaggerhub.com/apis-docs/magicplan/magicplanCloudApi/1.2#/workgroups/getWorkgroupUsers
G
Gunmetal Otter
Finneas Reich: That's great. Thanks for your help!
Finneas Reich
marked this post as
complete
Hi everyone, the updated documentation went live with the release 2024.1.0.
Finneas Reich
marked this post as
in progress
Finneas Reich
marked this post as
planned
Finneas Reich
marked this post as
under review