Skip to main content

Getting Started with Customers REST API

The Customers REST API module provides a powerful and secure REST API specifically designed for customer-facing and third-party integrations with Perfex CRM.

Video Tutorialโ€‹

Watch a quick walkthrough covering login, authentication token generation, and a sample GET request:

Installationโ€‹

  1. Download upload.zip from CodeCanyon.
  2. In Perfex CRM, go to Setup โ†’ Modules.
  3. Upload upload.zip and press Install.
  4. Find the module and press Activate with your license key.

Configurationโ€‹

  1. Navigate to Setup โ†’ Settings โ†’ Customers REST API.
  2. Configure API access permissions and rate limits.
  3. Generate API tokens for your integrations.

Creating an API Tokenโ€‹

  1. Sign in to Perfex CRM as an admin.
  2. Go to API โ†’ API Management and create a new token.
  3. Make sure to copy the token and configure the necessary permissions.

Usageโ€‹

Once installed, the API endpoints are available at your Perfex CRM URL. Refer to the API Reference for a complete list of endpoints, parameters, and response schemas.

Support

Visit the Support Ticketing Area.