REST API for Perfex CRM


Note: This is a module for Perfex CRM.

Brief description

This module enables you to use REST API through your Perfex CRM.
It includes a variety of useful commands in order to control your Perfex installation remotely, through third party applications.

The Perfex API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses.

A REST API defines a set of functions which developers can perform requests and receive responses via HTTP protocol such as GET and POST. This is exactly what you will get from our product. Nothing less, nothing more.
If you are unsure about your coding skills or you do not understand what exactly an API is, feel free to raise a comment with your specific question.

Documentation & Commands

This is a complete API service for Perfex installations, with which, you can implement your own third party service connections.

REST API for Perfex CRM - 1

Keys Management Screenshot:

REST API for Perfex CRM - 2

Sample request/response:
REST API for Perfex CRM - 3

Available actions through API:

? Add New Customer
? Delete a Customer
? List all Contacts of a Customer
? Request customer information
? Search Customer Information
? Update a Customer

? Add New Contact
? Delete Contact
? Request Contact Information
? Search Contact Information
? Update Contact Information

? Add New invoice
? Delete invoice
? Request invoice information
? Search invoice information
? Update invoice

? Add New Lead
? Delete a Lead
? Request lead information
? Search Lead Information
? Update a lead

? Add New Milestone
? Delete a Milestone
? Request Milestones information
? Search Milestones Information
? Update a Milestone

? Add New Project
? Delete a Project
? Request project information
? Search Project Information
? Update a project

? Add New Staff
? Delete a Staff
? Request Staff information
? Search Staff Information
? Update a Staff

? Add New Task
? Delete a Task
? Request Task information
? Search Tasks Information
? Update a task

? Add New Ticket
? Delete a Ticket
? Request Ticket information
? Search Ticket Information
? Update a ticket

REST API for Perfex CRM - 4

REST API for Perfex CRM - 5


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 for Perfex CRM - 6REST API for Perfex CRM - 7

REST API for Perfex CRM - 8

REST API for Perfex CRM - 9

Version 1.0.0a

-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

Vendor Information

  • Store Name: themesic
  • Vendor: themesic
  • No ratings found yet!