PHPackages                             portospire/suitecrmclient - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. portospire/suitecrmclient

ActiveLibrary[API Development](/categories/api)

portospire/suitecrmclient
=========================

A free client library for use with SuiteCRM to abstract the various API usage to enable easier integrations. Provided by PortoSpire

0.1.6.1(4mo ago)2182LGPL-3.0-or-laterPHPPHP ^8.0 || ^8.1 || ^8.2 || ^8.3CI passing

Since Oct 15Pushed 4mo ago1 watchersCompare

[ Source](https://github.com/PortoSpire/suiteCRMClient)[ Packagist](https://packagist.org/packages/portospire/suitecrmclient)[ Docs](https://portospire.github.io/suiteCRMClient/)[ Fund](https://www.paypal.me/portospire)[ GitHub Sponsors](https://github.com/PortoSpire)[ RSS](/packages/portospire-suitecrmclient/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (21)Used By (0)

[![SuiteCRM API Client](https://camo.githubusercontent.com/9e81f4ea5a461aa8286d5e3938e7b47cdcf2a04b62c0b4994ac96bbf57ee7eb0/68747470733a2f2f6173736574732e706f72746f73706972652e636f6d2f6769746875622e696f2f737569746563726d636c69656e742e706e67)](https://camo.githubusercontent.com/9e81f4ea5a461aa8286d5e3938e7b47cdcf2a04b62c0b4994ac96bbf57ee7eb0/68747470733a2f2f6173736574732e706f72746f73706972652e636f6d2f6769746875622e696f2f737569746563726d636c69656e742e706e67)

[![Version](https://camo.githubusercontent.com/215fed00bbe99af9417b5ed2327526418f0aadff6decfcb77ba7e45bbe2f375b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f506f72746f53706972652f737569746543524d436c69656e74)](https://camo.githubusercontent.com/215fed00bbe99af9417b5ed2327526418f0aadff6decfcb77ba7e45bbe2f375b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f506f72746f53706972652f737569746543524d436c69656e74)[![Size](https://camo.githubusercontent.com/58394c58e48f35ac5cf00e30db464988b40c6f6dca0ca7c263a5f9fe98899eb0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f506f72746f53706972652f737569746543524d436c69656e74)](https://camo.githubusercontent.com/58394c58e48f35ac5cf00e30db464988b40c6f6dca0ca7c263a5f9fe98899eb0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f506f72746f53706972652f737569746543524d436c69656e74)[![License](https://camo.githubusercontent.com/18459595d10604fe36a83ccc03d154b7b2cb169e006ae04cf941704ae0d7c6f6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f506f72746f53706972652f737569746543524d436c69656e74)](https://camo.githubusercontent.com/18459595d10604fe36a83ccc03d154b7b2cb169e006ae04cf941704ae0d7c6f6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f506f72746f53706972652f737569746543524d436c69656e74)

Client library for use with SuiteCRM
====================================

[](#client-library-for-use-with-suitecrm)

A free (LGPL3) client library for use with SuiteCRM to abstract various API usage to enable easier integrations.

[Provided by PortoSpire
![PortoSpire - be seen](https://camo.githubusercontent.com/2d84e533f84d0d457c88aeb7e2e7630e496056936c790148029ea66de8adc754/68747470733a2f2f6173736574732e706f72746f73706972652e636f6d2f7073662f696d672f706f72746f7370697265253230686561646572253230676c6f772e737667)](https://www.portospire.com)

---

Table of Contents
-----------------

[](#table-of-contents)

**[1. Introduction](#introduction)**
**[2. Setup](#setup)**
**[3. Usage](#usage)**
*[3.1. Mezzio](#mezzio)*
*[3.2. Laminas MVC](#laminasmvc)*
*[3.3. Standalone](#standalone)*

---

[Introduction](#introduction)
-----------------------------

[](#introduction)

This package provides a SuiteCRM client to abstract API calls and form submissions to provide and receive data from SuiteCRM instances. It makes use of Person Form campaigns and both the V8 and rest APIs as needed.

[Setup](#setup)
---------------

[](#setup)

Add to your project's composer.json

```
composer require portospire/suitecrmclient
```

[Usage](#usage)
---------------

[](#usage)

This package is built to support Laminas Mezzio and Laminas MVC as well as be available as a stand alone library.

An example to get a list of Web campaigns from a SuiteCRM instance:

```
$SuiteCRMClient->setServerDomain($server_domain);
$SuiteCRMClient->setClientId($client_id);
$SuiteCRMClient->setClientSecret($client_secret);
$filter = new \PortoSpire\SuiteCRMClient\Model\Filter(['campaign_type' => 'Web']);
$json = $SuiteCRMClient->getCampaigns([], ['size' => 20, 'number' => 1], 'name', $filter); // this will contain json of the results
$campaignsFull = $SuiteCRMClient->convertJsonToGenerics($json); // this converts the json to PHP objects
```

An example to submit a lead into a web-to-lead form in a SuiteCRM instance: (You can extend the provided models (Model/WebToLead, etc) if you have custom fields)

```
$values = (array) $WebToLead; // expects an array of key=>value pairs where the keys match the different fields from the web-to-lead form
$SuiteCRMClient->setServerDomain($server_domain);
$SuiteCRMClient->setClientId($client_id);
$SuiteCRMClient->setClientSecret($client_secret);
$SuiteCRMClient->submitWebToLead($values, $campaign_id); // this must match the campaign id that the web-to-lead form is associated to in SuiteCRM
```

### [Mezzio](#mezzio)

[](#mezzio)

Add the ConfigProvider class to the config aggregator (typically found in config/config.php)

```
$aggregator = new ConfigAggregator([
...
\PortoSpire\SuiteCRMClient\ConfigProvider::class,
...
```

Then use the client in your handlers/middleware as needed for your use cases.

### [Laminas MVC](#laminasmvc)

[](#laminas-mvc)

There should be no additional steps beyond adding to your project's composer.json required to begin using the library with Laminas MVC.

### [Standalone](#standalone)

[](#standalone)

There should be no additional steps beyond adding to your project's composer.json required to begin using the library.

###  Health Score

46

—

FairBetter than 93% of packages

Maintenance77

Regular maintenance activity

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~126 days

Recently: every ~0 days

Total

19

Last Release

123d ago

PHP version history (4 changes)0.0.1PHP ^7.0

0.1.3.1PHP ^7.0 || ^8.0 || ^8.1 || ^8.2

0.1.3.6PHP ^7.0 || ^8.0 || ^8.1 || ^8.2 || ^8.3

0.1.5.1PHP ^8.0 || ^8.1 || ^8.2 || ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/1135a74687b9fd33d2435085b2e412b9645bfb1385994fc0a482c9e70c79278d?d=identicon)[portospire](/maintainers/portospire)

---

Top Contributors

[![criterion9](https://avatars.githubusercontent.com/u/23464351?v=4)](https://github.com/criterion9 "criterion9 (66 commits)")

---

Tags

laminaslaminas-mezziolaminas-mvcphpphp-librarysuitecrmsuitecrm-apizend-expressivezend-framework3SuiteCRMportospireSuiteCRM api v8SuiteCRM rest apiSuiteCRM person formSuiteCRM web to lead form

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/portospire-suitecrmclient/health.svg)

```
[![Health](https://phpackages.com/badges/portospire-suitecrmclient/health.svg)](https://phpackages.com/packages/portospire-suitecrmclient)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)