Skip to main content
GET
List dated API versions

Authorizations

Authorization
string
header
required

Enter your MeshAPI key (rsk_...) — sent as Authorization: Bearer <key>.

Headers

X-Mesh-Version
enum<string>
default:2026-08

Dated version of the API contract to pin this request to. Omit it and the request is served under 2026-08 — the oldest supported version, so an existing integration is never moved by a release. A malformed or unsupported value is rejected with 400 invalid_api_version rather than falling back silently. The version actually served is echoed as X-Mesh-Version on every response, including errors.

Available options:
2026-08

Response

Successful Response

label
string
required

The value to send as X-Mesh-Version, e.g. 2026-08.

status
string
required

ga | deprecated | sunset.

released
string
required

ISO date this version became available.

baseline
boolean
required

True for the version a caller gets with no X-Mesh-Version header and no stored pin. This is the OLDEST supported version, so an existing integration is never moved by a release.

latest
boolean
required

True for the newest released version. Note this is NOT the default — pin it explicitly to receive it.

deprecated_on
string | null

ISO date this version was deprecated, or null. Feeds the Deprecation response header.

sunset_on
string | null

ISO date this version stops being served, or null. Feeds the Sunset response header.

notes_url
string | null

Migration guide for leaving this version, or null.