Skip to main content
For developers

API Documentation

Build custom integrations with Gaffer's RESTful API. Sync data, automate workflows, and extend functionality.

quick-start.js
// Example: Create a new job
const response = await fetch('https://api.getgaffer.com/v1/jobs', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Boiler Installation',
    customer_id: 'cust_123',
    scheduled_date: '2024-01-15',
    description: 'Install new combi boiler',
  }),
});

const job = await response.json();
console.log(job.id); // job_abc123

Build anything with our API

Everything you need to integrate Gaffer with your existing systems.

RESTful API

Modern, well-documented REST API with JSON responses. Supports all major HTTP methods.

Webhooks

Real-time event notifications for jobs, invoices, customers, and more. Build reactive integrations.

API Keys

Secure authentication with API keys. Generate, rotate, and revoke keys from your dashboard.

API Endpoints

GET/api/v1/jobs
POST/api/v1/jobs
GET/api/v1/customers
POST/api/v1/invoices
GET/api/v1/quotes
POST/api/v1/webhooks

Need help with your integration?

Our developer support team can help you build custom integrations with Gaffer.

No credit card required