SuiteCRM connector icon

SuiteCRM Connector

Build embedded, customer-facing automations that create, update and query SuiteCRM Accounts, Contacts, Leads, Opportunities and Cases from inside your application using reusable Cyclr templates.

01

Faster time to market

Pre-built SuiteCRM steps and templates reduce build time.

02

Reusable orchestration

Create templates once and deploy per customer account.

03

Multi-tenant governance

Console controls templates, credentials and versions per Account.

04

Embedded experience

Deliver customer-facing workflows natively inside your SaaS product.

CONNECTOR OVERVIEW

Overview

Teams can integrate and automate CRM records and workflows between your product and customers’ SuiteCRM instances — Accounts, Contacts, Leads, Opportunities, Cases and custom modules. Use Cyclr to build reusable templates, publish per-customer workflows and run them inside your app with tenant-level configuration and governance. (docs.suitecrm.com)

PRODUCT USE CASES

Top Use Cases for SuiteCRM Integrations

Publish in-app automations that create Leads from web forms, sync Contacts and Accounts, create Opportunities from orders and log Cases or Notes in SuiteCRM per customer account. Cyclr’s templates scale these workflows across many customer instances. (docs.suitecrm.com)

Create Leads from web forms

When a lead submits in your app, create a Lead record in the customer’s SuiteCRM via the Modules API. (docs.suitecrm.com)

Auto-create Accounts and Contacts

On signup, create Account and Contact records in SuiteCRM and map owner and custom fields. (docs.suitecrm.com)

Create Opportunities from orders

