Complete API Documentation

Everything you need to integrate PerfexCRM with your applications

170+ API Endpoints
100+ Webhook Events
4 Languages

Browse Documentation

Comprehensive guides and references for every feature

Getting Started

  • System Requirements
  • Installation Guide
  • Initial Configuration
  • Creating Your First API Key
  • Testing the API

Authentication

  • API Key Authentication
  • JWT Token Authentication
  • API Key Management
  • Security Best Practices
  • Rate Limiting

API Endpoints

  • Customers API
  • Tickets API
  • Invoices API
  • Leads API
  • Projects API
  • Tasks API
  • Contracts API
  • Staff API
  • Expenses API
  • Estimates API
  • Proposals API
  • Payments API
  • Items API
  • Contacts API
  • Timesheets API
  • Notes API
  • Subscriptions API
  • Credit Notes API
  • Utilities API

Webhooks

  • Setting Up Webhooks
  • Available Events (100+)
  • Webhook Security
  • HMAC Signature Verification
  • Retry Mechanism
  • Testing Webhooks

Integrations

  • n8n Workflows
  • Zapier Integration
  • Make.com Scenarios
  • Pabbly Connect
  • Custom Integrations

Security

  • API Security
  • Rate Limiting
  • IP Whitelisting
  • CORS Configuration
  • Error Handling

Code Examples

Get started quickly with examples in your preferred language

Get All Customers

curl -X GET https://your-crm.com/api/v1/customers \
  -H "X-API-KEY: pk_your_api_key_here" \
  -H "Content-Type: application/json"

Create a Ticket

curl -X POST https://your-crm.com/api/v1/tickets \
  -H "X-API-KEY: pk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "API Test",
    "message": "Test ticket from API",
    "department": 1,
    "priority": 2
  }'

Create Invoice

curl -X POST https://your-crm.com/api/v1/invoices \
  -H "X-API-KEY: pk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "clientid": 1,
    "date": "2026-11-01",
    "duedate": "2026-11-30",
    "currency": 1
  }'
Want to try it out? Get your API key from the Member Portal

Video Tutorials

Watch step-by-step guides to get the most out of the API

5:23

Getting Started

Learn how to install the module and generate your first API key

5 minutes
8:45

Webhooks Setup

Configure webhooks for real-time notifications and event handling

9 minutes
12:30

n8n Integration

Import and customize pre-built workflows for automation

13 minutes
Latest Updates

What's New

Stay up to date with the latest features and improvements

v2.6.0

LatestFebruary 13, 2026
  • Critical auth & routing fixes — fixed JWT authentication responses, resolved server 503 errors, improved route handling
  • Standardized pagination across all 19 controllers (limit alias for per_page)
  • Webhook docs: click-to-expand descriptions and payload fields for 100 events

v2.4.0 – v2.5.9

February 10-12, 2026
  • 5 new resources (Payments, Items, Contacts, Timesheets, Notes) + 15 webhook events
  • Security audit: XSS fixes, SQL performance, compound indexes, N+1 elimination
  • 19 resources, 170+ endpoints, 100+ webhook events, 526 E2E tests

v2.2.1 – v2.3.0

February 2026
  • One-click auto-update with download, verify, backup, install pipeline
  • Auto-update workflow verification and bug fixes
  • Changelog display, file size extraction, version downgrade guard fixes

v2.2.0

February 9, 2026
  • Security hardening and dead code cleanup