REST API for Perfex CRM: integrate & automate with REST API Pro
REST API Pro is a native module that turns Perfex CRM into a modern, developer-friendly API platform. It ships 30 resources with full CRUD, scoped and hashed API keys, outgoing webhooks and built-in OpenAPI documentation. It is built for teams who want to connect Perfex cleanly to other systems and automate their workflows.
The API that ships with Perfex is fine for a few basic calls, but it quickly becomes a bottleneck: it covers only a handful of resources, stores keys in plain text, and offers neither webhooks nor documentation. Anyone integrating Perfex seriously runs into those limits fast. That is exactly the gap REST API Pro closes.
What is a REST API for Perfex CRM, and why do I need one?
A REST API is the interface other software uses to talk to your CRM. With it you read and write customers, leads, invoices or tickets programmatically – for example to connect Perfex to an accounting system, a shop, your own app, or automation tools like Zapier and Make. Instead of copying data by hand, the workflows run on their own.
REST API Pro covers practically the whole CRM: customers and contacts, leads (including a convert-to-customer action), invoices, estimates, proposals, credit notes, payments, expenses, projects, tasks with comments and timers, contracts, tickets with replies, staff, subscriptions, timesheets, calendar events, items and various lookup lists. Every endpoint returns a consistent JSON envelope with correct HTTP status codes.
How do I manage Perfex API keys securely?
Securely means keys are stored only as a SHA-256 hash and shown exactly once – never in plain text. A scope matrix lets you grant read or write per resource, or full access. Per key you can also set an expiry date, an IP whitelist (single IPs or CIDR ranges) and a dedicated rate limit.
For stricter requirements, exchange a key for a short-lived JWT via POST /v1/auth/token. The signing secret is random per installation – unlike the stock API, which ships the same hardcoded secret to every customer. Rate limiting comes with X-RateLimit-* headers and clean 429 responses. In practice a request looks like this:
curl https://your-domain.tld/rest_api_pro/api/customers?page=1&per_page=50 \
-H "Authorization: Bearer rap_live_your_key"Perfex stock API vs. REST API Pro
| Feature | Stock API | REST API Pro |
|---|---|---|
| Resources covered | a few | 30 with full CRUD |
| API keys | stored in clear | SHA-256 hash, shown once |
| Permissions | none | scope matrix per resource |
| Rate limiting & IP whitelist | no | yes, per key |
| Outgoing webhooks | no | 57 events, HMAC-signed |
| Documentation | none | OpenAPI 3.1 + playground |
| Query features | minimal | filter, sort, includes, sync |
How do I automate Perfex with webhooks?
With outgoing webhooks, Perfex actively pushes events to other systems the moment they happen. REST API Pro knows 57 CRM events – new, updated or deleted invoice, paid invoice, new lead, converted lead, ticket reply, task status change and many more – and delivers them to any HTTPS endpoint. That connects Perfex to Zapier, Make, Slack or your own middleware without any polling.
Each delivery is HMAC-signed (X-Rap-Signature), retried with exponential backoff and recorded in a delivery log with one-click re-send. An SSRF guard blocks calls to internal addresses, and a test button verifies a webhook instantly.
Do I have to write the Perfex API documentation myself?
No. Every endpoint is documented from a live spec, so it can never go stale. You get copy-paste examples in cURL, PHP, JavaScript and Python, a try-it playground to fire real requests straight from the admin, and a downloadable OpenAPI 3.1 file for Postman, Insomnia, code generators or GPT actions.
Every list endpoint offers powerful queries: pagination (?page=2&per_page=50), filtering (?filter[status]=1), sorting (?sort=-duedate), full-text search, sparse fields, embedded relations (?include=items,payments) and sync windows (?updated_after=2026-01-01). On top of that come utility endpoints like /search (global search), /stats, /batch (up to 25 operations per request) and a request log with an analytics dashboard showing traffic, error rate, latency and top endpoints.
What does REST API Pro cost, and what are the requirements?
REST API Pro starts at €99 (Regular license) for use on a single domain; the Extended license is €299 for the wider domain tier. Every license includes 12 months of updates and 6 months of support, an instant license key and automatic updates right inside the admin. Requirements: Perfex CRM 3.0+, PHP 7.4+ (8.x recommended) and the PHP cURL extension.
Checkout runs securely through Stripe, and every module is scanned server-side for malware before delivery. Coming from the older "REST API for Perfex CRM"? A compatibility mode reproduces its headers and response shapes – migration is just two changes: point the base URL at /rest_api_pro/api and use a key generated here.
Frequently asked questions
Does REST API Pro replace the built-in Perfex API?
Yes. It ships its own endpoints, keys, webhooks and docs and covers far more resources. You can keep the stock API running alongside it, and a compatibility mode also eases migration from the older "REST API for Perfex CRM".
Do I need coding skills?
Not to manage keys, webhooks and logs – that all happens in the admin. The requests themselves target developers or tools like Zapier and Make. The built-in playground and copy-paste samples lower the barrier considerably.
Can I try the API before buying?
Yes. In the live demo you can explore the full admin, and there are public read-only endpoints that return real JSON right in your browser. The demo resets every 30 minutes.
Are the API keys stored securely?
Yes. Keys are stored only as a SHA-256 hash and shown exactly once. On top of that you get per-resource permissions, an IP whitelist, an expiry date and a per-key rate limit.
Does it work with Zapier and Make?
Yes. Outgoing webhooks push 57 CRM events to any HTTPS endpoint, HMAC-signed and with automatic retries. For queries and writes, every resource is available as a REST endpoint.
How do I get updates and support?
Every license includes 12 months of updates and 6 months of support. Updates install via your license key directly in the admin. You will find the details in the help center.
Get started
If you want to integrate and automate Perfex properly, there is no way around a real REST API. Take a look at REST API Pro on the product page, test the endpoints in the live demo, and browse the full module catalog if you like. After purchasing from the product page you get your license key instantly and can start right away.