Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 1.94 KB

README.md

File metadata and controls

71 lines (46 loc) · 1.94 KB

Laravel Pipedrive API wrapper

Total Downloads Latest Stable Version License

Installation

  1. Require using composer
composer require lasserafn/laravel-pipedrive
  1. (For laravel 5.4 and below) Add the PipedriveServiceProvider to your config/app.php providers array.
'providers' => [
    \LasseRafn\Pipedrive\PipedriveServiceProvider::class,
]
  1. Publish config file.
php artisan vendor:publish --provider "LasseRafn\Pipedrive\PipedriveServiceProvider"

Usage

Create Pipedrive Instance

$pipedrive = new \LasseRafn\Pipedrive\Pipedrive($APIKEY); // or set the api key in the config/pipedrive.php file.

To find your API key you must login to Pipedrive and navigate to Settings -> Personal -> Api (/settings#api)

Get all Persons

$pipedrive->persons()->all(); // Returns a collection of Person models.

Find Person by ID

$pipedrive->persons()->find(1); // Returns a Person model.

Get a list of Activities that are not done

Filters consist of an array of arrays. The first parameter is included fields, leave it at null to keep the default.

$pipedrive->activities()->all(null, [ [ 'done' => 0 ] ]);

(Later versions will switch to a single array key => value).

Supported endpoints

... Todo

Testing

... Todo