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 Susanne 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?
Susanne 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
Susanne Reich: That's great. Thanks for your help!
Susanne Reich
complete
Hi everyone, the updated documentation went live with the release 2024.1.0.
Susanne Reich
in progress
Susanne Reich
planned
Susanne Reich
under review