Customers REST API

About Customers REST API

The Customers REST API for Perfex CRM opens the Customers Area up to the outside world. It exposes your client-facing data through a clean set of REST endpoints, so a mobile app, a custom customer portal, an internal tool, or practically any third-party application can authenticate a client and work with their projects, invoices, estimates, proposals, contracts, tickets and knowledge base on their behalf. This is a module for Perfex CRM that plugs straight into your existing installation.

Connect the Customers Area to every third-party application

Most of the data your clients care about already lives in Perfex - until now they had to log in to the Customers Area to reach it. This module removes that constraint and turns the Customers Area into something you can drive programmatically. Authenticate a customer once with a token, then read and act on their records from anywhere: surface live invoices inside a native app, stand up a branded self-service portal, push project updates into a tool your clients already use, or feed customer data into your own automations.

Everything runs through key endpoints and functions that map directly onto the day-to-day client lifecycle, so integrating Perfex with another system stops being a custom job and becomes a matter of calling the API.

A complete set of customer endpoints

The module covers the full range of customer interactions, from authentication through every major record type.

Authentication

• Customer log in using a token
• Customer registration

Projects

• Get a customer’s projects list and fetch the details of a specific project
• Read a project’s discussions and the details of a specific discussion
• Pull the data behind a specific project tab
• Add a project’s task and update an existing task

Invoices

• Get all invoices belonging to the client
• Open a specific invoice’s details

Estimates

• Get all of the client’s estimates
• Open a specific estimate’s details

Proposals

• Get all of the client’s proposals
• Open a specific proposal’s details
• Add a comment to a specific proposal

Contracts

• Get all of the client’s contracts
• Open a specific contract’s details
• Add a comment to a specific contract

Tickets

• Get all of the client’s tickets
• Open a specific ticket’s details

Knowledge base

• Get all knowledge base groups
• Get the articles list for a knowledge base group
• Get a specific article together with its related articles

Expanded actions in the latest version

Recent development pushes the API well beyond simple reads, adding write actions and the supporting pieces larger integrations need:

• Customer profile management endpoints
• Ticket creation and replies through the API
• Estimate and proposal accept and decline actions
• Credit notes endpoints
• A dedicated payments endpoint
• File and attachment endpoints
• Pagination support for working through large result sets

Automate the workflow, drop the manual data entry

Manual data entry and tedious administrative tasks are exactly the kind of friction this API removes. Instead of switching between systems and re-keying records, you let information and actions flow between Perfex and the applications you already use. The result is a smooth, efficient workflow that frees your team to focus on what matters most - nurturing customer relationships and driving business growth.

Installation

Installation takes only a few seconds. Go to Perfex CRM Settings -> Modules -> Upload, upload the module’s zip file, and activate it on the next step. You will have a fully working Customers API for Perfex ready to call.