Ideagen supports APIs as described in published API Services documentation. You should expect the documented parameters, fields, and data structures to remain unchanged for a given version of a documented API endpoint. You should also avoid using undocumented data (parameters, fields, and data structures) that you may notice in an API response, as that data (parameters, fields, and data structures) is not guaranteed to remain consistent and will change over time with no notice.

When implementing necessary changes to an API that alter or remove currently documented parameters, fields or data structures, Ideagen will provide a new version of the API, leaving the current version intact (for a period of time). Versions typically appear in the path of a given API endpoint, such as /api/v1/users. The next version of that same API, for example, would be /api/v2/users.

Before deprecating support for an older version of an API, Ideagen will provide ample warning and allow a reasonable amount of time (and instructions) to migrate to the latest version.

Ideagen supports the latest version of any API as well as the version immediately preceding that one, as long as the previous version is still in use. Once everyone has migrated to the latest version, Ideagen will stop supporting the previous version.