On order completion, create an Opportunity and relate it to the customer Account in SuiteCRM. (docs.suitecrm.com)},{

ORCHESTRATION

How SuiteCRM works with Cyclr

Cyclr sits between your SaaS product and SuiteCRM to handle authentication, govern access and orchestrate every API call per customer, at scale.

  1. 1

    Your SaaS product

    Your app requests an action for a specific customer.

  2. 2

    Cyclr orchestration

    Cyclr authenticates, applies policies and routes the request.

  3. 3

    SuiteCRM

    SuiteCRM processes the request and returns a response to your app.

Customer-specific authentication · Governed data movement · Centralized visibility and audit

CONNECTOR COVERAGE

Available connector capabilities

Explore SuiteCRM methods you can orchestrate through Cyclr.

Tasks6

List Updated Task

Action

List tasks modified since last run.

Update Task

Action

Update an existing task.

Create Task

Action

Create a new task.

List Tasks

Action

List all tasks.

List New Tasks

Action

List tasks created since last run.

Get Task

Action

Get task by ID.

Accounts6

Get Account

Action

Get account by ID.

List New Accounts

Action

List accounts created since last run.

List Accounts

Action

List all accounts.

List Updated Accounts

Action

List accounts modified since last run.

Create Account

Action

Create a new account.

Update Account

Action

Update an existing account.

Contacts7

Update Contact

Action

Update an existing contact.

Create Contact

Action

Create a new contact.

Get Contact

Action

Get contact by ID.

Get Contact By Email

Action

Get contact record by email address. (nb. Full email address required, not a partial search.)

List Updated Contacts

Action

List contacts modified since last run.

List Contacts

Action

List all contacts.

List New Contacts

Action

List contacts created since last run.

Cases5

List New Cases

Action

List all cases created since the last cycle.

Create Case

Action

Create a new case.

List Updated Cases

Action

List all cases updated since the last cycle.

Update Case

Action

Update an existing case.

List Cases

Action

List all cases.

Leads7

List Updated Leads

Action

List leads modified since last run.

Update Lead

Action

Update an existing lead.

List Leads

Action

List all leads.

Get Lead

Action

Get lead by ID.

List New Leads

Action

List leads created since last run.

Get Lead By Email

Action

Get lead record by email address. (nb. Full email address required, not a partial search.)

Create Lead

Action

Create a new lead.

Internal24

"List Targets" Fields

Action

All fields for the "List Accounts" method.

"Update Case" Fields

Action

All fields for the "Update Case" method.

"Update Opportunity" Fields

Action

All fields for the "Update Opportunity" method.

"List Tasks" Fields

Action

All fields for the "List Tasks" method.

"Create Targets" Fields

Action

All fields for the "Create Account" method.

"Get Lead" Fields

Action

All fields for the "Get Lead" method.

"Update Task" Fields

Action

All fields for the "Update Task" method.

"Update Account" Fields

Action

All fields for the "Update Account" method.

"Create Lead" Fields

Action

All fields for the "Create Lead" method.

Get Module Fields

Action

Original "Get Module Fields".

"Create Case" Fields

Action

All fields for the "Create Case" method.

"Update Lead" Fields

Action

All fields for the "Update Lead" method.

"Get Account" Fields

Action

All fields for the "Get Account" method.

"Update Targets" Fields

Action

All fields for the "Update Targets" method.

"List Opportunities" Fields

Action

All fields for the "List Opportunities" method.

"List Cases" Fields

Action

All fields for the "List Cases" method.

"Create Account" Fields

Action

All fields for the "Create Account" method.

"List Accounts" Fields

Action

All fields for the "List Accounts" method.

"List Leads" Fields

Action

All fields for the "List Leads" method.

"Get Opportunity" Fields

Action

All fields for the "Get Opportunity" method.

"Create Task" Fields

Action

All fields for the "Create Task" method.

"Create Opportunity" Fields

Action

All fields for the "Create Opportunity" method.

"Get Targets" Fields

Action

All fields for the "Get Account" method.

"Get Task" Fields

Action

All fields for the "Get task" method.

Session2

Login

Action

Logs into SuiteCRM and returns a session id used for subsequent API calls.

Logout

Action

Logs the web user out of SuiteCRM and destroys the session.

Course Delegates4

List Course Delegates

Action

List all course delegates.

Get Course Delegate

Action

Get course delegate by ID.

List New Course Delegates

Action

List all course delegates added since last run.

List Updated Course Delegates

Action

List all course delegates modified since last run.

Targets6

List New Targets

Action

List targets created since last run.

Get Target

Action

Get target by ID.

List Targets

Action

List all targets.

Create Target

Action

Create a new Target.

Update Target

Action

Update an existing target.

List Updated Targets

Action

List targets modified since last run.

Course Sales4

List New Course Sales

Action

List all course sales recorded since last run.

List Course Sales

Action

List all course sales.

Get Course Sale

Action

Get a course sale record by ID.

List Updated Course Sales

Action

List all course sales modified since last run.

Course Attendance Records4

List Course Attendance Records

Action

List all course attendance records.

List Updated Course Attendance Records

Action

List all course attendance records modified since last run.

List New Course Attendance Records

Action

List all course attendance records added since last run.

Get Course Attendance Record

Action

Get course attendance record by ID.

Opportunities6

Get Opportunity

Action

Get opportunity by ID.

List Opportunities

Action

List all opportunities.

List New Opportunities

Action

List opportunities created since last run.

Create Opportunity

Action

Create a new opportunity.

List Updated Opportunities

Action

List opportunities modified since last run.

Update Opportunity

Action

Update an existing opportunity.

TECHNICAL DETAILS

SuiteCRM integration and API details

Review the sourced authentication and API behaviour used when configuring customer-facing SuiteCRM integrations in Cyclr.

API and authentication

API host
https://your-crm.example.com
Authentication
Username and password; OAuth 2.0
Credentials

Domain; Username; Password; Application Name.

Method categories

CRUD module records; module metadata; list/filter queries; token management.

View vendor API documentation →

Pagination and rate limits

Pagination

V8 JSON API uses page[size] and page[number]; legacy v4.1 uses limit/offset query params. Confirm your instance API version. (docs.suitecrm.com)

Rate limits

No vendor-wide rate limit documented; enforce limits via hosting, API gateway or Cyclr Console policies. (docs.suitecrm.com)

IMPLEMENTATION

Authentication at a glance

Cyclr’s SuiteCRM connector installs with domain, username, password and an application name. SuiteCRM v8 supports OAuth 2.0 (client_credentials and password grants). Confirm the Console authentication option you enable. (community.cyclr.com)

Authentication method
Username and password; OAuth 2.0
Credential required

Domain; Username; Password; Application Name.

Before you begin:

Use a dedicated API user to avoid “Invalid Session”; only first two emails returned by API. (community.cyclr.com)

View setup guide

COMMON QUESTIONS

Frequently asked questions

It syncs CRM records: Accounts, Contacts, Leads, Opportunities, Cases and custom modules between your app and customer SuiteCRM instances. The connector uses SuiteCRM’s module endpoints to create, update and query records. (docs.suitecrm.com)

It supports username/password session installs (Cyclr setup) and SuiteCRM v8’s OAuth 2.0 (client_credentials and password grants); choose or confirm the Console option during installation. (community.cyclr.com)

Yes. Cyclr installs connectors per Account and publishes reusable templates that run in each customer account with tenant-level credentials and governance. (community.cyclr.com)

Yes. If your Cyclr Console has MCP Servers enabled you can select connectors and expose approved methods as managed MCP tools under Console governance. (community.cyclr.com)