REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 1

VERSION 2.1.5 Released ⚡

NEW – Dynamic Custom Table Endpoints for Third-Party Modules
NEW – CRUD Operations for Custom Database Tables
NEW – Column Validation for Custom Tables
NEW – Third-Party Module Integration Support
NEW – Automation Connectors for Zapier, Make.com, and n8n
NEW – Polling Endpoints with timestamp filtering
NEW – Test Endpoints for automation trigger validation
NEW – IP Whitelist and Blacklist Middleware
NEW – Request Size Limit Middleware
NEW – Security Headers Middleware
NEW – Middleware Settings UI
NEW – Events Webhooks System
NEW – Webhook Management UI
NEW – HMAC Signature Verification
NEW – Postman Collection Generator
NEW – API Response Transformers
NEW – Request Logger Middleware
NEW – Response Caching Middleware
NEW – Pagination Feature
NEW – Task Checklists Support
NEW – Task Assignees Support

REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 2

REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 3

Access and manage Perfex CRM data seamlessly with a flexible REST API

Our module allows you to enable REST API functionality at your your Perfex CRM installation. It includes a variety of useful commands in order to control your Perfex installation remotely, build third party connections and access Perfex’s information in real-time!

Seamlessly integrate your CRM with third-party applications, automate processes, and revolutionize your workflow. With our API module, you can harness the true potential of a custom connection without the need for any additional custom work.

Perfex API operates over HTTP/HTTPS. It is a RESTful API which utilizes HTTP methods and HTTP status codes to specify requests and responses. It defines a set of functions which someone can perform requests and receive responses via HTTP protocol (GET / POST / DELETE / UPDATE etc.)

REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 4

Documentation & Commands

Our REST API contains a complete documentation to help you build your own connections, however, if you are not familiar with APIs, its highly advised to consider hiring an expert for having your connections created.

REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 5

Currently Available Endpoints of the API (please check Documentation for complete Request-Response examples):

Customers
- Add New Customer
- Delete a Customer
- List All Contacts of a Customer
- Request Customer Information
- Search Customer Information
- Update a Customer
Contacts
- Add New Contact
- Delete Contact
- Request Contact Information
- Search Contact Information
- Update Contact Information
Invoices
- Add New Invoice
- Delete Invoice
- Request Invoice Information
- Search Invoice Information
- Update an Invoice
Leads
- Add New Lead
- Delete a Lead
- Request Lead Information
- Search Lead Information
- Update a Lead
Milestones
- Add New Milestone
- Delete a Milestone
- Request Milestones Information
- Search Milestones Information
- Update a Milestone
Projects
- Add New Project
- Delete a Project
- Request Project Information
- Search Project Information
- Update a Project
Payment Modes
- Request Payment Modes
Taxes
- List all Taxes
Staff Members
- Add New Staff Member
- Delete a Staff Member
- Request Staff Information
- Search Staff Information
- Update a Staff Member

Custom Fields
- Add New Custom Field
- Delete a Custom Field
- Request Custom Fields
- Request Values of a Custom Field
- Search Custom Field Values’ Information
- Update Custom Fields
Estimates
- Add New Estimate
- Delete an Estimate
- Request Estimate Information
- Search Estimate Information
- Update an estimate
Contracts
- Add New Contract
- Delete a Contract
- Request Contract Information
Expenses
- Add New Expense
- Delete an Expense
- Request Expense Information
- Search Expenses Information
- Update an Expense
Expense Categories
- Request Expense category
Tasks
- Add New Task
- Delete a Task
- Request Task Information
- Search Tasks Information
- Update a Task
Payments
- Add New Payment
- List All Payments
- Search Payments Information
Proposals
- Add New Proposal
- Delete Proposal
- Request Proposal Information
- Search Proposals Information
- Update a Proposal
Timesheets
- Add a New Timesheet
- Delete a Timesheet
- Request a Timesheet Information
- Request Timesheets
- Update a Timesheet
Subscriptions
- Add a New Subscription
- Delete a Subscription
- Request a Subscription Information
- Request Subscriptions
- Update a Subscription
Calendar Events
- Create a new Calendar Event
- Delete a Calendar Event
- Get All Calendar Events
- Request Specific Event Information
- Update a Calendar Event
Tickets
- Add New Ticket
- Delete a Ticket
- Request Ticket Information
- Search Ticket Information
- Update a Ticket
Thirdparty (Custom Modules)
- Get All Records from Custom Table
- Get Record from Custom Table by ID
- Insert Record into Custom Table
- Update Record in Custom Table
- Delete Record from Custom Table
Automation Connectors
- Poll for New Data (Zapier/Make.com/n8n)
- Test Trigger (Zapier/Make.com/n8n)
- List Available Resources

