PHPackages                             skysilk/freshdesk-php-sdk - 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. skysilk/freshdesk-php-sdk

ActiveLibrary[API Development](/categories/api)

skysilk/freshdesk-php-sdk
=========================

PHP SDK for the Freshdesk API (v2)

0.3.1(9y ago)0280MITPHPPHP >=5.5.0

Since Apr 21Pushed 2y ago4 watchersCompare

[ Source](https://github.com/SkysilkInc/freshdesk-php-sdk)[ Packagist](https://packagist.org/packages/skysilk/freshdesk-php-sdk)[ Docs](https://github.com/mpclarkson/freshdesk-php-sdk)[ RSS](/packages/skysilk-freshdesk-php-sdk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (14)Used By (0)

Freshdesk PHP SDK API v2
========================

[](#freshdesk-php-sdk-api-v2)

[![Build Status](https://camo.githubusercontent.com/947a04250d82cf3c62b8f945cff2698666f2499a9f295caabb7c2585abf29282/68747470733a2f2f7472617669732d63692e6f72672f6d70636c61726b736f6e2f66726573686465736b2d7068702d73646b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/mpclarkson/freshdesk-php-sdk)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/b30601953919d2c22b2b090e953b34d716f21386ad32a42126deaac25c3ed3c7/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6d70636c61726b736f6e2f66726573686465736b2d7068702d73646b2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/mpclarkson/freshdesk-php-sdk/?branch=master)[![SensioLabsInsight](https://camo.githubusercontent.com/ee4dd86cc8c71aba0497e373e0f4b4cc5588e677504fc8cf44db66c51efa5dc7/68747470733a2f2f696d672e736869656c64732e696f2f73656e73696f6c6162732f692f35636237303034612d616334382d346665322d383861342d3739333431653363303364362e737667)](https://insight.sensiolabs.com/projects/5cb7004a-ac48-4fe2-88a4-79341e3c03d6)[![Packagist](https://camo.githubusercontent.com/3d6d3677e6975d47c955754350a8f1da96f959a94304d27ff05da38975cbb09a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d70636c61726b736f6e2f66726573686465736b2d7068702d73646b2e737667)](https://packagist.org/packages/mpclarkson/freshdesk-php-sdk)

This is a PHP 5.5+ SDK for the [Freshdesk](https://www.freshdesk.com) API v2.

If you have questions, please contact me or open an issue on GitHub.

Quick Start
-----------

[](#quick-start)

```
require __DIR__ . '/vendor/autoload.php';
use \Freshdesk\Api;

$api = new Api("your_freshdesk_api_key", "your_freshdesk_domain");

$all = $api->tickets->all();
$some = $api->tickets->all(['page' => 2]);
$new = $api->tickets->create($data);
$updated = $api->tickets->update($data);
$api->tickets->delete($id);
$existing = $api->tickets->view($id);

//Responses are simple arrays, e.g.:
$id = $existing['id'];
$first = $all[0];

```

Framework Integration
---------------------

[](#framework-integration)

- Symfony - [FreshdeskBundle](https://github.com/mpclarkson/freshdesk-bundle)
- Laravel/Lumen - [Freshdesk Larvel Service Provider](https://github.com/mpclarkson/freshdesk-laravel) .

Installation
------------

[](#installation)

To integrate this library into your application, use [Composer](https://getcomposer.org).

Add `mpclarkson/freshdesk-php-sdk` to your **composer.json** file:

```
{
    "require": {
        "mpclarkson/freshdesk-php-sdk": "dev-master"
    }
}
```

Then run:

```
php composer.phar install
```

API Overview
------------

[](#api-overview)

Full documentation is available [here](docs/ApiIndex.md)

### Getting started

[](#getting-started)

Creating a new API instance is very easy. All you need is your Freshdesk API key and your Freshdesk domain.

```
require __DIR__ . '/vendor/autoload.php';
use \Freshdesk\Api;

$api = new Api("your_freshdesk_api_key", "your_freshdesk_domain");
```

### Resources

[](#resources)

The available methods for each resource are available via a public property on the api, for example:

```
//Contacts
$contacts = $api->contacts->update($contactId, $data);

//Agents
$me = $api->agents->current();

//Companies
$company = $api->companies->create($data);

//Groups
$deleted = $api->groups->delete($groupId);

//Tickets
$ticket = $api->tickets->view($filters);

//Time Entries
$time = $api->timeEntries->all($ticket['id']);

//Conversations
$ticket = $api->conversations->note($ticketId, $data);

//Categories
$newCategory = $api->categories->create($data);

//Forums
$forum = $api->forums->create($categoryId, $data);

//Topics
$topics = $api->topics->monitor($topicId, $userId);

//Comments
$comment = $api->comments->create($forumId);

//Email Configs
$configs = $api->emailConfigs->all();

//Products
$product = $api->products->view($productId);

//Business Hours
$hours = $api->businessHours->all();

//SLA Policy
$policies = $api->slaPolicies->all();
```

### Responses

[](#responses)

All responses are arrays of data. Please refer to Freshdesk's documentation for further information.

### Filtering

[](#filtering)

All `GET` requests accept an optional `array $query` parameter to filter results. For example:

```
//Page 2 with 50 results per page
$page2 = $this->forums->all(['page' => 2, 'per_page' => 50]);

//Tickets for a specific customer
$tickets = $this->tickets->view(['company_id' => $companyId]);
```

Please read the Freshdesk documentation for further information on filtering `GET` requests.

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

[](#contributing)

This is a work in progress and PRs are welcome. Please read the [contributing guide](.github/CONTRIBUTING.md).

Nearly all api calls are available except for the `Solutions` and `Surveys`, which Freshdesk has not yet implemented.

- Solutions
- Surveys
- Uploading files is not yet supported
- More tests. You can never have enough!
- Nicer documentation

Author
------

[](#author)

The library was written and maintained by [Matthew Clarkson](http://mpclarkson.github.io/)from [Hilenium](https://hilenium.com).

Reference
---------

[](#reference)

- [Freshdesk API Documentation](https://developer.freshdesk.com/api/)

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~15 days

Recently: every ~34 days

Total

10

Last Release

3530d ago

PHP version history (2 changes)0.1.0PHP >=5.5

0.2.1PHP >=5.5.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/8f49ddd06858998a95cee0cef985eb8c2e10faeace7031ae1a1b4fcebce0381a?d=identicon)[SkySilk](/maintainers/SkySilk)

---

Top Contributors

[![mpclarkson](https://avatars.githubusercontent.com/u/4843821?v=4)](https://github.com/mpclarkson "mpclarkson (12 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (6 commits)")[![gtapps](https://avatars.githubusercontent.com/u/16778396?v=4)](https://github.com/gtapps "gtapps (3 commits)")[![AlexKrivbass](https://avatars.githubusercontent.com/u/28869088?v=4)](https://github.com/AlexKrivbass "AlexKrivbass (2 commits)")[![Nizhnikovsky](https://avatars.githubusercontent.com/u/31595791?v=4)](https://github.com/Nizhnikovsky "Nizhnikovsky (2 commits)")[![gielwijgergangs](https://avatars.githubusercontent.com/u/1364607?v=4)](https://github.com/gielwijgergangs "gielwijgergangs (1 commits)")[![vdechenaux](https://avatars.githubusercontent.com/u/1501825?v=4)](https://github.com/vdechenaux "vdechenaux (1 commits)")

---

Tags

apisupporthelp deskFreshdeskcustomer service

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/skysilk-freshdesk-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/skysilk-freshdesk-php-sdk/health.svg)](https://phpackages.com/packages/skysilk-freshdesk-php-sdk)
```

###  Alternatives

[mpclarkson/freshdesk-php-sdk

PHP SDK for the Freshdesk API (v2)

34674.8k5](/packages/mpclarkson-freshdesk-php-sdk)[helpscout/api

Help Scout API v2 Client

1002.1M4](/packages/helpscout-api)[mpclarkson/freshdesk-laravel

Laravel package for the Freshdesk API (v2)

1767.3k](/packages/mpclarkson-freshdesk-laravel)

PHPackages © 2026

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