Web Services API v2 and API Keys are deprecated as of April 15th, 2025 and will be removed on May 1st, 2027. This migration guide will assist you in the process of updating your integrations before API v2 and API Keys are removed.
Migrating from API v2 and v3
For current implementations using GoCanvas’ API v2, please refer to the following sections for guidance on how to adapt implementation to API v3.
Note
The headings in this guide follow the outline of the API v2 documentation.
API Format
Whereas GoCanvas API v1 and v2 both used XML as the format for responses and requests, v2 uses JSON. JSON is natively supported in many modern programming languages. XML support for API v3 is not supported or planned.
Authentication
- Refer to the Authentication: Basic method for information on how to authenticate requests to the API using standard authentication headers.
- For current users of GoCanvas' API Keys, please refer to the Authentication: Bearer method to understand how OAuth client secrets can be used with API v3.
Forms API
Refer to the List all Forms method for retrieving Forms.
Submission API
- Refer to the List all Submissions method for retrieving Submissions. This v3 method replaces modes of the prior endpoint intended to query many submissions and retrieve a list.
- Refer to the Retrieve a Submission method for retrieving a single Submission. This v3 method replaces modes of the prior endpoint intended to retrieve a specific Submissions's full data.
Delete Submission API
Refer to the Delete a Submission method for deleting Submission by their ID.
Images API
Refer to the Retrieve a Value method for retrieving Images from a Submission. This v3 method supports Values for media fields (i.e. Photo, Videos, or Attachments).
Reference Data API
Refer to the Create Reference Data and Update Reference Data methods for creating and updating Reference Data.
CSV Meta Data API
This method is not directly mapped to a method in API v3. Instead, the List all Submissions method for retrieving Submissions supports retrieving metadata about Submissions by form_id. Each Form's Submissions can be queried separately.
CSV API
This method is not directly mapped to a method in API v3. Instead, the List all Submissions method should be used to retrieve the information in a JSON format which can then be transformed to CSV if desired.
Dispatch Items API
Refer to the Create an Immediate Dispatch and Create a Scheduled Dispatch methods for creating a new Dispatch. Note that the internal format of the new dispatch method now follows the same payload structure as creating Submissions rather than having a "<DI>” note structure; this allows Dispatches and Submissions to be created using similar implementations.
Dispatch Export API
- Refer to the List all Dispatches method for retrieving Dispatches. This v3 method replaces modes of the prior endpoint intended to query many dispatches and retrieve a list.
- Refer to the Retrieve a Dispatch method for retrieving a single Dispatch. This v3 method replaces modes of the prior endpoint intended to retrieve a specific Dispatch's full data.
Department API
This method is not directly mapped to a method in API v3. Instead, the List all Department Users method may be used to query Users via the Departments.
Submission Push Notifications
This functionality is not versioned with API v2 and will be preserved. A future enhancement may make this notification configurable to send JSON to align with our API v3 standard.
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
0 commentsPlease sign in to leave a comment.