GoCanvas is excited to announce the release of API v3, now available on qualifying plans.
GoCanvas API v3
GoCanvas API v3 represents years of feedback collected by our current API users and includes many of our most commonly requested API features from our beta program. Our new API follows industry standards as a RESTful JSON API with robust documentation.
Going forward, API v3 will be a building ground for additional improvements to help connect GoCanvas with our customer’s other systems and to offer powerful integrations with other software. To keep up to date on any updates, follow the Release Notes Topic in the Community or the Release Notes section in the Help Center.
Deprecation of API v1, API v2, and API Keys
In order to focus our efforts on supporting our newest API, API v1 and v2 have been deprecated as of April 15th, 2025. Please review the plans below for the removal of API v1 and v2 in 2026 and 2027 respectively.
- Effective April 15th, 2025, API v1 is officially deprecated and will not be receiving support.
- On May 1st, 2026, requests made to API v1 will return a "404 Not Found" error.
- Please see the Migration Guide from v2 to v3 for recommendations on how to adapt API implementations to the newest version.
- Effective April 15th, 2025, API v2 is officially deprecated and will not be receiving support.
- On May 1st, 2027, requests made to API v2 will return a "404 Not Found" error.
- API Keys functionality is not supported on API v3, which offers OAuth client_credentials flow as a recommended alternative; API Keys will be removed on May 1st, 2027 with the sunset of API v2.
- Please see the Migration Guide from v2 to v3 for recommendations on how to adapt API implementations to the newest version.
Maintenance Policy for API v3
GoCanvas API versioning follows semantic versioning, treating the published number as a “major” release. As such, best efforts will be made to introduce changes in a reverse-compatible way. Should a “major” change be needed to improve the API, we would announce an API v4 and make a determination at that point if v3 needs to be deprecated with ample warning to allow customers to migrate to a newer version.
Comments
Please sign in to leave a comment.
We are trying to upgrade from v2 to v3 when we ran into an issue with v3. In v3, the form submission labels are not honoring the "Export label" values like v2 did. Field values can be answers to long questions in our GoCanvas forms. We use your "Export label" feature to abbreviate the label so it's something short and matches our database table fields. I believe this is something you somehow overlooked when creating your new API and will need to be corrected ASAP.
Also, the looped screens should be an array, and they are not. I wish a little more thought was put into this.
Hi Chris Crowley
Thank you for raising these concerns. I have passed them along to Product but may I also ask that you submit these requests to beta@gocanvas.com so that they have these needs formally on record? Thank you in advance.
Also, API v3 has been in development for quite some time and this is just the first release; bringing API v3 to parity with v2 is still in progress. Although we encourage everyone to upgrade if they can, if you cannot due to parity discrepancies, API v2 will still be available until May of 2027 to give you plenty of time to transfer everything over.