Attachments support
- Leads
- Contracts
- Tasks
- Expenses

Unlimited Integrations

Our REST API module empowers you to:

Automate Workflows: Connect Perfex CRM with other tools, such as accounting software, project management platforms, or email marketing systems. Streamline your operations and eliminate manual data entry by automating data synchronization, creating new leads, updating contact details, and more. Now with native support for Zapier, Make.com, and n8n automation platforms!

Extend Functionality: Enhance the capabilities of your CRM by integrating it with external applications. Leverage additional features, such as geolocation, SMS notifications, payment gateways, or any other service that your business relies on. Our Rest API Module allows you to create a tailored CRM experience that perfectly fits your unique requirements.

Improve Efficiency: Say goodbye to siloed systems and duplicate efforts. Our Rest API Module enables seamless data flow between Perfex CRM and other platforms, ensuring accurate and up-to-date information across all your integrated tools. This integration eliminates data inconsistencies, reduces manual errors, and boosts overall operational efficiency. With webhooks, you can now receive real-time notifications of API events!

Foster Collaboration: Connect Perfex CRM with collaboration tools, such as project management or team communication platforms, to foster better collaboration within your organization. Share CRM data with relevant team members, sync task progress, and maintain a centralized hub for all your business operations.

Drive Business Growth: By leveraging the power of our Rest API Module, you can create a unified ecosystem of applications that work together harmoniously. This integration enables you to make data-driven decisions, deliver exceptional customer experiences, and drive business growth with increased productivity and streamlined processes.

Enterprise Security: Protect your API with advanced security features including IP whitelisting/blacklisting, request size limits, security headers, and comprehensive middleware controls – all configurable through an intuitive admin interface.

Check out below, a sample connection with Zapier, under a contributed video of a customer:

Our API is a complete API service for Perfex CRM installations, with which, you can implement your own third party service connections (Zapier, IFTTT, Make.com, n8n, and every other service out there!).

Possibilities are really unlimited – the only prerequisite is that you are familiar with REST APIs. In case you are unsure about the way your custom connection has to be done, its highly advised to consider hiring an expert for it, as support for this item is limited at its functionality working state and according to CodeCanyon’s support policy.

Custom Modules’ Data Support

If you are searching for an API to handle your custom modules and tables’ data, you can check out our GraphQL API module for Perfex CRM

REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 7

Support

It takes only a few seconds to be installed, activated and have a fully working API for Perfex.

If you have any questions, feel free to raise a support ticket at our support area.
Guys from support department will get back to you as soon as possible with a reply.

REST API module for Perfex CRM - Connect Apps and Automate Workflows with third party applications - 12

Version 2.1.6

-Code Improvements

Version 2.1.5

-Security Enhancements

Version 2.1.4

-Complete CRUD Operations for Items (tblitems)
-GET all tickets endpoint added
-Global Pagination Support for all list endpoints
-Standardized pagination response format (data + meta)
-Pagination parameters: ?page=X&per_page=Y (default: 20, max: 100)
-Applied pagination to: Items, Tickets, Leads, Customers, Invoices, Estimates, Projects, Tasks
-Task Checklist API endpoints (GET, POST, PUT, DELETE)
-Task assignees support for POST and PUT operations
-Fixed Tasks PUT method to handle JSON and form-data requests
-Fixed task update bugs: repeat_every format, attachment deletion, name requirement
-Fixed assignee validation to prevent invalid staff IDs
-Database migration fixes: UTF8MB4 charset, foreign key constraints, NULL handling
-Updated Swagger/OpenAPI documentation with global pagination parameters
-Enhanced API documentation comments in all controllers
-New REST_Controller helper: apply_pagination() method
-Corrected Items controller to use proper tblitems database structure

