PlanData API is undocumented
G
Gray Harrier
If you fetch a plan with this API: https://app.swaggerhub.com/apis-docs/magicplan/magicplanCloudApi/1.2#/plans/getPlan
You will get a "plan", which contains "plan_detail", which contains "plan" of type PlanData. This type is not documented, and seems to be where most of the interesting things are.
There is a note saying "the current version of this model is in beta. We welcome your valuable feedback and any specific requirements you may have.", but it is hard to have good feedback when there is no documentation – we have to make guesses from the data we get.
Log In
This post was marked as
open
This post was marked as
planned
R
Relieved Wallaby
closed
R
Relieved Wallaby
Thank you for your feedback – we appreciate you taking the time to dig into the Plan Details API.
You're absolutely right: the plan_detail.plan object (of type PlanData) currently lacks proper documentation, which makes it difficult to understand the structure and capabilities. This was part of an earlier initiative that was never fully finalized, and the "beta" notice is unfortunately outdated.
To clarify:
- The Plan Details API is being kept for backward compatibility, but we no longer recommend it for new integrations.
- Instead, we suggest using our Project APIs, which provide a more consistent, better-documented, and actively supported data model.
We're in the process of updating our documentation to reflect this more clearly, including:
- Removing the outdated beta label.
- Adding deprecation guidance and redirecting users toward Project APIs.
In the meantime, if you're integrating now or planning future work, please consider switching to the Project APIs – and don’t hesitate to reach out if you need guidance on how to map data between the two models.
Thanks again for raising this!
Finneas Reich
Hi Gray Harrier , we have an update for you on this topic: We now have the Project Plan API which exposes all relevant infos, you can find it here: https://magicplan.apidocumentation.com/reference#tag/projects/GET/projects/{id}/plan . The plan is to extend this API with measurements soon.