> ## 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.

# API changelog

> API-specific changes for developers building Windmill integrations.

This changelog tracks public API changes separately from [general product updates](https://help.gowindmill.com/changelog.md). The [public OpenAPI document](https://api.gowindmill.com/api/v2/openapi.json) is the source for the current endpoint contract.

## API v2 employee release

### Employees and credentials

* Public workspace paths use `/c/{companyId}` and accept a stable company ID or a workspace slug. Credentials remain workspace-scoped.
* API-key requests use `Authorization: Bearer <key>`. Keys respect the creator's current permissions and their read or read/write access.
* [Employee creation](https://help.gowindmill.com/api-reference/employees/create-an-employee.md) uses `primaryEmail` and creates new records only. Existing current or former employees return `409`; use the [employment-status operation](https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status.md) for a rehire.
* Explicit ownership claims on [employee updates](https://help.gowindmill.com/api-reference/employees/update-an-employee-profile.md) use `claimOwnership`.

### Field sources

* Public routes use `/field-sources/available-sources`, `/field-sources/defaults`, and `/field-sources/resolve` within the workspace path.
* Employee-specific routes use `/employees/{employeeId}/field-sources`.
* Public source identifiers use normalized names such as `bamboo-hr`, `google-workspace`, and `just-works`. Start with [List available employee field sources](https://help.gowindmill.com/api-reference/employee-field-sources/list-available-employee-field-sources.md).

### Pagination and limits

[Profile search](https://help.gowindmill.com/api-reference/employees/search-employee-profiles.md) defaults to 20 results and allows up to 100 per page. [ID search](https://help.gowindmill.com/api-reference/employees/search-employee-ids.md) defaults to and allows up to 1,000. Both return `hasMore`; totals are opt-in.

The API-client budget is 500 requests per minute per API key, or per OAuth client and workspace. Limited requests return `429` with `RATE_LIMITED` in the standard error envelope and a `Retry-After` header. See [Rate limits](https://help.gowindmill.com/api-reference/rate-limits.md).

## Following future changes

Check this page alongside the generated reference when updating an integration. See [Versioning](https://help.gowindmill.com/api-reference/versioning.md) for guidance on using the v2 contract.


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