Total Parks API versioning

The current totalparks public REST surface is major version 1. Unversioned URL paths are v1. Product name: Total Parks.

How to select a version

Send optional header API-Version: 1, or omit the header. Both mean major version 1. The OpenAPI document at /openapi.json declares this header parameter. Existing paths such as /carts and /properties stay unversioned for v1 so current clients keep working.

Accepted values today: 1, 1.0, and 1.0.0. An unknown major version returns HTTP 400 with application/problem+json.

Compatibility

Additive, backward-compatible changes stay on v1. Breaking changes require a new major version (a new header value and, if needed later, a new URL prefix). Until a v2 ships, there is only one public REST major.

Deprecation signalling

When an operation is retired, Total Parks will mark it deprecated: true in OpenAPI and advertise a timeline with:

RFC 9745 Deprecation: @<unix-timestamp>
RFC 8594 Sunset: <HTTP-date>
Link with rel="deprecation" pointing at this policy

Deprecated operations remain available for at least 90 days after the Sunset date is first advertised. The current v1 surface is not deprecated, so live responses do not send Deprecation or Sunset headers today.

Total Parks API · All Total Parks developer resources