Migrate to v2 APIs

We’re excited to introduce you to Ada’s v2 APIs and the new capabilities they offer our platform. In this guide, we’ll walk you through the key changes and provide actionable steps to help you transition from v1 to v2 smoothly.

Key Improvements and Changes

Updated Endpoints

The v2 API consolidates several legacy endpoints, reducing redundancy and making integration simpler. Endpoints are organized by resource and action, allowing you to find exactly what you need more quickly.

Reference the v2 documentation to see which endpoints map to your existing v1 calls. Here’s an example mapping for the End Users API:

• v1: https://example.ada.support/api/end-users/v1/
• v2: https://example.ada.support/api/v2/end-users/

Streamlined API Tokens

The v2 API consolidates API tokens so they work across all endpoints. In v1, it was necessary to create an API token for each API. In v2, you can create a single token that works with all endpoints across APIs. Learn more about creating new API tokens.

Uniform Response Structures

In v1, responses could vary significantly from endpoint to endpoint. In v2, responses (including errors) follow a consistent JSON structure, making it easier for you to parse data and handle errors uniformly across different API calls.

Standardized Pagination

v2 API also introduces standardized cursor-based pagination across all endpoints, ensuring a consistent experience when retrieving large sets of data. Pagination parameters such as page, limit, and cursor are uniformly applied, and responses include clear metadata about the pagination state. For more details, refer to the pagination guide.

Improved Rate and Data Limits

The v2 API introduces more transparent rate limit and data limit policies. This helps you plan your requests, ensures better reliability, and prevents service degradation from unexpected traffic spikes.

Backward-Incompatible Changes

Some functionality has been deprecated or updated in a backward-incompatible way. Be sure to review any endpoints or parameters you currently rely on and confirm their v2 equivalents. When in doubt, check the v2 documentation.

Migration Steps