Skip to main content

GraphQL API for Perfex CRM

A flexible GraphQL API that enables seamless third-party connections within Perfex CRM. Interact with both native tables and custom modules.

Overviewโ€‹

The GraphQL API module exposes a powerful and flexible API endpoint for your Perfex CRM installation. Unlike traditional REST APIs where you need multiple endpoints for different resources, GraphQL allows you to query exactly the data you need in a single request. The module automatically generates a schema based on your Perfex CRM database โ€” including native tables and any custom modules you have installed.

Key Capabilitiesโ€‹

CapabilityDescription
QueriesRead data from any CRM table โ€” clients, invoices, leads, tasks, and more
MutationsCreate, update, and delete records through the API
Auto-Generated SchemaThe schema is automatically built from your Perfex CRM database structure
Custom ModulesInteract with data from third-party modules installed on your CRM
Single EndpointAll operations go through one endpoint โ€” no need to manage multiple API routes
info

Your GraphQL endpoint will be available at https://yourdomain.com/graphql immediately after activation. The schema is automatically generated from your Perfex CRM installation.

Requirementsโ€‹

Before installing the module, ensure you have:

  • An active Perfex CRM installation
  • PHP 7.4 or higher on your server
  • The cURL and JSON PHP extensions enabled
  • A valid License Key for the module

Installation & Activationโ€‹

Follow these steps to install and activate the GraphQL API module:

  1. Extract your download and locate upload.zip.
  2. In Perfex CRM, go to Setup โ†’ Modules.
  3. Upload upload.zip and press Install.
  4. Click Activate and enter your License Key.
tip

After activation, you can immediately test your endpoint by visiting https://yourdomain.com/graphql in your browser or sending a request using a tool like Postman or GraphQL Playground.

After Installationโ€‹

Once the module is activated, the GraphQL endpoint is live and ready to accept requests:

  1. Locate your endpoint โ€” The API is available at https://yourdomain.com/graphql.
  2. Authenticate your requests โ€” See the Authentication guide for details on obtaining and using API tokens.
  3. Explore the schema โ€” Use GraphQL introspection to discover all available queries and mutations.
  4. Start querying โ€” See the Data Operations guide for query and mutation examples.
warning

The GraphQL endpoint is publicly accessible by URL, but all requests require proper authentication. Make sure to configure your API tokens and keep them secure.

What's Next?โ€‹

Explore the following guides to get the most out of the GraphQL API module:

  • Authentication โ€” Learn how to authenticate API requests with tokens
  • Why GraphQL โ€” Understand the benefits of GraphQL over traditional REST APIs
  • Key Benefits โ€” Discover the advantages of using this module
  • Data Operations โ€” View examples of queries and mutations

Supportโ€‹

If you encounter any issues during installation or need help with the API, visit the Themesic Support Portal to open a support ticket.