Endpoints

This API reference contains the documentation for all supported third-party vPlan objects.
There are also undocumented endpoints, that are accessible with the API token, these endpoints are used by the application itself.
Undocumented endpoints are unsupported for third-party use. These endpoints are subject to change without prior warning.

For every object a data structure table is given, the field description can end with:

• for informational purposes only
  • this field is not used by vPlan but can be used freely to store extra information, e.g. for filtering
• reserved for future use
  • this field is not used by vPlan at this moment but can be limited in possible values in the future
• internally maintained
  • the value is calculated within vPlan and is read-only, the calculation could be async or triggered by an action

The examples in the sub pages show default requirements and options. This information applies to all endpoints unless explicitly stated otherwise.