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

ActiveLibrary[API Development](/categories/api)

arjanderuyter/freshdesk-php-sdk
===============================

PHP extended SDK for the Freshdesk API (v2)

v0.4(3y ago)01.1kMITPHPPHP >=7.2

Since Jan 28Pushed 3y agoCompare

[ Source](https://github.com/ArjandeRuyter/freshdesk-php-sdk)[ Packagist](https://packagist.org/packages/arjanderuyter/freshdesk-php-sdk)[ Docs](https://github.com/arjanderuyter/freshdesk-php-sdk)[ RSS](/packages/arjanderuyter-freshdesk-php-sdk/feed)WikiDiscussions master Synced yesterday

READMEChangelog (4)Dependencies (2)Versions (6)Used By (0)

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

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

This is a PHP 7.2+ 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];
```

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

[](#installation)

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

Then just run:

```
composer require arjanderuyter/freshdesk-php-sdk
```

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();

//Solutions
$categories = $api->solutioncategories->all();
$categories = $api->solutioncategories->create($data);
$categories = $api->solutioncategories->update($id, $data);
$categories = $api->solutioncategories->view($id);

$folders = $api->solutionfolders->all();
$folders = $api->solutionfolders->create($data);
$folders = $api->solutionfolders->update($id, $data);
$folders = $api->solutionfolders->view($id);

$articles = $api->solutionarticles->all();
$articles = $api->solutionarticles->create($data);
$articles = $api->solutionarticles->update($id, $data);
$articles = $api->solutionarticles->view($id);
```

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

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

Author
------

[](#author)

The library was written [Matthew Clarkson](http://mpclarkson.github.io/)from [Hilenium](https://hilenium.com) then forked and adopted for Laravel 8.x by [Michał Borek](http://github.com/michal-borek) for [Wocozon](https://wocozon.nl). Solutions was done by [Arjan de Ruyter](https://github.com/ArjandeRuyter) because he needed it for ()

Reference
---------

[](#reference)

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

###  Health Score

22

—

LowBetter than 21% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity35

Early-stage or recently created project

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

Total

4

Last Release

1150d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/573f8e5f9aa0a0a670064b064fa23210d32480d51516bb9b240a35cc04d9d5a2?d=identicon)[ArjandeRuyter](/maintainers/ArjandeRuyter)

---

Top Contributors

[![mpclarkson](https://avatars.githubusercontent.com/u/4843821?v=4)](https://github.com/mpclarkson "mpclarkson (13 commits)")[![michal-borek](https://avatars.githubusercontent.com/u/15640488?v=4)](https://github.com/michal-borek "michal-borek (9 commits)")[![ArjandeRuyter](https://avatars.githubusercontent.com/u/5707120?v=4)](https://github.com/ArjandeRuyter "ArjandeRuyter (6 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)")[![OneHatRepo](https://avatars.githubusercontent.com/u/13893545?v=4)](https://github.com/OneHatRepo "OneHatRepo (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/arjanderuyter-freshdesk-php-sdk/health.svg)

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

###  Alternatives

[mpclarkson/freshdesk-php-sdk

PHP SDK for the Freshdesk API (v2)

35680.2k5](/packages/mpclarkson-freshdesk-php-sdk)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M47](/packages/tencentcloud-tencentcloud-sdk-php)[helpscout/api

Help Scout API v2 Client

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

Laravel package for the Freshdesk API (v2)

1967.8k](/packages/mpclarkson-freshdesk-laravel)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)

PHPackages © 2026

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