Perfex CRM REST API — Examples, Postman Collection & Code Snippets
🌐 English · 简体中文 · Español · Português (BR) · · · · · · ·
Power your agent
URL ของผู้เผยแพร่เอง ไม่ใช่เอนด์พอยต์ของ PlugMCP
Host a copy with our keys and logs.
https://{perfex_host}/api/mcpปุ่ม Claude ด้านบนจะเปิด Claude พร้อมกรอกชื่อและ URL ให้แล้ว คุณยังต้องยืนยันที่นั่นเอง
claude mcp add --transport http com.themesic-perfex-crm https://{perfex_host}/api/mcpRun in a terminal.
{ "mcpServers": { "com.themesic-perfex-crm": { "command": "npx", "args": [ "-y", "mcp-remote", "https://{perfex_host}/api/mcp" ] } }}claude_desktop_config.json
URL แบบรีโมตหรือคำสั่งบนเครื่องของคุณ? การติดตั้งสองแบบต่างกันอย่างไร
รันบน PlugMCP
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
เปิดจากผู้เผยแพร่
🌐 English · 简体中文 · Español · Português (BR) · · · · · · ·
Read and write a self-hosted Perfex CRM from an AI agent: 148 permission-filtered tools.
Ready-to-use Postman collection, code snippets (cURL, PHP, Python, JavaScript) and a resource catalogue for the REST API module for Perfex CRM — the fastest way to connect Perfex CRM with AI agents and third-party applications.
The Perfex CRM REST API lets you read and write customers, leads, invoices, estimates, projects, tasks and more over a clean HTTP/JSON interface — perfect for CRM integration, automation and custom apps. v3.0 adds an MCP server for AI agents, production-grade webhooks, ready-made Zapier / Make / n8n polling, batch operations and smarter list endpoints. This repository is the practical companion to the REST API for Perfex CRM module by Themesic 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 is opt-in and backwards-compatible: requests without the new parameters return the exact same response as before.
Each snippet language has examples for customers, invoices, leads plus the v3 features webhooks, mcp, batch, automation, knowledge_base and notes, and a list_features file showing pagination, field selection and sorting.
Every request to the Perfex CRM REST API is authenticated with the Authtoken header. Create a token
in your Perfex admin under API → API Management (after activating the
REST API module),
then call the API at https://yourdomain.com/api/...:
curl -H "authtoken: YOUR_API_TOKEN" https://yourdomain.com/api/customers
That returns the list of customers as JSON. See docs/authentication.md for
header vs. query-parameter auth, and snippets/ for the same call in PHP, Python and JavaScript.
postman/perfex-rest-api.postman_collection.json.postman/perfex-rest-api.postman_environment.json.base_url to https://yourdomain.com/api and authtoken to your token.Point any MCP client (Claude Desktop, Cursor, ChatGPT, n8n AI Agent) at POST https://yourdomain.com/api/mcp
and send your authtoken header. The server advertises permission-filtered tools for your CRM. See
docs/mcp.md and snippets/curl/mcp.sh.
Connect any assistant with one URL, https://perfex-mcp.themesic.com/mcp. Step-by-step setup for Claude, ChatGPT,
Cursor and VS Code: docs/connect-ai-assistants.md.
A Claude plugin (connector + skills) for claude.ai, Cowork and Claude Code lives in
claude-plugin/. It requires the REST API module with a valid license and the MCP
server enabled. See claude-plugin/README.md for setup, permissions and the
privacy policy.
All CRUD endpoints follow a RESTful convention: GET list, GET /:id single, POST create,
PUT /:id update, DELETE /:id delete — under the base path https://yourdomain.com/api.
The exact request fields per resource are documented in the official API 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 alias only whenpageis sent too, so a bare?limit=5does not paginate - use?page=1&per_page=5.
There are no breaking changes. Every v3 list feature is opt-in:
{ data, meta } envelope appears only when you send page or per_page./api/customers.PUT are ignored instead of returning an error.POST requests accept an optional Idempotency-Key header; identical retries replay the stored
response rather than creating duplicates.Two things worth knowing when adopting v3:
docs/custom-tables.md.tools/list.The Perfex CRM REST API is commonly used to connect Perfex CRM with AI agents and third-party applications:
/api/mcp./api/zapier/*).All of these are powered by the REST API for Perfex CRM module.
Tokens are created and scoped (per-resource permissions) in API → API Management. Full details in
docs/authentication.md.
Does Perfex CRM have a REST API? Yes. The REST API for Perfex CRM module adds a full RESTful HTTP/JSON API for customers, leads, invoices, estimates, projects, tasks and more, plus a v3 MCP server, webhooks, batch and automation endpoints.
Can I use Perfex CRM with AI agents / ChatGPT / Claude?
Yes — v3 ships an MCP server at POST /api/mcp that exposes permission-filtered CRM tools to any
Model Context Protocol client. See docs/mcp.md.
How do I authenticate with the Perfex CRM API?
Send your token in the Authtoken HTTP header (or as an ?authtoken= query parameter). See
docs/authentication.md.
What is the base URL of the Perfex CRM API?
https://yourdomain.com/api — for example https://yourdomain.com/api/customers.
Can I connect Perfex CRM to Zapier, Make or n8n?
Yes — v3 has ready-made polling triggers under /api/zapier/*, plus webhooks. See
Popular integrations and docs/automation.md.
Is there a Postman collection for Perfex CRM?
Yes — import postman/perfex-rest-api.postman_collection.json
and the bundled environment, set your base_url and authtoken, and start sending requests.
How do I create an invoice via the Perfex CRM API?
POST https://yourdomain.com/api/invoices with the invoice fields and an items[] array — v3 auto-calculates
subtotal/total. See snippets/curl/invoices.sh.
This repository is an examples companion to the commercial module:
REST API for Perfex CRM — connect your Perfex CRM with third-party applications by Themesic Interactive.
Contributions of additional examples are welcome — see CONTRIBUTING.md.
Example code in this repository is released under the MIT License. "Perfex" is a trademark of its respective owner; the REST API module is a commercial product by Themesic Interactive.
Read and write a self-hosted Perfex CRM from an AI agent: 148 permission-filtered tools.
{ "mcpServers": { "com.themesic-perfex-crm": { "url": "https://{perfex_host}/api/mcp", "headers": {} } }}เครื่องมือ
ยังไม่มีรายการเครื่องมือ เซิร์ฟเวอร์แบบรีโมตจะได้รายการหลังการตรวจสอบสถานะครั้งแรก
FAQ
คัดลอกคอนฟิก http สำหรับ Cursor, Claude Desktop, Claude Code หรือ VS Code ได้ในหน้านี้ คอนฟิกนี้ใช้การติดตั้งของผู้เผยแพร่ ไม่ใช่พร็อกซีของ PlugMCP
ระเบียนนี้ไม่ได้ระบุตัวแปรสภาพแวดล้อมที่จำเป็น
Perfex CRM เข้าถึงได้ผ่าน HTTP
ตรวจสอบล่าสุดเมื่อ 2026-11-08 Read and write a self-hosted Perfex CRM from an AI agent: 148 permission-filtered tools.