API reference - Lancer

The reference pages are generated from Lancer’s OpenAPI 3.1 document, which is built from the same Zod contracts the API validates requests with, so the docs and the API can’t drift apart.

Base URL

https://api.lancer-erp.com/api

OpenAPI document

Public, no key needed. Import it into Postman, Insomnia or an n8n HTTP Request node.

Endpoints

Endpoint	Scope
`POST /v1/leads`	`leads:write`
`GET /v1/clients`, `GET /v1/clients/{id}`	`clients:read`
`POST /v1/clients`	`clients:write`
`GET /v1/projects`, `GET /v1/projects/{id}`	`projects:read`
`GET /v1/payment-requests`, `GET /v1/payment-requests/{id}`	`payment_requests:read`
`POST /v1/payment-requests`	`payment_requests:write`
`GET /v1/payments`	`payments:read`

Conventions

Auth: Authorization: Bearer lk_… or X-Api-Key: lk_…. See Authentication.
Money: integer agorot (₪1 = 100). See Pagination and money.
Lists: page and pageSize (max 100) → { items, total, page, pageSize }.
Errors: { error, code? }, and 400 lists the fields that failed validation. See Errors and rate limits.

Get a pay link in one call

POST /v1/payment-requests with "createLink": true creates the request, creates a hosted payment page through the organization’s default payment processor, marks the request as sent and returns the link as payUrl:

curl -X POST https://api.lancer-erp.com/api/v1/payment-requests \
  -H "Authorization: Bearer $LANCER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "clientId": "0193…", "title": "Website redesign: milestone 1", "amountAgorot": 590000, "createLink": true }'

When the client pays, you get a payment.succeeded webhook and the receipt is issued by the organization’s documents provider.

⌘I