Migration from REST API v2 to v3

2 minutes to read

If you are currently using Caspio REST API version 2, we highly recommend migrating to version 3 to experience new features, including the new Swagger UI with OpenAPI Specification version 3.0, new operations, and new endpoints. For more information about the release of Caspio REST API v3 in May 2025, see Caspio 60.0 Release Notes.

To migrate your application to REST API v3, you need to update base URL for REST API endpoints in your application from:
https://<your-integration-URL>.caspio.com/rest/v2
to:
https://<your-integration-URL>.caspio.com/integrations/rest/v3

Example: update https://c0abc123.caspio.com/rest/v2/tables
to: https://c0abc123.caspio.com/integrations/rest/v3/tables.

Additionally, there are other important changes in REST API v3:

In applications operations:
- All endpoints were renamed from /v2/applications/ in v2 to v3/bridgeApplications/ in v3.
- Deploying and undeploying DataPages is handled using a PUT operation with a parameter. In v2, both PUT and DELETE operations were necessary.
Data import/export tasks endpoints were renamed from /v2/tasks/ to /v3/dataImportExportTasks
In Table operations, the PUT request model for updating table fields was changed to be the same as POST request model: the word “New” was removed from field names.
In Files operations:
- Files and Folders operations were separated. In v3, GET /v3/files returns files only, whereas a new operation, GET /v3/files/folders is used to return folders.
- Both GET /v3/files and GET /v3/files/folders have additional pagination and sorting options.
Error handling was improved. There are new HTTP codes and error texts.
The operationId values for REST API endpoints in the Swagger UI (OpenAPI) documentation have been revised for improved consistency and clarity. If you use tools or code generators (such as Swagger Codegen, OpenAPI Generator, or NSwag) to create client codes, SDKs, or API documentation based on the Swagger file, note that the generated method names in v3 will differ due to updated operationId values.

Full list of REST API v3 operations is available on Swagger UI.