Getting Started
Everything you need to integrate with the LendWorks platform.
Welcome to the LendWorks developer documentation. This guide covers the Broker API for programmatic access to your lending brokerage data and the Lender Portal for lender partner management.
Base URL
All API requests use the following base URL:
https://api.lend.works/v1Quick Start
Install the SDK and make your first API call in under a minute:
npm install @lendworks/sdk-nodeimport { LendWorksClient } from '@lendworks/sdk-node'
const client = new LendWorksClient({
apiKey: process.env.LENDWORKS_API_KEY,
})
const leads = await client.leads.list({ limit: 10 })
console.log(leads.data)Quick Links
- Authentication — API keys, permissions, and key rotation
- Leads — Create and manage leads in your pipeline
- Applications — Track loan applications through submission
- Webhooks — Real-time event notifications
- API Reference — Interactive Scalar API explorer
- SDKs — TypeScript SDK and webhook verification
Response Format
All successful responses use a consistent envelope:
{
"data": {
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "lead",
"attributes": {
"businessName": "Acme Corp",
"contactFirstName": "Jane",
"contactLastName": "Doe",
"email": "jane@acme.com"
}
},
"meta": {
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Collection responses include pagination metadata:
{
"data": [ ... ],
"meta": {
"total": 142,
"page": 1,
"limit": 20,
"hasMore": true,
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}API Versioning
The API uses date-based versioning (similar to Stripe). The current version is 2025-01-15. The version is returned in the LW-API-Version response header on every request.
Need Help?
- Interactive API Explorer — api.lend.works/api/docs
- OpenAPI Spec — api.lend.works/v1/openapi.json
- Dashboard — lend.works