Version 2.1.3

-Dynamic Custom Table Endpoints: New endpoint /api/thirdparty/customtable/{table_name} for accessing any custom database table created by third-party modules without requiring custom API code
-Get All Records: Retrieve all records from a custom table with GET /api/thirdparty/customtable/{table_name} - returns all columns and values
-Get Record by ID: Retrieve a specific record with GET /api/thirdparty/customtable/{table_name}/{id} - returns complete record data
-Create Record: Insert new records with POST /api/thirdparty/customtable/{table_name} and JSON body containing column values - automatically validates columns exist
-Update Record: Update existing records with PUT /api/thirdparty/customtable/{table_name}/{id} and JSON body with columns to update - validates columns before update
-Delete Record: Remove records with DELETE /api/thirdparty/customtable/{table_name}/{id} - validates record exists before deletion
-Table Validation: Automatic validation that the requested table exists before performing any operations, returns clear error if table not found
-Column Validation: Validates that all provided columns exist in the table before insert/update operations, returning detailed error messages listing invalid columns
-Error Handling: Comprehensive error messages for table not found, column not found, record not found, and other database errors with proper HTTP status codes
-Security: Table name sanitization using regex to prevent SQL injection attacks, parameterized queries for all database operations
-No Prefix Required: Table names are used exactly as provided (no automatic Perfex CRM prefix added) - works with any database table name
-Raw SQL Queries: Uses raw SQL queries to avoid query builder state conflicts, ensuring clean and isolated database operations
-Permissions System: Full integration with API permissions system - grant/revoke get, post, put, delete permissions for thirdparty feature
-API Documentation: Complete @api documentation for all endpoints, visible in apidoc-generated documentation
-Third-Party Module Support: Enables third-party Perfex CRM modules to expose their custom database tables via REST API without writing custom API controllers
-Ticket Reply Endpoint: New endpoint POST /api/tickets/reply/{id} for adding replies to tickets with support for staff and customer replies
-Ticket Reply Features: Support for file attachments, CC email addresses, and optional status updates when replying to tickets
-Fixed Ticket Update Error Message: Corrected error message from "Invalid Lead ID" to "Invalid Ticket ID" in ticket update endpoint

Version 2.1.2

-Automation Connectors: Full integration support for Zapier, Make.com, and n8n automation platforms
-Polling Endpoints: New endpoints with timestamp filtering to retrieve new or updated records for automation platform triggers
-Test Endpoints: Dedicated test endpoints for each resource type to validate automation triggers and show sample data structure
-Manifest Downloads: Standalone manifest generator for all three automation platforms with download links and setup instructions
-IP Whitelist Middleware: Configure allowed IP addresses with CIDR notation support via admin UI to restrict API access
-IP Blacklist Middleware: Block specific IP addresses or ranges through admin settings for enhanced security
-Request Size Limit: Configurable maximum request body size (default 10MB) to prevent abuse and protect server resources
-Security Headers: Enable/disable security headers (X-Frame-Options, CSP, etc.) via settings for improved API security
-Middleware Settings UI: Complete admin interface for configuring all middleware without coding, making API management accessible to non-developers
-JSON Response Normalization: Opt-in feature that wraps responses in industry-standard JSON format with field filtering and privacy protection capabilities
-Postman Collection Generator: Moved to standalone file for improved reliability, removed dropdown interface, and integrated into Automation Connectors page
-Query Parameter Authentication: Enhanced support for authtoken and api_key query parameters for simpler URL-based authentication
-Authorization Header: Enhanced support for Bearer token authentication for better compatibility with standard API clients
-Permission System: Added Zapier permissions (test, poll, resources) to the permission system for granular access control
-UI/UX Enhancements: Consistent button styling, spacing, and card layouts across all admin pages for a more polished interface
-Error Handling: Better error messages and debugging capabilities for polling endpoints to simplify troubleshooting
-Database Queries: Fixed ambiguous column errors in polling queries with proper table prefixes for improved reliability
-Route Optimization: Improved routing for automation endpoints to avoid conflicts and ensure proper endpoint resolution

