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

# Versioning

> How OrgX versions Public Preview API contracts.

OrgX REST is in Public Preview. The preview contract is documented publicly and
intended for real integrations, while still allowing controlled changes before
General Availability.

## Preview Contract

Preview endpoints use the current production contract. `OrgX-Version` is the
reserved compatibility header for integrations that pin a documented contract
date as versioned behavior hardens.

```bash theme={"dark"}
curl https://useorgx.com/api/client/bootstrap \
  -H "Authorization: Bearer $ORGX_API_KEY" \
  -H "OrgX-Version: 2026-04-29"
```

## Compatibility Policy

During Public Preview, OrgX aims to preserve:

* authentication behavior
* documented request fields
* documented response fields
* documented error status codes
* pagination fields on list endpoints

OrgX may add fields at any time. Clients should ignore unknown fields.

<Note>
  Some preview routes may ignore `OrgX-Version` until the stable versioning
  layer is enabled. It is safe to send the header now for integration
  traceability, but do not treat it as a GA compatibility guarantee yet.
</Note>

## Breaking Changes

Before GA, breaking changes may happen when an endpoint graduates from preview
to stable. When they do, docs will call out:

* the affected endpoint
* the old behavior
* the new behavior
* a migration path
* the date the old behavior stops working

## Stable Version Target

The stable REST API will use a GA versioning policy before `/v1` is declared
generally available. Until then, treat `/api/client/*` as the authenticated
Public Preview REST surface.