Need to export data from GoCanvas? Want to automatically import information into your own system? Then the GoCanvas API v3 is right for you.
API v3
The GoCanvas API v3 allows users to extract data and create objects in GoCanvas, like Dispatches, from another system. The API uses the industry standard RESTful JSON API, REST (Representational State Transfer) endpoints in JSON (JavaScript Object Notation)with robust documentation. API v3 incorporates years of feedback collected by our current API users and many of our most commonly requested API features.
API v3 is now available to customers on qualifying plans Please keep in mind that you must be logged into a GoCanvas account that has API (formerly known as Web Services) included in order to view the documentation.
API v2 is Deprecated as of April 15th, 2025
Please visit the Help Center article, "GoCanvas Web Services v2 Documentation" to view the previous API documentation. Starting in May of 2027, requests made to API v2 will return a "404 Not Found" error.
Customers looking to implement GoCanvas’ API are strongly encouraged to use our best-available version: API v3.
Please submit a ticket to Support if you have an issue, or provide valuable feedback to our Product team at beta@gocanvas.com.
Did we answer your question?
We'd really appreciate your feedback! Please leave your suggestions for improvement in the comments or let us know what you're looking for so we can assist you better. We want to help, but we need to understand your needs!
Comments
6 commentsPlease sign in to leave a comment.
Where is the documentation for the new v3 API?
Will the new v3 API now support JSON in addition to XML?
Hello Chris Crowley!
The good news is that V3 API supports JSON! And it is currently available by request. Please contact your Account Representative to be invited to the beta/preview and for the link to the V3 API documentation.
Where is the open api spec?
https://swagger.io/specification/
Hello API Access,
Thank you for your question! I believe the documentation you are looking for is only available through an Account Representative for accounts that have API access in their plan. Reach out to your Account Rep for more information or contact our sales team if you don't have a specific representative.
I am attempting to update my API key in GoCanvas. However, I am unable to locate the "Account" option in my menu. I hold the Department Admin role, which I understand should grant access to this feature. Could you please clarify why this option is not visible to me?
Administrator Arch Painting
Great question, the Account drop down is accessible under the All department.