REST API Pro

REST API Pro — your whole CRM, one clean API

REST API Pro turns Perfex CRM into a modern, developer-friendly API platform. 30 resources with full CRUD, scoped & hashed API keys, JWT, rate limiting, a searchable request log with analytics, outgoing webhooks, a machine-readable OpenAPI 3.1 spec and a built-in interactive documentation with a try-it playground — everything the stock API never had, in one native, beautifully designed module.

▶ See it live & try the API yourself

Explore the full admin in the public demo (login demo / demo123):

• Live demo — API dashboard, keys, webhooks, logs & docs
• Live interactive documentation with try-it playground

Or call the live API right now in your browser (read-only demo key, real JSON output):

• GET /v1/ping — health check (no key needed)
• GET /customers — list customers
• GET /invoices — list invoices
• GET /leads/search/Skyline — search leads

See how it works (guided walkthrough)

What the API can do — 30 resources, full CRUD

Every endpoint returns a consistent JSON envelope with correct HTTP status codes. Resources with full create / read / update / delete:

• Customers (incl. billing & shipping, groups) and Contacts
• Leads (status, source, value, tags) — plus a convert-to-customer action
• Invoices — create with a simple items[] array; totals, tax and the invoice number are derived automatically. Includes child collections /items and /payments
• Estimates (with convert-to-invoice), Proposals, Credit notes
• Payments — full CRUD (the stock API only offered create)
• Expenses (billable, recurring), Projects (members, milestones, tasks, discussions)
• Tasks — plus comments and timers (start / stop)
• Milestones, Contracts, Tickets (with replies)
• Staff, Subscriptions, Timesheets, Calendar events
• Items — full CRUD (read-only in the stock API), Item groups
• Taxes, Currencies, Payment modes, Expense categories, Departments
• Notes, Knowledge base, Announcements, Activity log, and lookups (lead sources / statuses, contract types, tags)

Action endpoints: download invoice / estimate / proposal / credit-note PDF, send a document by email, convert estimate→invoice and lead→customer, add task comments, start/stop task timers, add ticket replies, and upload / download attachments (base64 JSON — works even where multipart is blocked).

Utility endpoints: /ping (health), /me (key introspection), /search?q= (global search across 12 resources), /stats (CRM KPIs), /batch (up to 25 operations in one request) and /openapi.json (the full spec).

Powerful queries on every list endpoint

No more "load all rows". Every list endpoint supports:

• Pagination: ?page=2&per_page=50 (clean meta block with totals)
• Filtering: ?filter[status]=1&filter[clientid]=7 (comma-separated values become an IN())
• Sorting: ?sort=-duedate
• Full-text search: ?search=acme
• Sparse fields: ?fields=company,city
• Embed relations: ?include=items,payments
• Sync windows: ?updated_after=2026-01-01

Security done right

• Hashed keys: API keys are stored only as a SHA-256 hash and shown exactly once — never in plain text (the stock API stores and displays them in clear).
• Scope matrix: grant read / write per resource, or full access.
• Per-key controls: expiry date, IP whitelist (single IPs or CIDR ranges) and a per-key rate limit.
• Per-installation JWT secret: exchange a key for a short-lived JWT via POST /v1/auth/token; the signing secret is random per install (the stock API ships one hardcoded secret for every customer).
• Rate limiting with X-RateLimit-* headers and clean 429 responses.

Built-in documentation & playground

Every endpoint is documented from a live spec — it can never go stale. Copy-paste examples in cURL, PHP, JavaScript and Python, a try-it playground to fire real requests from the admin, and a downloadable OpenAPI 3.1 file you can import into Postman, Insomnia, code generators or GPT actions.

Outgoing webhooks (Zapier & Make ready)

Push 57 CRM events — new/updated/deleted invoice, paid invoice, new lead, converted lead, ticket reply, task status change and many more — to any HTTPS endpoint. Each delivery is HMAC-signed (X-Rap-Signature), retried with exponential backoff, recorded in a delivery log with a one-click re-send, and protected by an SSRF guard. A test button lets you verify a webhook instantly.

Request log & analytics

Every call is logged with method, path, status, latency, IP and (optionally) a secret-masked payload excerpt. The dashboard shows a traffic chart, error rate, average latency, top endpoints and top keys. Log retention is configurable and cleaned up automatically.

Settings, health check & responsive design

A built-in health check verifies your license, cURL, cron and CSRF configuration and gives you the exact one-line fix when needed. The whole admin is fully responsive and matches the native Perfex look.

Migrating from another Perfex API?

REST API Pro ships a compatibility mode that reproduces the request conventions and response shapes of the older "REST API for Perfex CRM" (legacy authtoken / X-API-KEY headers, raw-array GET responses, {status, message} writes). Migration is just two changes: point the base URL at /rest_api_pro/api and use a key generated here.

Highlights

• 30 resources, full CRUD, consistent JSON envelope & correct status codes
• Hashed & scoped API keys, JWT, per-key rate limits, IP whitelist, expiry
• Pagination, filtering, sorting, sparse fields, includes, sync windows
• 57-event outgoing webhooks (HMAC, retries, delivery log, SSRF guard)
• Request log + analytics dashboard
• OpenAPI 3.1 + built-in interactive docs & playground
• Batch, global search, stats, PDF / send / convert / timer / attachment actions
• Reference compatibility mode, CSRF-safe writes (POST & PUT)
• Full English & German admin, native Perfex design, fully responsive

Requirements

Perfex CRM 3.0+, PHP 7.4+ (8.x recommended), PHP cURL extension.

Support & roadmap

Found a bug or have a feature idea for REST API Pro? Use our public bug tracker — report issues (screenshots welcome), vote on features and follow the roadmap:

• Public bug tracker & roadmap
• Report a bug

Copyright © Sven Gauditz - PixAgentur.com — All rights reserved.