Why migrate?

API v2 introduces several enhancements designed to improve your development experience and enable more efficient and secure integrations. Here are some key reasons to make the switch:

Security: API v2 utilizes OAuth 2.0 authentication, the industry standard for secure integrations, and a two-tiered permissions system enabling both company-level and credential-specific access.
Performance: API v2 introduces pagination and filtering, new bulk operations, and adheres to standard API development practices, leading to improved efficiency.
Standardization: API v2 features a consistent design based on modern API development practices to ensure predictability and ease of integration. The API reference updates automatically with every change.

❗️
API v1 is now officially deprecated. While it remains functional until mid-2027, it will only receive limited maintenance support (critical bug fixes and security patches).

How to use our migration guides

To streamline your transition from v1 to v2, we've created a focused set of resources:

Endpoint mapping: Use this page first to find the corresponding API v2 endpoint for your current API v1 usage, and the related endpoint-specific migration guide.
Individual endpoint migration guides: These guides detail the specific differences and successful response behaviors for each endpoint. Guides are available for the most commonly used v1 endpoints and will be expanded over time.

To keep these guides concise, they do not repeat API-wide conventions. This includes:

Standard headers: Authorization (for authentication) and 360-api-version (for API versioning) headers are required for all endpoints and are not repeated in endpoint-specific migration guides.
Error responses: General API errors (e.g., authentication, rate limiting, validation) are documented separately in the Error handling documentation. You'll also find endpoint-specific error details in the API Reference. Note that API v2 errors are generally more specific to simplify debugging.

Migration steps

Review endpoints: Identify the API v1 endpoints your application currently uses.
Check endpoint mapping: Find the corresponding API v2 endpoints with the Endpoint mapping.
Get started: Use our Getting started guide to obtain API credentials, understand the basics of using our API, and make your first requests.
Develop and test in staging: We recommend testing your application with API v2 in a staging environment before going live. This allows you to identify and address any potential issues.
Go live!

If you have any questions or need assistance during the migration process, feel free to contact your CSP or our amazing Support team!