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

# Versioning

> Use the API v2 contract and track changes to your integration.

## Use the v2 surface

The public API uses the `/api/v2` URL prefix. The [public OpenAPI document](https://api.gowindmill.com/api/v2/openapi.json) describes available operations, request fields, response fields, and authentication. The endpoint reference in this tab is generated from that document.

Keep the version prefix in your configured base URL:

```text theme={null}
https://api.gowindmill.com/api/v2
```

Start with [Search employee profiles](https://help.gowindmill.com/api-reference/employees/search-employee-profiles.md) to verify a new configuration. Use the operation reference when validating requests or generating a client.

## Prepare for changes

Read the [API changelog](https://help.gowindmill.com/api-reference/changelog.md) for API-specific changes. General product updates have a separate [product changelog](https://help.gowindmill.com/changelog.md).

Parse the documented response fields your application needs and handle additional response fields. Treat identifiers as opaque strings and branch on HTTP status and error codes rather than exact message text. Validate request fields against the operation's schema.

When updating a generated client or changing integration behavior, exercise your read, pagination, and error paths before switching production traffic. For questions about a specific change, contact [Windmill support](mailto:support@gowindmill.com) with the operation and a request ID if you have one.


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