Perfex CRM
About
Turn Perfex CRM into an AI-ready workspace. This MCP server exposes your full REST API to Claude, ChatGPT and any AI agent, so leads, invoices and tasks are one prompt away.
Details
- Author
- themesic
- GitHub stars
- 1
- Downloads
- 1,568
- Categories
- Productivity, Developer Tools, API
Jump to
1. Upload the module through Setup > Modules > Upload Module
2. Activate it
3. Open the new MCP settings panel and generate an API key
4. Copy the generated config snippet
5. Paste it into your MCP client's configuration
6. Restart the client and start asking questions
Most installs take under five minutes. Detailed documentation covers every client separately, with copy paste ready configuration for each.
---
🌐English·简体中文·Español·Português (BR)·Italiano·Français·Deutsch·Türkçe·Tiếng Việt·ไทย·العربية
Ready-to-usePostman collection,code snippets(cURL, PHP, Python, JavaScript) and a resourcecataloguefor theREST API module for Perfex CRM— the fastest way toconnect Perfex CRM with AI agents and third-party applications.
ThePerfex CRM REST APIlets you read and write customers, leads, invoices, estimates, projects, tasks and more over a clean HTTP/JSON interface — perfect forCRM integration, automation and custom apps.v3.0adds anMCP server for AI agents, production-gradewebhooks, ready-madeZapier / Make / n8npolling,batchoperations and smarter list endpoints. This repository is the practical companion to theREST API for Perfex CRMmodule byThemesic Interactive: copy-paste examples, an importable Postman collection, and a full endpoint catalogue.
-
🧩Get the module:https://themesic.com/product/rest-api-module-for-perfex-crm-connect-your-perfex-crm-with-third-party-applications/
📖API guide / live docs:https://perfexcrm.themesic.com/apiguide/
🧾OpenAPI 3.0 spec:GET https://yourdomain.com/api/openapi(reference copy)
Everything isopt-inand backwards-compatible: requests without the new parameters return the exact same response as before.
Each snippet language has examples forcustomers, invoices, leadsplus the v3 featureswebhooks, mcp, batch, automation, knowledge_base and notes, and alist_featuresfile showing pagination, field selection and sorting.
Every request to the Perfex CRM REST API is authenticated with theAuthtokenheader. Create a token in your Perfex admin underAPI → API Management(after activating theREST API module), then call the API athttps://yourdomain.com/api/...:
curl -H "authtoken: YOUR_API_TOKEN" https://yourdomain.com/api/customers
That returns the list of customers as JSON. Seedocs/authentication.mdfor header vs. query-parameter auth, andsnippets/for the same call in PHP, Python and JavaScript.
- Open Postman →Import→ drop inpostman/perfex-rest-api.postman_collection.json.
- Import the environmentpostman/perfex-rest-api.postman_environment.json.
- Setbase_urltohttps://yourdomain.com/apiandauthtokento your token.
- Pick any request and hitSend.
Point any MCP client (Claude Desktop, Cursor, ChatGPT, n8n AI Agent) atPOST https://yourdomain.com/api/mcpand send yourauthtokenheader. The server advertises permission-filtered tools for your CRM. Seedocs/mcp.mdandsnippets/curl/mcp.sh.
All CRUD endpoints follow a RESTful convention:GETlist,GET /:idsingle,POSTcreate,PUT /:idupdate,DELETE /:iddelete — under the base pathhttps://yourdomain.com/api.
The exact request fields per resource are documented in the officialAPI guide. The snippets here cover the most common flows.
Every list endpoint accepts optional query parameters. Add them and you get a{ data, meta }envelope; omit them and you get the exact legacy array.
# Page 2, 20 per page, only id + company, newest first, created this year curl -H "authtoken: YOUR_API_TOKEN" \ "https://yourdomain.com/api/customers?page=2&per_page=20&fields=id,company&sort=-datecreated&created_after=2026-01-01"
per_pageis the parameter that sizes a page (1-100, default 25).limitis accepted as an aliasonlywhenpageis sent too, so a bare?limit=5does not paginate - use?page=1&per_page=5.
Seedocs/pagination-filtering.mdandsnippets/curl/list_features.sh.
There are no breaking changes.Every v3 list feature is opt-in:
- Send none of the parameters above and you get the same plain array 2.x returned. The{ data, meta }envelope appearsonlywhen you sendpageorper_page.
- No endpoint was renamed.Customers have always been at/api/customers.
- Unknown fields onPUTare ignored instead of returning an error.
- POSTrequests accept an optionalIdempotency-Keyheader; identical retries replay the stored response rather than creating duplicates.
Two things worth knowing when adopting v3:
- Custom tables moved behind an allowlist in 3.0.2 - seedocs/custom-tables.md.
- New permission rows (Webhooks, Notes, Knowledge Base) must be ticked on existing tokens before those endpoints answer, and before their MCP tools appear intools/list.
The Perfex CRM REST API is commonly used toconnect Perfex CRM with AI agents and third-party applications:
- AI assistants (MCP)— let Claude, ChatGPT or Cursor read and update your CRM through/api/mcp.
- Zapier / Make / n8n— no-code automation via ready-made polling triggers (/api/zapier/*).
- Webhooks— push Perfex events (new invoice, new lead, 124 events) to Slack, Discord or your own backend, signed with HMAC.
- Google Sheets / Power Automate— sync customers, invoices or payments to spreadsheets and dashboards.
- Custom apps & portals— build a mobile app or customer portal on top of your Perfex data.
- Accounting & e-commerce— sync invoices and items with external billing or shop platforms.
All of these are powered by theREST API for Perfex CRMmodule.
Tokens are created and scoped (per-resource permissions) inAPI → API Management. Full details in[docs/authentication.md.
…
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
