API Reference

Interactive API reference powered by Scalar — explore all endpoints, try requests, and view schemas.

Interactive Explorer

The full interactive API reference is available at:

Open API Reference

The reference is auto-generated from our OpenAPI 3.0 specification and includes:

• All 9 resource groups with request/response schemas
• Try-it-now functionality for testing requests
• Authentication configuration
• Example payloads

OpenAPI Specification

Download the raw OpenAPI spec for code generation or import into tools like Postman:

curl https://api.lend.works/v1/openapi.json

You can use this spec with:

• Postman — Import as a collection
• Insomnia — Import workspace from URL
• openapi-generator — Generate client SDKs in any language
• Swagger Editor — Visualize and edit the spec

Resource Groups

Base URL

https://api.lend.works/v1

Authentication

All endpoints (except /status and /webhooks/catalog) require Bearer token authentication:

Authorization: Bearer lw_live_xxxxxxxxxxxxxxxx

See the Authentication guide for details.

Response Envelope

All responses use a consistent envelope:

{
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "type": "lead",
    "attributes": { ... }
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Error responses:

{
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Invalid email format",
      "detail": { "field": "email" }
    }
  ],
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Response Headers

Every response includes: