REST API Plugin for RISE CRM - Automate Workflows and connect Third-Party Apps

New Version Released ⚡ — now with AI agents, webhooks & automation

NEW – MCP Server: let AI assistants (Claude, ChatGPT, Cursor, n8n) operate your CRM
NEW – Webhooks with HMAC-signed delivery, retries & delivery logs
NEW – Automation triggers for n8n, Zapier & Make (polling)
NEW – Batch endpoint: many operations in one request
NEW – Reporting endpoints (summary, invoices, projects, timesheets)
NEW – Custom Fields API (definitions + per-record values)
NEW – OpenAPI 3.0 spec, Swagger UI, Postman collection & interactive Playground
NEW – Developer kit: official n8n community node (install from npm / n8n Community Nodes) + a public code-examples repo (cURL, PHP, Python, JavaScript) shipping the Postman collection & the OpenAPI 3.0 spec
NEW – Line items on Invoices, Estimates, Proposals & Orders (create a document WITH its lines, totals auto-calculated)
NEW – Knowledge Base, Checklists & Files APIs
NEW – Estimate/Proposal Comments, Team, Roles, Project Members & Templates
IMPROVED – 322 documented endpoints across 54 groups + brand-new SEO documentation
SECURITY – Closed gateway-credential & staff-PII leaks; API settings locked to admins

Connect RISE CRM to anything — AI assistants, automation platforms & your own apps

This plugin turns your RISE CRM into a fully programmable platform. Read and write your clients, leads, invoices, projects, tasks and 40+ other resources over a clean HTTP/JSON REST API — or let AI assistants and automation tools do it for you.

New in 2.1.0: a built-in MCP server exposes your CRM to Claude, ChatGPT, Cursor and the n8n AI Agent; production-grade webhooks notify your systems the moment something changes; and ready-made polling triggers power n8n, Zapier and Make. The API operates over HTTPS, speaks JSON, and follows standard REST conventions (standard verbs + status codes), so there is nothing unusual to learn.

A REST API defines a set of functions which developers can perform requests and receive responses via HTTP protocol such as GET and POST.
Our item ships with a complete, searchable documentation, an OpenAPI 3.0 specification, a Postman collection, Swagger UI and an interactive Playground. You also get an official n8n community node and a public code-examples repository (cURL, PHP, Python & JavaScript) that bundles the Postman collection and the OpenAPI 3.0 spec, so your team can be up and running in minutes. If you are unsure about your coding skills or you do not understand what exactly an API is, you might need to consider hiring an expert.

Note that due to CI limitations, you might be needed to include /index.php/ in your endpoints.

Documentation & Developer Resources

This is a complete API service for RISE installations, with which, you can implement your own third party service connections. Everything you need to build, test and automate is ready to use:

→ Complete, searchable API documentation (a page per endpoint, with live examples)

→ Code examples, Postman collection & OpenAPI 3.0 spec on GitHub (cURL, PHP, Python & JavaScript – copy, paste, run)

→ Official n8n community node on npm (source on GitHub) – add RISE CRM to your n8n canvas as a first-class node

→ Swagger UI, interactive Playground & a live OpenAPI/Postman export, served straight from your own installation




Keys Management Screenshot:



Sample request/response:





Available actions through API:

MCP — AI Agents (new)
→ Model Context Protocol server (JSON-RPC 2.0) at /api/mcp
→ 200+ permission-filtered tools across 40+ resources
→ Works with Claude Desktop, ChatGPT, Cursor & the n8n AI Agent
→ tools/list, tools/call, resources & prompts
→ Opt-in: disabled by default, enabled from the API settings screen

Webhooks (new)
→ Create, list, update, delete & toggle webhooks
→ Full event catalogue (created / updated / deleted per resource)
→ HMAC-SHA256 signed delivery + per-webhook logs
→ Queued delivery with retries (never blocks your CRM)

⚡ Batch (new)
→ Run many operations in a single request

Automation — n8n / Zapier / Make (new)
→ Discover pollable resources
→ Fetch a sample record for field mapping
→ Poll for anything new or updated since a timestamp
→ Official n8n community node available: n8n-nodes-rise-crm

Reporting (new)
→ Summary counts (clients, leads, projects, tickets, invoices)
→ Invoiced vs paid vs outstanding over a date range
→ Project throughput & logged timesheet hours

⚛ Custom Fields (new)
→ List custom field definitions
→ Read & write custom field values on any record

Developer tooling (new)
→ OpenAPI 3.0 specification (/api/openapi.json) – also shipped as a ready-to-use file in the examples repo
→ Postman collection (/api/postman.json) – plus an importable copy on GitHub
→ Swagger UI (/api/swagger) & interactive Playground (/api/playground)
→ Official n8n community node (n8n-nodes-rise-crm) on npm & GitHub – install from n8n’s Community Nodes
→ Ready-to-run code examples in cURL, PHP, Python & JavaScript on GitHub

Users
→ Add New User
→ Delete a User
→ List all Users information
→ Search Users Information
→ Update a User

Leads
→ Add New Lead
→ Delete a Lead
→ List all leads information
→ Search Leads Information
→ Update a Lead

Clients
→ Add New Client
→ Delete a Client
→ List all Clients information
→ Search Client Information
→ Update a Client

Contacts
→ Add New Contact
→ Delete a Contact
→ List all Client Contacts
→ Get Contact by ID
→ Search Contacts
→ Update a Contact

Projects
→ Add New Project
→ Delete a Project
→ List all Project Information
→ Search Project information
→ Update a Project

Tasks
→ Add New Task
→ Delete a Task
→ List all Tasks information
→ Search Task Information
→ Update a Task

Timesheets
→ Add New Timesheet (log time)
→ Delete a Timesheet
→ List all Timesheets
→ Get Timesheet by ID
→ Search Timesheets
→ Update a Timesheet

Milestones
→ Add New Milestone
→ Delete a Milestone
→ List all Milestones
→ Search Milestones
→ Update a Milestone

Project Comments
→ Add Project Comment
→ Delete a Project Comment
→ List all Project Comments
→ Search Project Comments
→ Update a Project Comment

Invoices
→ Add an Invoice (optionally with its line items)
→ Edit an Invoice (optionally replacing its line items)
→ Delete an Invoice
→ List all Invoice information
→ Search invoice Information

Invoice Payments
→ Add Invoice Payment
→ Delete an Invoice Payment
→ List all Invoice Payments
→ Search Invoice Payments
→ Update an Invoice Payment

Line Items
→ List the lines of an invoice, estimate, proposal, order, contract or subscription
→ Add a line
→ Replace all lines (totals auto-recalculated)
→ Delete a line
→ Or send an items array straight to Invoice / Estimate / Proposal / Order create & update

Subscriptions
→ Add New Subscription
→ Delete a Subscription
→ List all Subscriptions
→ Get Subscription by ID
→ Search Subscriptions
→ Update a Subscription

Taxes
→ Add New Tax
→ Delete a Tax
→ List all Taxes
→ Get Tax by ID
→ Search Taxes
→ Update a Tax

Items
→ Add New Item
→ Delete an Item
→ List all Items
→ Get Item by ID
→ Search Items
→ Update an Item

Item Categories
→ Add New Item Category
→ Delete an Item Category
→ List all Item Categories
→ Get Item Category by ID
→ Search Item Categories
→ Update an Item Category

Expenses
→ Add New Expense
→ Delete an Expense
→ List all Expenses
→ Search Expenses
→ Update an Expense

Expense Categories
→ Add New Expense Category
→ Delete an Expense Category
→ List all Expense Categories
→ Get Expense Category by ID
→ Search Expense Categories
→ Update an Expense Category

Estimates
→ Add New Estimate (optionally with its line items)
→ Delete an Estimate
→ List all Estimates
→ Search Estimates
→ Update an Estimate (optionally replacing its line items)

Estimate Requests
→ Add New Estimate Request
→ Delete an Estimate Request
→ List all Estimate Requests
→ Get Estimate Request by ID
→ Search Estimate Requests
→ Update an Estimate Request

