API versions

The Canva Connect APIs are versioned with a date-based version. This allows Canva to make breaking changes to the API without affecting existing integrations.

Whenever a breaking change is made, a new Connect API version is released with a version identifier based on the change date, for example 2024-01-31. It's anticipated that superseded versions of the API will remain supported for at least 6 months before the old version is deprecated and removed.

For a list of API versions and a log of breaking and non-breaking changes, see the Changelog.

Breaking vs. non-breaking changes

This section describes how Canva defines what's a breaking change, and what's a non-breaking or backwards compatible change.

Breaking changes

The following are considered breaking changes, which would require the creation of a new API version:

Changing the required scopes for an API.
Adding a required request parameter.
Changing a request parameter from optional to required.
Changing the default value of a request parameter.
Updating an optional query or search parameter.
Removing an enumerated value from a request parameter.
Removing a request parameter.
Changing a validation rule for request parameters or response properties.
Adding an enumerated value to a response property.
Changing a response property from required to optional.
Changing response property behavior. For example, changing the meaning or structure of a property's value.
Removing a response property.
Changing a Connect API behavior in a way that isn't backwards compatible. For example, changing the way uploads are processed, or how quality settings are applied.
Changing the HTTP response status code for an API.

Non-breaking changes

The following are considered non-breaking changes, which wouldn't require the creation of a new API version: