Local API v1 end-of-maintenance schedule
Local API v1 will stop being maintained on March 31, 2027. v2 is available now; the two run in parallel for about nine months, during which v1 receives security fixes only.
Local API v2 ships with version 2.4. To give existing integrations room to migrate, v1 and v2 will run in parallel until March 31, 2027.
Schedule
| Date | Status |
|---|---|
| 2026-08-20 | v2 released, v1 fully supported |
| 2026-11-01 | v1 enters maintenance mode, security fixes only |
| 2027-03-31 | v1 stops responding, requests return 410 |
What changes
The main differences in v2:
- the session creation endpoint can launch a whole profile group, so the response shape changes from a single object to an array;
- error responses are unified as
{ "error": { "code": ..., "message": ... } }instead of each endpoint having its own format; - the authentication header name is unchanged, and existing Local API keys do not need to be regenerated.
For most integrations the work is confined to the response-parsing layer. A field-level mapping table is in the Local API documentation.
Checking which version you use
The Local API settings page in the client shows the current listening port and the enabled endpoint versions. If your scripts call paths without a version segment, you are on v1.
If you hit problems migrating, reach us through the help center — tell us which framework you use and how you call the API.