Estimate Comments
→ Add an Estimate Comment
→ Delete an Estimate Comment
→ List all Estimate Comments
→ Search Estimate Comments
→ Update an Estimate Comment

Proposals
→ Add New Proposal (optionally with its line items)
→ Delete a Proposal
→ List all Proposals
→ Search Proposals
→ Update a Proposal (optionally replacing its line items)

Proposal Comments
→ Add a Proposal Comment
→ Delete a Proposal Comment
→ List all Proposal Comments
→ Search Proposal Comments
→ Update a Proposal Comment

Orders
→ Add New Order (optionally with its line items)
→ Delete an Order
→ List all Orders
→ Search Orders
→ Update an Order (optionally replacing its line items)

Contracts
→ Add New Contract
→ Delete a Contract
→ List all Contracts
→ Search Contracts
→ Update a Contract

Tickets
→ Add New Ticket
→ Delete a Ticket
→ List all Tickets information
→ Search Ticket Information
→ Update a Ticket

Ticket Comments
→ Add Ticket Comment
→ Delete a Ticket Comment
→ List all Ticket Comments
→ Search Ticket Comments
→ Update a Ticket Comment

Messages
→ Add New Message
→ Delete a Message
→ List all Messages
→ Search Messages
→ Update a Message (e.g. mark as read)

Notes
→ Add New Note
→ Delete a Note
→ List all Notes
→ Search Notes
→ Update a Note

Events
→ Add New Event
→ Delete an Event
→ List all Events
→ Search Events
→ Update an Event

Announcements
→ Add New Announcement
→ Delete an Announcement
→ List all Announcements
→ Search Announcements
→ Update an Announcement

Leave Applications
→ Add Leave Application
→ Delete a Leave Application
→ List all Leave Applications
→ Search Leave Applications
→ Update a Leave Application

ToDo
→ Add New ToDo Item
→ Delete a ToDo Item
→ List all ToDo Items
→ Search ToDo Items
→ Update a ToDo Item

Attendance
→ Add Attendance Record
→ Delete an Attendance Record
→ List all Attendance Records
→ Search Attendance
→ Update Attendance

Payment Methods
→ Add Payment Method
→ Delete a Payment Method
→ List all Payment Methods
→ Search Payment Methods
→ Update a Payment Method

Labels
→ Add New Label
→ Delete a Label
→ List all Labels (filter by context)
→ Get Label by ID
→ Search Labels
→ Update a Label

Notifications
→ Add Notification
→ Delete a Notification
→ List all Notifications
→ Search Notifications
→ Update a Notification (e.g. mark as read)

Knowledge Base
→ Add, Update, Delete a KB article
→ List & Search articles + mark helpful/unhelpful
→ Full CRUD + search on KB categories

Checklists
→ Add, Update, Delete checklist items on a task
→ List & Search checklist items
→ Manage checklist templates & groups, apply a group to a task

Files
→ List files for a project, client or task
→ Get file metadata & download
→ List folders & file categories, delete a file

Team
→ Add, Update, Delete a team
→ List & Search teams
→ List the members of a team

Project Members
→ Add & remove members on a project
→ List & Search project members

Roles (read-only)
→ List, Get & Search staff roles

Templates (read-only)
→ List & Get email, ticket, contract & proposal templates

Activity Logs
→ List all Activity Logs (read-only)
→ Get Activity Log by ID
→ Search Activity Logs

Miscellaneous
→ List Client Groups
→ List Contact by ClientID
→ List Invoice Labels
→ List Invoice Taxes
→ List Project Labels
→ List Project Members
→ List Staff owner
→ List Ticket Labels
→ List Ticket Types

Support

It takes only a few seconds to be installed, activated and have a fully working API for RISE.

If you have any questions, feel free to raise a support ticket at our support area.
Guys from support department will get back to you as soon as possible with a reply.

Version 2.1.0

