Changelog

API version history and breaking changes.

Versioning Model

The LendWorks API uses date-based versioning (similar to Stripe). The current API version is returned in the LW-API-Version header on every response.

Current Version

`2025-01-15` (Current)

Initial public API release with:

9 resource groups: leads, applications, lenders, funded deals, commissions, analytics, automations, dialer, webhooks
API key authentication with permission scoping (read, read_write, full)
Tiered rate limiting (basic, standard, premium)
Idempotency support for all write operations
HMAC-SHA256 signed webhooks with automatic retry and circuit breaker
OpenAPI 3.0 specification with interactive Scalar documentation
TypeScript SDK (@lendworks/sdk-node) and webhook verifier (@lendworks/webhook-verify)

Upgrade Policy

When breaking changes are introduced, a new API version date is published. Your API key continues to use the version it was created with unless you explicitly upgrade.

Non-breaking changes (new fields, new endpoints, new webhook events) are added without a version bump and are immediately available to all API keys.

What counts as a breaking change

Removing or renaming a field from a response
Changing the type of an existing field
Removing an endpoint
Changing required fields in a request body
Changing error codes or HTTP status codes for existing conditions

What does NOT count as a breaking change

Adding new fields to response objects
Adding new endpoints
Adding new optional request parameters
Adding new webhook event types
Adding new enum values