Versioning

​

Endpoint

https://api.operata.io/v1/...
https://api.operata.io/v2/...

​

Parameters

​

Response

HTTP/1.1 200 OK
Deprecation: true
Sunset: Tue, 17 Nov 2026 00:00:00 GMT
Link: <https://operata.io/docs/api-changelog>; rel="deprecation"

• Additive changes ship in place. New optional fields on responses, new optional query parameters, new endpoints under an existing version. Your client keeps working without changes.
• Breaking changes ship under a new prefix. Renamed fields, removed fields, changed types, new required parameters, changed status codes, changed error codes — these go to the next major version. Operata does not silently change the wire shape of an existing endpoint.
• Deprecation window is six months minimum. From the day a Sunset header first appears, you have at least six months before the endpoint stops responding. Watch the API changelog for the announcement.

​

Example

curl -i -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  "https://api.operata.io/v1/data/calls?size=1" \
  | grep -iE '^(deprecation|sunset|link):'

import os, requests
from email.utils import parsedate_to_datetime

response = requests.get(
    "https://api.operata.io/v1/data/calls",
    auth=(os.environ["OPERATA_GROUP_ID"], os.environ["OPERATA_API_TOKEN"]),
    params={"size": "1"},
)
if response.headers.get("Deprecation") == "true":
    sunset = response.headers.get("Sunset")
    print(f"deprecated; sunsets {sunset}")
    if sunset:
        deadline = parsedate_to_datetime(sunset)
        # Schedule the migration before deadline.

​

Errors