Integrations
API Access
Build custom integrations with the Klearcut API
Build custom integrations with the Klearcut REST API.
Getting Started
Generate an API Key
- Go to Settings → Integrations → API
- Click Generate API Key
- Give it a name (e.g., "Website Integration")
- Copy the key — you won't see it again
Keep your API key secret. Don't commit it to code repositories or share it publicly.
Authentication
Include your API key in the header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.klearcut.io/v1/customersBase URL
All API requests go to:
https://api.klearcut.io/v1/Available Endpoints
| Endpoint | Methods | Description |
|---|---|---|
/customers | GET, POST | List and create customers |
/customers/:id | GET, PUT, DELETE | Manage a customer |
/quotes | GET, POST | List and create quotes |
/quotes/:id | GET, PUT | Manage a quote |
/jobs | GET, POST | List and create jobs |
/jobs/:id | GET, PUT | Manage a job |
/invoices | GET, POST | List and create invoices |
/invoices/:id | GET, PUT | Manage an invoice |
/products | GET, POST | List and create products |
Example: Create a Customer
curl -X POST https://api.klearcut.io/v1/customers \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Smith Builders",
"email": "john@smithbuilders.com.au",
"phone": "0412 345 678"
}'Response:
{
"id": "cust_abc123",
"name": "Smith Builders",
"email": "john@smithbuilders.com.au",
"phone": "0412 345 678",
"created_at": "2025-01-25T10:30:00Z"
}Rate Limits
- 100 requests per minute per API key
- Exceeding returns
429 Too Many Requests - Use pagination for large data sets
Webhooks
Coming soon — receive notifications when events occur in Klearcut.
Need Help?
Contact our developer support at api@klearcut.io.