-NEW: MCP server (Model Context Protocol) for AI agents at POST /api/mcp - for Claude, ChatGPT, Cursor and the n8n AI Agent. Opt-in, disabled by default. -NEW: Webhooks - REST management, event catalogue, HMAC-SHA256 signed delivery, per-webhook logs, queued/retried delivery -NEW: Automation polling triggers for n8n, Zapier and Make (resources, sample, poll) -NEW: Batch endpoint - run many operations in one request -NEW: Reporting endpoints (summary, invoices, projects, timesheets) -NEW: Custom Fields API (definitions + per-record values) -NEW: OpenAPI 3.0 spec, Postman collection, Swagger UI and interactive Playground -NEW: Line items on Invoices, Estimates, Proposals and Orders - create a document with its lines in one call, totals auto-calculated. Dedicated line-item endpoints for all six sales documents. -NEW: Knowledge Base API (articles + categories) -NEW: Checklists API (items, groups, templates) -NEW: Files API (metadata, folders, categories, download) -NEW: Estimate Comments and Proposal Comments API -NEW: Team, Roles (read-only), Project Members and Templates (read-only) API -NEW: Public code-examples repo (cURL, PHP, Python, JavaScript) with the Postman collection and a downloadable OpenAPI 3.0 spec, and an official n8n community node published on npm (n8n-nodes-rise-crm) -IMPROVED: Brand-new SEO-optimized documentation - 322 endpoints across 54 groups, machine-readable specs, deep-linkable sections -SECURITY: Fixed live leaks of payment gateway credentials and staff PII (ssn/salary) via the REST API -SECURITY: The API management screen is now restricted to administrators -FIX: /api/todos fatal error, invoice creation now validated, plus numerous correctness fixes

Version 2.0.0

-NEW: Items API (full CRUD + search) -NEW: Item Categories API (full CRUD + search) -NEW: Taxes API (full CRUD + search) -NEW: Expense Categories API (full CRUD + search) -NEW: Estimate Requests API (full CRUD + search) -NEW: Subscriptions API (full CRUD + search) -NEW: Timesheets API (full CRUD + search) -NEW: Contacts API (client contacts, full CRUD + search) -NEW: Labels API (full CRUD + search) -NEW: Documented Get-by-ID endpoints for Leads, Invoices, Tickets, Projects -FIX: Corrected API endpoint URLs (missing slash after index.php) -FIX: Normalized endpoint names and corrected response examples across all groups -SECURITY: Password hash no longer exposed in staff_owner / contact_by_clientid responses

Version 1.3.0

-NEW: Users API (full CRUD + search) -NEW: Tasks API (full CRUD + search) -NEW: Expenses API (full CRUD + search) -NEW: Estimates API (full CRUD + search) -NEW: Proposals API (full CRUD + search) -NEW: Orders API (full CRUD + search) -NEW: Contracts API (full CRUD + search) -NEW: Milestones API (full CRUD + search) -NEW: Project Comments API (full CRUD + search) -NEW: Messages API (full CRUD + search) -NEW: Notes API (full CRUD + search) -NEW: Events API (full CRUD + search) -NEW: Announcements API (full CRUD + search) -NEW: Leave Applications API (full CRUD + search) -NEW: ToDo API (full CRUD + search) -NEW: Attendance API (full CRUD + search) -NEW: Payment Methods API (full CRUD + search) -NEW: Invoice Payments API (full CRUD + search) -NEW: Notifications API (full CRUD + search) -NEW: Ticket Comments API (full CRUD + search) -NEW: Activity Logs API (read-only) -NEW: Success response documentation for all API endpoints

Version 1.2.2

-Compatibility fixes for the last version of RISE CRM and PHP8.3.x

Version 1.2.1

-Compatibility fixes for the last version of RISE CRM -Projects Controller improvements -Invoice Controller improvements

Version 1.2.0

-Minor Fixes -Code Improvements -Documentation Updates

Version 1.1.0

-Compatibility fixes for PHP 8.x -Code Improvements

Version 1.0.1c

-Added translate-ready support for all languages

Version 1.0.1b

-Added support for Tickets -Added support for Invoices

Version 1.0.1

-Added support for Leads -Added support for Clients -Added support for Projects -Added support for Misc Actions (check documentation for details)