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

# Versioning

> How the FoxReach API handles versioning and breaking changes.

## API Versioning

The FoxReach API uses **URL-based versioning**. The current version is `v1`.

```
https://api.foxreach.io/api/v1/leads
```

## Versioning Policy

* **Major versions** (v1, v2, etc.) may include breaking changes
* When a new major version is released, the previous version continues to work for a deprecation period
* We will communicate deprecation timelines well in advance

## What Counts as a Breaking Change

These are considered breaking changes and will only happen in a new major version:

* Removing an endpoint
* Removing or renaming a response field
* Changing the type of a response field
* Changing the meaning of an existing field
* Adding required request parameters to existing endpoints
* Changing authentication methods
* Changing error response format

## What Is NOT a Breaking Change

These changes can happen at any time without a version bump:

* Adding new endpoints
* Adding new optional request parameters
* Adding new fields to response objects
* Adding new event types for webhooks
* Adding new enum values (e.g., new lead statuses)
* Fixing bugs in existing behavior
* Improving error messages

## Recommendations

* **Always specify the version** in your API URLs (`/api/v1/`)
* **Handle unknown fields gracefully** — don't fail if the response contains fields your code doesn't expect
* **Subscribe to our changelog** for updates about new features and deprecation notices