Version 2.1.1

-Events Webhooks System: Complete event-driven architecture for API lifecycle events with automatic HTTP POST requests to configured URLs
-Webhook Management UI: Full admin interface for creating, editing, and managing webhooks with comprehensive configuration options
-Event Types: Support for authentication, rate limiting, request/response, controller execution, and error events
-HMAC Signatures: SHA256 HMAC signature generation for webhook payload verification to ensure data integrity
-Custom Headers: Support for custom HTTP headers in webhook requests for enhanced integration flexibility
-Retry Logic: Configurable retry attempts for failed webhook deliveries to improve reliability
-Webhook Logs: Complete logging system for webhook delivery attempts and responses with success/failure tracking
-Webhook Testing: Built-in test functionality to verify webhook configurations before going live
-Postman Collection Generator: Automatically generates Postman v2.1 collections from API endpoints with pre-configured authentication and environment variables
-Endpoint Discovery: Programmatically discovers available API endpoints and organizes them by resource type
-Sample Requests: Includes sample request bodies for POST/PUT endpoints to simplify API integration
-API Response Transformers: Global transformer system to apply standardized JSON formatting to all API responses
-Field Filtering: Filter response fields based on query parameters for customized data retrieval
-Privacy Protection: Automatic removal of sensitive fields from responses for enhanced data security
-Pagination Enhancement: Improved pagination metadata for list endpoints for better data navigation
-Request Logger Middleware: Log all API requests for monitoring and debugging purposes
-Response Caching Middleware: Cache GET requests to improve performance and reduce server load
-Backwards Compatibility: All new features are opt-in via admin settings to ensure existing integrations continue working
-Global Application: Middleware and transformers apply to all controllers extending REST_Controller automatically

Version 2.1.0

-API Swagger Playground added
-Reporting Interface added
-User Statistics & API keys-based statistics
-Request Limiting Functionality added
-Quota Limiting Functionality added

Version 2.0.9

-Return of ID in JSON response (in POST add operations)
-Code Improvements

Version 2.0.8

-Added support for Zip code in Leads
-Added support for Add Payments (POST)

Version 2.0.7

-Attachment upload function added for Leads/Contracts/Projects/Tasks/Tickets/Expenses

Version 2.0.6

-Lead controller enhancements

Version 2.0.5

-Added support for Subscriptions

Version 2.0.4

-Added support for Timesheets

Version 2.0.3

-Added support for Calendar Events

Version 2.0.2

-Compatibility fix for PHP8.2.x

Version 2.0.1

-Added permissions feature for API tokens

Version 2.0

-Added support for Contracts
-Ensuring compatibility with PHP 8
-Minimum PHP version required: 7.4
-Documentation updated

Version 1.0.3a

-Small adjustments at API model

Version 1.0.3

-Added support for Estimates
-Added support for Expenses
-Added support for Taxes
-Added support for Payments
-Added support for Payment methods
-Added support for Proposals

Version 1.0.2

-Added support for Custom Fields, for all controllers
-Added extra Custom Fields controller in order to handle available information separately
-Documentation update for Custom Fields
-Fixed minor issue at Contacts controller, causing contacts' data not being fully parsed
-Fixed minor issue at Tasks controller, causing is_public attribute not to be active when requested
-Fixed expiration date not showing at Edit API key screen (admin area)

Version 1.0.1

-Fixed verified bug, causing lastname to be empty during PUT(update) of a staff member

Version 1.0.0

-Support for Invoices (Add,Delete,Request,Search,Update)
-Support for Contacts (Add,Delete,Request,Search,Update)
-New command for Customers (List all contacts of a customer)

Version 0.5

-Ensuring compatibility with latest version of Perfex CRM

Version 0.4

-JWT token enhancements

Version 0.3

-JWT security enhancements

Version 0.2

-Minor bugfixes in Delete Lead command

Version 0.1

-Initial version (1.0x), fully compatible with the latest version of Perfex CRM and PHP 7.2/PHP 7.3