# Changelog

**Release:** v3.0.0 (initial release)

## What's new

Sprinklr API v3 is now available. v3 is a RESTful, OpenAPI-described interface for managing customer experience data and processes across the Sprinklr platform, with a consistent response format across every endpoint.

**At a glance**

|  |  |
|  --- | --- |
| OpenAPI version | 3.0.3 |
| Specification version | 3.0.0 |
| Base URL | `https://api3.sprinklr.com/{env}/api/v3` |
| Authentication | OAuth 2.0 bearer token (`Authorization`) **and** API key (`Key`) |


## Highlights

- **Standard REST semantics.** Operations are split across `POST`, `GET`, `PUT`, `PATCH`, and `DELETE` on a single resource path, instead of overloading `POST` as v2 often did.
- **Consistent response envelope.** Every endpoint returns `data`, `errors`, and — where paginated — `metadata`.
- **Structured error handling.** Errors are returned as an array of objects with `id`, `code`, and `message`, alongside the HTTP status code.
- **Descriptive field naming.** String enums replace numeric enums, and field names are consistent across API families.
- **Shared error responses.** `400`, `401`, `403`, and `404` are defined once and reused across all operations.
- **Single environment-aware server.** One base URL with an `{env}` variable covering all supported production environments.


## Getting started

1. Generate your API key and secret, then complete the OAuth 2.0 authorization flow.
2. Call `GET /api/v3/me` to confirm your credentials and resolve your user context.
3. Browse the API Reference for the family you need.


## Documentation

- **[Sprinklr APIs Introduction](#)** — base URLs, environments, authentication, common headers, and the response envelope.
- **[API Reference](apis/sprinklr-v3)** — the full, interactive v3 endpoint reference generated from the OpenAPI specification.
- **[Developer Guides](guides/developer-guides-v3/account-api-v3-developer-guide)** — task-oriented guides with request/response examples, v2 → v3 migration mapping, and best practices.


## Migrating from v2

API v2 remains available. Each Developer Guide includes a **v2 → v3 migration** section covering endpoint mapping, field mapping, and step-by-step migration instructions for that API family.

Start with the endpoint and field mapping tables in the guide for the API you use today, then update your base URL, request shapes, and response parsing to match the v3 envelope.

## Feedback

Report issues or request additions through your Success Manager or by raising a ticket with Sprinklr Support.