> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziplined.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Versioning

> What can change in /v1, and how a deprecation is announced.

The version is in the path: `https://api.ziplined.io/v1`. This policy holds from 2026-11-06.

## What can change in /v1

Additive changes ship in `/v1` at any time:

* new endpoints
* new optional fields
* new error codes

Your client must ignore fields it does not know.

## Breaking changes

A breaking change ships only in a new path version, such as `/v2`. Removing or renaming an
endpoint or a field, changing the type of a field and making an optional field required are
breaking changes.

## Deprecation

A deprecated endpoint or version keeps working for at least 6 months after the announcement.
The announcement goes out in three ways:

* an entry in the [changelog](https://docs.ziplined.io/changelog.md)
* an email to every workspace that uses the API
* a `Deprecation` header ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)) and a `Sunset`
  header ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)) on the responses of the affected
  endpoints

`Deprecation` gives the date of the deprecation. `Sunset` gives the date after which the
endpoint can stop answering.

Nothing is deprecated now.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.