API Versions
The Showpad API currently has two versions, each serving different needs.
What you'll learn:
- Differences between API v3 and v4
- When to use each version
- How to migrate from v3 to v4
| Version | Status | Best For |
|---|---|---|
| v3 | Stable, feature-complete | Most integrations; broadest endpoint coverage |
| v4 | Actively growing | Asset management, newer features, optimized uploads |
Both versions work in hybrid mode, so you can combine them to serve your needs.
API v3
This is our most complete version. There are no plans to deprecate this version, however, we will not be implementing further updates to it. The API v3 reference contains the full details about this version.
When making requests to API v3, be sure to use the correct base endpoint.
Some endpoints that are marked as deprecated in this version remain functional but are no longer updated. In most cases, you will find an equivalent endpoint in v4.
API v4
This is our newest version. This version's growth is ongoing. Check out the API v4 reference for the full details about this version.
Key Features
| Feature | What's New in v4 |
|---|---|
| Asset properties | New Author, Locale, and Tag categories properties on the Asset object. Assign one or more authors, localize content by country/language, and organize tags with multiple levels and bulk editing. |
| Upload flow | Assets are created immediately with an ID, no more polling ticket IDs. Set all properties in one request, processing happens asynchronously, and upload URLs leverage AWS servers closest to your location for faster speeds. |
When making requests to API v4, be sure to use the correct base endpoint.
Base Endpoints
The base endpoint to use in your requests, depends on the API version you're using.
| API Version | Domain | Description |
|---|---|---|
| v3 |
| Both work similarly and are essentially interchangeable for accessing the Showpad platform. |
| v4 |
| This is specifically reserved for accessing Showpad's newer style APIs, like v4. It does not support the older v3 API endpoints. |
Migrate from v3 to v4
Authentication is still handled via v3.
Migration affects you if you currently use these v3 endpoints:
- Users (partially)
- Tags
- Divisions
- Assets
Asset Migration Details
How v3 works
When you create an asset, a ticket ID is returned. You poll this ID to check if processing was successful. If successful, you receive an asset ID and can start managing the asset (adding tags, etc.). If not, the process restarts. Processing time depends on file size and type, making it unpredictable and requiring multiple requests.
How v4 works
The asset is created immediately and you get an ID right away. Processing happens asynchronously, and you can set all asset properties (including tags) in one request.
| Operation | Description |
|---|---|
| Create an asset | Creates the asset record and manages its metadata. See Asset Management. |
| Upload the file | Use the asset ID to retrieve an upload URL and content type. PUT the binary file with the correct content type header and file in the body. Upload URLs are on AWS, selecting a server closest to you for faster speeds. See Asset Management. |
| Update an asset | Add author or locale properties to existing assets using the update request. |
Next Steps
Ready to start making authenticated requests? Explore these related topics:
- Authentication - Set up OAuth2 and manage API tokens
- API Fundamentals - Learn request/response basics
- API Reference - Full endpoint specifications for v3 and v4
Was this page helpful?