PHPackages alleotech/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. alleotech/freshdesk-php-sdk ActiveLibrary[API Development](/categories/api) alleotech/freshdesk-php-sdk =========================== PHP SDK for the Freshdesk API (v2) v1.0.0(6y ago)0601MITPHPPHP >=5.5.0CI failing Since Apr 21Pushed 6y ago1 watchersCompare [ Source](https://github.com/alleotech/freshdesk-php-sdk)[ Packagist](https://packagist.org/packages/alleotech/freshdesk-php-sdk)[ Docs](https://github.com/alleotech/freshdesk-php-sdk)[ RSS](/packages/alleotech-freshdesk-php-sdk/feed)WikiDiscussions master Synced yesterday READMEChangelog (1)Dependencies (4)Versions (12)Used By (0) Freshdesk PHP SDK API v2 ======================== [](#freshdesk-php-sdk-api-v2) [![Build Status](https://camo.githubusercontent.com/109dc1b0f51039e3dac473ab47cb03bdf1bd9737aa6a5f5cbb6b61ef451170fa/68747470733a2f2f7472617669732d63692e6f72672f616c6c656f746563682f66726573686465736b2d7068702d73646b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/alleotech/freshdesk-php-sdk)[![Packagist](https://camo.githubusercontent.com/5141c42530cacb4c52aead0e79770f9a802c0b7a3442a469ec1028066d85c336/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c6c656f746563682f66726573686465736b2d7068702d73646b2e737667)](https://packagist.org/packages/alleotech/freshdesk-php-sdk) NOTE: This library is forked from [mpclarkson/freshdesk-php-sdk](https://github.com/mpclarkson/freshdesk-php-sdk), since the origin is [not supported](https://github.com/mpclarkson/freshdesk-php-sdk/issues/24#issuecomment-480466671) anymore. This is a PHP SDK for the [Freshdesk](https://www.freshdesk.com) API v2. If you have questions, please contact us 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). Add `alleotech/freshdesk-php-sdk` to your **composer.json** file: ``` { "require": { "alleotech/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). All new versions are maintedin by [AlleoTech Ltd](https://alleo.tech). Reference --------- [](#reference) - [Freshdesk API Documentation](https://developer.freshdesk.com/api/) ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity9 Limited adoption so far Community15 Small or concentrated contributor base Maturity65 Established project with proven stability 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 ~115 days Recently: every ~288 days Total 11 Last Release 2518d ago Major Versions 0.3.1 → v1.0.02019-06-21 PHP version history (2 changes)0.1.0PHP >=5.5 0.2.1PHP >=5.5.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/3cf6df002a284d78fb6e9d8222ca4d102e0832035ed6bc8447008bd234e131a4?d=identicon)[mamchenkov](/maintainers/mamchenkov) --- Top Contributors [![mamchenkov](https://avatars.githubusercontent.com/u/437928?v=4)](https://github.com/mamchenkov "mamchenkov (15 commits)")[![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)")[![bianchi](https://avatars.githubusercontent.com/u/1824997?v=4)](https://github.com/bianchi "bianchi (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 apifreshdeskfreshdesk-apiphpapisupporthelp deskFreshdeskcustomer service ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/alleotech-freshdesk-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/alleotech-freshdesk-php-sdk/health.svg)](https://phpackages.com/packages/alleotech-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)