REST API Plugin for RISE CRM

About REST API Plugin for RISE CRM

Connect RISE CRM to anything with a full REST API

This plugin exposes RISE CRM through a complete REST API, giving you a set of commands to control your RISE installation remotely from third-party applications. Instead of being limited to the RISE web interface, your developers can read and write CRM data programmatically - syncing records, triggering actions and pulling information on demand from any external app, automation tool or custom integration you build.

The RISE API operates over HTTPS and uses JSON as its data format. It is a true RESTful service: standard HTTP methods such as GET and POST issue the requests, and HTTP status codes describe the responses, which keeps it predictable for anyone who has worked with a modern API.

Secure, key-based access

Access is controlled with API keys you generate and manage inside RISE, so every integration authenticates cleanly and you stay in control of who can reach your data. Sensitive information is kept out of responses by design - password hashes and other sensitive fields are not exposed in staff or contact results. A typical request and its JSON response looks like this:

Complete documentation included

This is a complete API service for RISE installations, supplied with full online documentation so you can wire up your own third-party connections. Every endpoint group is documented with its available actions and example responses. If you are unsure about your coding skills or are not certain what an API is, you may want to bring in a developer to handle the integration.

Broad coverage across the whole CRM

The plugin is not limited to a handful of endpoints - it covers the day-to-day objects you actually automate. For most entities you get the full set of operations: create, list, search, update and delete, with documented get-by-ID lookups on many of them.

Sales and clients

• Leads, Clients and Contacts (add, delete, list, search, update; get contact by ID)
• Proposals, Estimates and Estimate Requests
• Orders, Contracts and Subscriptions

Projects and work

• Projects, Tasks and Milestones
• Project Comments and Timesheets (log time)
• ToDo items, Events and Announcements

Billing and finance

• Invoices (add, edit, delete, list, search) and Invoice Payments
• Items and Item Categories
• Expenses and Expense Categories
• Taxes and Payment Methods

Support and communication

• Tickets and Ticket Comments
• Messages (including mark as read), Notes and Notifications (including mark as read)

Team and HR

• Users, Attendance and Leave Applications

Configuration and auditing

• Labels, filtered by context, with get-by-ID
• Read-only Activity Logs - list, search and get by ID

Helper lookups

Alongside the main resources, a set of miscellaneous read endpoints returns the reference data you need to build correct requests:

• Client groups and contacts by client ID
• Invoice labels and invoice taxes
• Project labels, project members and staff owner
• Ticket labels and ticket types

Typical use cases

Push new leads from your website or landing pages straight into RISE, keep clients and invoices in sync with an external accounting system, log billable time from a separate app, surface tickets in another helpdesk, or build fully custom dashboards on top of your CRM data. Anything you can do by hand in RISE becomes something you can automate.

Setup and requirements

This module is built for RISE CRM and takes only a few seconds to install, activate and have a fully working API. Because RISE runs on CodeIgniter, some server configurations require /index.php/ to be included in your API endpoint URLs - the documentation covers this. Once activated it works with your existing RISE CRM data immediately.