Perfex CRM API Documentation

Complete guide to using the Perfex CRM REST API

Quick Navigation

Authentication
API Endpoints
Examples
API Playground

Authentication

The Perfex CRM API uses JWT (JSON Web Token) authentication. You need to include your API key in the Authorization header of each request.

Getting Your API Key
  1. Log in to your Perfex CRM admin panel
  2. Go to API → API Keys
  3. Create a new API key or use an existing one
  4. Copy the API key for use in your requests
Using Your API Key

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY_HERE
Example Request
curl -X GET "https://yourdomain.com/api/clients" \ -H "Authorization: Bearer YOUR_API_KEY_HERE" \ -H "Content-Type: application/json"

API Endpoints

All API endpoints follow the pattern: https://yourdomain.com/api/{resource}

Available Resources
GET /api/clients

Retrieve all clients

POST /api/clients

Create a new client

GET /api/projects

Retrieve all projects

POST /api/projects

Create a new project

GET /api/leads

Retrieve all leads

POST /api/leads

Create a new lead

GET /api/tickets

Retrieve all tickets

POST /api/tickets

Create a new ticket

Response Format

All API responses are returned in JSON format with the following structure:

{ "status": true, "message": "Success", "data": { // Response data here } }

Examples

Create a New Lead
curl -X POST "https://yourdomain.com/api/leads" \ -H "Authorization: Bearer YOUR_API_KEY_HERE" \ -H "Content-Type: application/json" \ -d '{ "name": "John Doe", "email": "john@example.com", "phone": "+1234567890", "company": "Example Corp", "source": "Website", "status": "New" }'
Get All Clients
curl -X GET "https://yourdomain.com/api/clients" \ -H "Authorization: Bearer YOUR_API_KEY_HERE" \ -H "Content-Type: application/json"
Create a New Ticket
curl -X POST "https://yourdomain.com/api/tickets" \ -H "Authorization: Bearer YOUR_API_KEY_HERE" \ -H "Content-Type: application/json" \ -d '{ "subject": "API Test Ticket", "message": "This is a test ticket created via API", "department": "Support", "priority": "Medium", "status": "Open" }'

API Playground

Test the API directly in your browser using our interactive playground:

Open API Playground View Swagger UI

View Full API Documentation