PHPackages                             jbtje/vtiger-laravel - 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. jbtje/vtiger-laravel

ActiveLibrary[API Development](/categories/api)

jbtje/vtiger-laravel
====================

A vtiger api wrapper

v0.1.0(4y ago)37091MITPHPPHP ^7.4|^8.0

Since Nov 1Pushed 4y ago1 watchersCompare

[ Source](https://github.com/JBtje/vtiger-laravel)[ Packagist](https://packagist.org/packages/jbtje/vtiger-laravel)[ RSS](/packages/jbtje-vtiger-laravel/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Vtiger 7.4.0 open source (Laravel 8 Package)
============================================

[](#vtiger-740-open-source-laravel-8-package)

*This package might work with older versions of Vtiger, and possibly with laravel 6 or 7.*

BerliCRM (based on Vtiger) has a better documentation, files are added in the [documentation](documentation) folder.

Use the Vtiger webservice (REST) API from within Laravel for the following operations.

- ListTypes
- Create
- Retrieve
- Update
- Delete
- Search
- Query
- Describe

See [Third Party App Integration (REST APIs)](http://community.vtiger.com/help/vtigercrm/developers/third-party-app-integration.html)

Installation, Configuration and Usage
-------------------------------------

[](#installation-configuration-and-usage)

### Installing

[](#installing)

1. In order to install the Vtiger package in your Laravel project, just run the composer require command from your terminal:

    ```
    composer require "jbtje/vtiger-laravel"

    ```
2. Add ENV variables:

    ```
    VTIGER_URL=https://your-crm-domain.com/webservice.php
    VTIGER_USERNAME=
    VTIGER_KEY=
    VTIGER_PERSISTENT=true
    VTIGER_RETRIES=10

    ```

***Username** and **Access Key** can be found within Vtiger under **My Preferences***

3. Optional: Publish the configuration file:

    ```
    php artisan vendor:publish --tag="vtiger"

    ```

### Configuration

[](#configuration)

You can create a new user in Vtiger for the API to use, or use an existing user.

### Usage

[](#usage)

Include the Vtiger package in your controller:

```
use JBtje\VtigerLaravel\Vtiger;
```

#### ListTypes

[](#listtypes)

List types is a command to provide you with all possible types the Vtiger CRM supports. For each type, you can run the `describe()` command, to obtain the data structure.

Obtain all the list types:

```
$vtiger = new Vtiger();
$data = $vtiger->listTypes();
```

 For a clean install, this will return: (click to expand)```
  {
    "success": true,
    "result": {
        "types": [
            "Campaigns",
            "Vendors",
            "Faq",
            "Quotes",
            "PurchaseOrder",
            "SalesOrder",
            "Invoice",
            "PriceBooks",
            "Calendar",
            "Leads",
            "Accounts",
            "Contacts",
            "Potentials",
            "Products",
            "Documents",
            "Emails",
            "HelpDesk",
            "Events",
            "Users",
            "PBXManager",
            "ServiceContracts",
            "Services",
            "Assets",
            "ModComments",
            "ProjectMilestone",
            "ProjectTask",
            "Project",
            "SMSNotifier",
            "Groups",
            "Currency",
            "DocumentFolders",
            "CompanyDetails",
            "LineItem",
            "Tax",
            "ProductTaxes"
        ],
        "information": {
            "Campaigns": {
                "isEntity": true,
                "label": "Campaigns",
                "singular": "Campaign"
            },
            "Vendors": {
                "isEntity": true,
                "label": "Vendors",
                "singular": "Vendor"
            },
            "Faq": {
                "isEntity": true,
                "label": "FAQ",
                "singular": "FAQ"
            },
            "Quotes": {
                "isEntity": true,
                "label": "Quotes",
                "singular": "Quote"
            },
            "PurchaseOrder": {
                "isEntity": true,
                "label": "Purchase Orders",
                "singular": "Purchase Order"
            },
            "SalesOrder": {
                "isEntity": true,
                "label": "Sales Orders",
                "singular": "Sales Order"
            },
            "Invoice": {
                "isEntity": true,
                "label": "Invoices",
                "singular": "Invoice"
            },
            "PriceBooks": {
                "isEntity": true,
                "label": "Price Books",
                "singular": "Price Book"
            },
            "Calendar": {
                "isEntity": true,
                "label": "Calendar",
                "singular": "Task"
            },
            "Leads": {
                "isEntity": true,
                "label": "Leads",
                "singular": "Lead"
            },
            "Accounts": {
                "isEntity": true,
                "label": "Organizations",
                "singular": "Organization"
            },
            "Contacts": {
                "isEntity": true,
                "label": "Contacts",
                "singular": "Contact"
            },
            "Potentials": {
                "isEntity": true,
                "label": "Opportunities",
                "singular": "Opportunity"
            },
            "Products": {
                "isEntity": true,
                "label": "Products",
                "singular": "Product"
            },
            "Documents": {
                "isEntity": true,
                "label": "Documents",
                "singular": "Document"
            },
            "Emails": {
                "isEntity": true,
                "label": "Emails",
                "singular": "Email"
            },
            "HelpDesk": {
                "isEntity": true,
                "label": "Tickets",
                "singular": "Ticket"
            },
            "Events": {
                "isEntity": true,
                "label": "Events",
                "singular": "Event"
            },
            "Users": {
                "isEntity": true,
                "label": "Users",
                "singular": "User"
            },
            "PBXManager": {
                "isEntity": true,
                "label": "PBX Manager",
                "singular": "Call Record"
            },
            "ServiceContracts": {
                "isEntity": true,
                "label": "Service Contracts",
                "singular": "Service Contract"
            },
            "Services": {
                "isEntity": true,
                "label": "Services",
                "singular": "Service"
            },
            "Assets": {
                "isEntity": true,
                "label": "Assets",
                "singular": "Asset"
            },
            "ModComments": {
                "isEntity": true,
                "label": "Comments",
                "singular": "Comment"
            },
            "ProjectMilestone": {
                "isEntity": true,
                "label": "Project Milestones",
                "singular": "Project Milestone"
            },
            "ProjectTask": {
                "isEntity": true,
                "label": "Project Tasks",
                "singular": "Project Task"
            },
            "Project": {
                "isEntity": true,
                "label": "Projects",
                "singular": "Project"
            },
            "SMSNotifier": {
                "isEntity": true,
                "label": "SMS Notifier",
                "singular": "SMS Notifier"
            },
            "Groups": {
                "isEntity": false,
                "label": "Groups",
                "singular": "Groups"
            },
            "Currency": {
                "isEntity": false,
                "label": "Currency",
                "singular": "Currency"
            },
            "DocumentFolders": {
                "isEntity": false,
                "label": "DocumentFolders",
                "singular": "DocumentFolders"
            },
            "CompanyDetails": {
                "isEntity": false,
                "label": "CompanyDetails",
                "singular": "CompanyDetails"
            },
            "LineItem": {
                "isEntity": false,
                "label": "LineItem",
                "singular": "LineItem"
            },
            "Tax": {
                "isEntity": false,
                "label": "Tax",
                "singular": "Tax"
            },
            "ProductTaxes": {
                "isEntity": false,
                "label": "ProductTaxes",
                "singular": "ProductTaxes"
            }
        }
    }
}
```

#### Describe

[](#describe)

To obtain the data sctructure of a module in Vtiger, run the describe method with the module name. Module names can be obtained using `listTypes()`

```
$vtiger = new Vtiger();
$data = $vtiger->describe( 'Contacts' );
```

 Partial result for "Contacts": (click to expand)```
{
    "success": true,
    "result": {
        "label": "Contacts",
        "name": "Contacts",
        "createable": true,
        "updateable": true,
        "deleteable": true,
        "retrieveable": true,
        "fields": [
            {
                "name": "firstname",
                "label": "First Name",
                "mandatory": false,
                "type": {
                    "name": "string"
                },
                "isunique": false,
                "nullable": true,
                "editable": true,
                "default": ""
            },
            {
                "name": "lastname",
                "label": "Last Name",
                "mandatory": true,
                "type": {
                    "name": "string"
                },
                "isunique": false,
                "nullable": false,
                "editable": true,
                "default": ""
            },
            {
                "name": "assigned_user_id",
                "label": "Assigned To",
                "mandatory": true,
                "type": {
                    "name": "owner"
                },
                "isunique": false,
                "nullable": false,
                "editable": true,
                "default": ""
            },
            ...
        ],
        "idPrefix": "12",
        "isEntity": true,
        "allowDuplicates": true,
        "labelFields": "firstname,lastname"
    }
}
```

*Please note the `mandatory` field.*

#### Create

[](#create)

To insert a record into the CRM, first create an array of data to insert. Using `describe()`, you can see which fields are mandatory.

```
$vtiger = new Vtiger();
$data = [
    'assigned_user_id' => '4x1',
    ...
];
$data = $vtiger->create( $MODULE_NAME, json_encode( $data ) );
```

#### Retrieve

[](#retrieve)

To retrieve a record from the CRM, you need the id of the record you want to find (i.e. '4x1').

```
$vtiger = new Vtiger();
$data = $vtiger->retrieve( '4x1' );
```

#### Update

[](#update)

The easiest way to update a record in the CRM is to retrieve the record first.

```
$vtiger = new Vtiger();
$obj = $vtiger->retrieve( '4x1' );
```

Then update the object:

```
$obj->result->field_name = 'Your new value';
$data = $vtiger->update( $obj->result );
```

#### Delete

[](#delete)

To delete a record from the CRM, you need the id of the record you want to delete (e.g. '4x1').

```
$vtiger = new Vtiger();
$data = $vtiger->delete( '4x1' );
```

#### Lookup

[](#lookup)

This function uses the Vtiger Lookup API endpoint to search for a single piece of information within multiple columns of a Vtiger module. This function is often multitudes faster than the search function.

```
$dataType = 'phone';
$phoneNumber = '1234567890';
$module = 'Leads';
$columns = ['phone', 'fax']; // Must be an array

$vtiger = new Vtiger();
$data = $vtiger->lookup( $dataType, $phoneNumber, $module, $columns );
```

#### Search

[](#search)

This function is a sql query builder wrapped around the query function. Accepts instance of laravels QueryBuilder.

```
$vtiger = new Vtiger();
$query = DB::table( 'Leads' )->select( 'id', 'firstname', 'lastname' )->where( 'firstname', 'John' );
$data = $vtiger->search( $query );

foreach( $data->result as $result ) {
    // Do something
}
```

By default, the function will quote but not escape your inputs, if you wish for your data to not be quoted, set the 2nd paramater to false:

```
$vtiger = new Vtiger();
$data = $vtiger->search( $query, false );
```

Also keep in mind that Vtiger has several limitations on it's sql query capabilities. You can not use conditional grouping i.e "where (firstname = 'John' AND 'lastname = 'Doe') OR (firstname = 'Jane' AND lastname = 'Smith')" will fail.

#### Query

[](#query)

To use the [Query Operation](http://community.vtiger.com/help/vtigercrm/developers/third-party-app-integration.html#query-operation), you first need to create the SQL query.

```
$query = "SELECT * FROM ModuleName;";
```

Then run the query...

```
$vtiger = new Vtiger();
$data = $vtiger->query($query);

foreach( $data->result as $result ) {
    // Do something
}
```

Contributing
------------

[](#contributing)

Please report any issue you find in the issues page. Pull requests are more than welcome.

License
-------

[](#license)

This project is licensed under the MIT licence - see the [LICENSE.md](LICENSE.md) file for details

Contributors
------------

[](#contributors)

This package is based upon [Clystnet/Vtiger](https://github.com/Clystnet/Vtiger)

- [Ahmad Syamim](https://www.syamim.ascube.net)
- [Clyde Cox](https://github.com/cjcox17)
- [Christopher Pratt](https://www.clystnet.com)
- [Adam Godfrey](https://github.com/adam-godfrey)

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 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

Unknown

Total

1

Last Release

1653d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1798984?v=4)[JBtje](/maintainers/JBtje)[@JBtje](https://github.com/JBtje)

---

Top Contributors

[![JBtje](https://avatars.githubusercontent.com/u/1798984?v=4)](https://github.com/JBtje "JBtje (3 commits)")

### Embed Badge

![Health badge](/badges/jbtje-vtiger-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/jbtje-vtiger-laravel/health.svg)](https://phpackages.com/packages/jbtje-vtiger-laravel)
```

###  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)