# WorkOS API versioning and deprecation policy

WorkOS versions its REST API in the URL path. Integrations should use the current documented version and monitor the [WorkOS changelog](https://workos.com/changelog) for changes.

## Deprecation signals

Deprecated fields and operations are marked with `deprecated: true` in the [OpenAPI specification](https://workos.com/docs/openapi.json) and identified in the API reference. A deprecation notice states the effective date, affected responses or fields, and the supported migration path before removal.

## Current notices

The [deprecations documentation](https://workos.com/docs/deprecations/raw-attributes) lists current effective dates and step-by-step migrations. Agents should prefer replacement fields and operations whenever the API reference marks an older surface as deprecated.
