1. GoCanvas Help Center
  2. Beyond GoCanvas: Analytics and Integrations
  3. Integrations

Does GoCanvas have an open API?

Updated
Lauren Sunday
Community Manager
Have more questions? Submit a request

This article provides introductory information on the GoCanvas API v3 as well as links to further documentation.

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

GoCanvas API v3 allows users to extract data and create objects in GoCanvas, like Dispatches, from another system. API v3 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 included with Pro and Max plans or can be purchased as an add-on. To view the documentation, see API v3 docs.

API v2 is Deprecated as of April 15th, 2025

To view previous API documentation, see, "GoCanvas Web Services v2 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!

Articles in this section

See more
Was this article helpful?
1 out of 1 found this helpful
Share

Comments

6 comments

Please sign in to leave a comment.

  • Chris Crowley

    Where is the documentation for the new v3 API?

    Will the new v3 API now support JSON in addition to XML?

    2
  • Lauren Sunday
    Lauren Sunday Community Manager
    (Edited )

    This response has been edited as of July 10th, 2026.

    Hello Chris Crowley!

    API v3 supports JSON and is included with Pro and Max plans or can be purchased as an add-on. To view the documentation, see API v3 docs.

    (Edited )
    0
  • API Access

    Where is the open api spec?

    https://swagger.io/specification/  

    0
  • Lauren Sunday
    Lauren Sunday Community Manager
    (Edited )

    This response has been edited as of July 10th, 2026.

    Hello API Access

    API v3 supports JSON and is included with Pro and Max plans or can be purchased as an add-on. To view the documentation, see API v3 docs.

    (Edited )
    0
  • Administrator Arch Painting

     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?

    0
  • Lauren Sunday
    Lauren Sunday Community Manager

    Administrator Arch Painting

    Great question, the Account drop down is accessible under the All department. 

    1. Expand the drop down menu under your username in the upper left corner of the portal.
    2. Select All to switch to the admin department.
    0