Using the Sugar REST PHP Client

mrussellsugarcrm —  October 17, 2016

Sugar REST PHP Client

A new open source library for working with Sugar 7’s powerful REST API has just been published! You can view the library in our GitHub account here:

Full instructions for installation, usage, current included API Endpoints, and ways to contribute can all be found in the GitHub Wiki on the repository.

Who should use it?

The Sugar REST PHP Client was built initially to make working with Sugar instances easier for some of our internal tools. I wanted to provide a quick, easy, and object oriented, way to access Sugar 7’s REST API that could be used by all PHP developers. Any developer who is developing PHP applications that integrate with Sugar 7 should be interested in using the new library. The simplified architecture takes away the hassle of setting up and managing Curl connections, and allows the developer to focus on what matters most, which is working with the data in their Sugar application.

How to use it?

The REST PHP Client is setup as a composer package, and can be easily added to your existing project by adding it to your required packages in your projects composer.json file.

Once it’s installed via composer, you can access the Client in the SugarAPI\SDK namespace.

A quick example of how much easier to use this new library is, can be shown by reviewing the latest documentation on using the REST API to get a filtered list of records from a module in the Support Developer Guide, and comparing it to the following snippet of code that does the exact same API request.

$server = 'https://localhost/sugarcrm/rest/v10/';
$credentials = array(
    'username' => 'admin',
    'password' => 'asdf'
$SugarAPI = new \SugarAPI\SDK\SugarAPI($server, $credentials);

$requestData = array(
    "filter" => array(
        '$or' => array(
                //name starts with 'a'
                "name" => array(
                //name starts with 'b'
                "name" => array(
    "max_num" => 2,
    "offset" => 0,
    "fields" => "id",
    "order_by" => "date_entered",
    "favorites" => false,
    "my_items" => false,

$response = $SugarAPI->filterRecords('Accounts')
if ($response->getStatus()=='200'){
    $records = $response->getBody();

Each API Endpoint in the Sugar 7 REST API is defined by an Endpoint Class in the REST PHP Client library, which is then dynamically mapped to a method on the REST PHP Client Object. This dynamic method, generates the Endpoint Object, configures the Curl Request, and returns the Endpoint Object for manipulation, such as loading in data and finally executing the actual request.

Calling filterRecords() dynamic method, returns a
SugarAPI\SDK\Endpoint\POST\ModuleFilter Object
$SugarAPI = new \SugarAPI\SDK\SugarAPI($server, $credentials);

$FilterEndpoint = $SugarAPI->filterRecords();

These Endpoint Objects manage the Request and Response to the API, as well as manage the data sent to the API. As shown above the execute() method on the Endpoint Object takes the request data that is to be sent to the Sugar API, and submits the Request the server. In the Filter Record example above, the passed in data matches what is shown in the API Endpoints documentation, however this is not always the case. The Endpoint Classes allow for manipulation of the data before being added to the Request, which means that the REST PHP Client can shorten the needed payload to allow integrated systems to quickly build requests.

One such example of this is the Bulk API Endpoint Object included in the REST PHP Client. As the documentation shows, the API request payload can be quite complicated, so to simplify it, it seemed intuitive to make the execute() method on the Bulk Endpoint Class, accept an array of REST PHP Client Endpoints objects, as they contain all the data needed for the Bulk request, saving the developer time by not having to build out the complex payload manually.

$SugarAPI = new \SugarAPI\SDK\SugarAPI($server,$creds);
$Accounts = $SugarAPI->filterRecords('Accounts')
                     ->setData(array('max_num'=> 5));
$Contacts = $SugarAPI->filterRecords('Contacts')
                     ->setData(array('max_num'=> 1));
$Notes = $SugarAPI->filterRecords('Notes')
                  ->setData(array('max_num'=> 3));
$Leads = $SugarAPI->filterRecords('Leads')
                  ->setData(array('max_num'=> 2));
$BulkCall = $SugarAPI->bulk()->execute(array(
$response = $BulkCall->getResponse();
if ($response->getStatus()==‘200’){

As of right now, not all Endpoints have been added to the REST PHP Client library, however the major Endpoints used for manipulating data have been added, and more will be added in continued releases. Check out the current Endpoints that can be used here which also includes a short code snippet showcasing how to use each one.

What’s Next?

I would love to see more PHP developers using the library, which is why it is being released as an Open Source community project. Any issues that are found can be added to the GitHub repository under the Issues tab. Likewise, if you have features you would like added you can add them to the Issues tab on the repository as well. More detailed contribution guidelines can be found in the CONTRIBUTING doc, and in the Wiki.

7 responses to Using the Sugar REST PHP Client


    Does this work with sugarondemand instances? (API 7.8) Trying the server as my instance and entering a username and password yield only a 302 error. Other methods of authenticating to the REST API work with the same credentials


    yes exactly. you need to pass fully endpoint url then after it will work. Thanks


    rest/v10 is added to the Server you pass in, but you need to pass for OnDemand instances. The 302 is because you didn’t specify https, instead you used, and it will default to HTTP, which our OnDemand environment doesn’t use.


    I’m trying to implement Sugarcrm in a project. I’ very new in this topic.
    in documentation you define $server. I want to know how you define it. Is your api install in v10 folder?

    I downloaded this api from git and as their doc,4 main components in scr folder. Then what should my server link?
    I use this https://localhost/rest-php-client-master/src/ . but it gets me 404 error

    Can you please help me in this issue?

      mrussellsugarcrm October 2, 2017 at 2:45 pm

      Hi Taposhi,

      The client is a Composer Library that can be added to any PHP application. Accessing it via a web-page will not work, as the source only contains the code necessary to use the Object/Class inside your application. Once installed in your PHP application, you can pass in the SugarCRM Url that is used to access the SugarCRM application