{"id":16777078,"url":"https://github.com/mpclarkson/freshdesk-php-sdk","last_synced_at":"2025-04-05T05:09:00.960Z","repository":{"id":54036706,"uuid":"56661491","full_name":"mpclarkson/freshdesk-php-sdk","owner":"mpclarkson","description":"Freshdesk API v2 PHP library","archived":false,"fork":false,"pushed_at":"2024-08-07T05:39:46.000Z","size":4889,"stargazers_count":31,"open_issues_count":20,"forks_count":80,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-14T07:23:17.845Z","etag":null,"topics":["freshdesk","php"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mpclarkson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-20T06:30:05.000Z","updated_at":"2024-04-02T08:12:52.000Z","dependencies_parsed_at":"2024-06-18T14:02:53.007Z","dependency_job_id":"7f9cb48c-f2aa-4b1d-956c-730bb19e3d99","html_url":"https://github.com/mpclarkson/freshdesk-php-sdk","commit_stats":{"total_commits":72,"total_committers":8,"mean_commits":9.0,"dds":0.2222222222222222,"last_synced_commit":"c310faedc1ac8479c2fbd0d32e99cf3f0eb645d9"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpclarkson%2Ffreshdesk-php-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpclarkson%2Ffreshdesk-php-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpclarkson%2Ffreshdesk-php-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpclarkson%2Ffreshdesk-php-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mpclarkson","download_url":"https://codeload.github.com/mpclarkson/freshdesk-php-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289429,"owners_count":20914464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["freshdesk","php"],"created_at":"2024-10-13T07:23:24.574Z","updated_at":"2025-04-05T05:09:00.940Z","avatar_url":"https://github.com/mpclarkson.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Freshdesk PHP SDK API v2 \n\n[![Build Status](https://travis-ci.org/mpclarkson/freshdesk-php-sdk.svg?branch=master)](https://travis-ci.org/mpclarkson/freshdesk-php-sdk)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mpclarkson/freshdesk-php-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mpclarkson/freshdesk-php-sdk/?branch=master)\n[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/5cb7004a-ac48-4fe2-88a4-79341e3c03d6.svg)](https://insight.sensiolabs.com/projects/5cb7004a-ac48-4fe2-88a4-79341e3c03d6)\n[![Packagist](https://img.shields.io/packagist/v/mpclarkson/freshdesk-php-sdk.svg)](https://packagist.org/packages/mpclarkson/freshdesk-php-sdk)\n\nThis is a PHP 5.5+ SDK for the [Freshdesk](https://www.freshdesk.com) API v2.\n\nIf you have questions, please contact me or open an issue on GitHub.\n\n## Quick Start\n```phpg\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Freshdesk\\Api;\n\n$api = new Api(\"your_freshdesk_api_key\", \"your_freshdesk_domain\");\n\n$all = $api-\u003etickets-\u003eall();\n$some = $api-\u003etickets-\u003eall(['page' =\u003e 2]);\n$new = $api-\u003etickets-\u003ecreate($data);\n$updated = $api-\u003etickets-\u003eupdate($data);\n$api-\u003etickets-\u003edelete($id);\n$existing = $api-\u003etickets-\u003eview($id);\n\n//Responses are simple arrays, e.g.:\n$id = $existing['id'];\n$first = $all[0];\n\n```\n\n## Framework Integration\n\n- Symfony - [FreshdeskBundle](https://github.com/mpclarkson/freshdesk-bundle) \n- Laravel/Lumen - [Freshdesk Larvel Service Provider](https://github.com/mpclarkson/freshdesk-laravel) .\n\n## Installation\n\nTo integrate this library into your application, use [Composer](https://getcomposer.org).\n\nAdd `mpclarkson/freshdesk-php-sdk` to your **composer.json** file:\n\n```json\n{\n    \"require\": {\n        \"mpclarkson/freshdesk-php-sdk\": \"dev-master\"\n    }\n}\n```\n\nThen run:\n\n```bash\nphp composer.phar install\n```\n\n## API Overview\n\nFull documentation is available [here](docs/ApiIndex.md)\n\n### Getting started\n\nCreating a new API instance is very easy. All you need is your Freshdesk \nAPI key and your Freshdesk domain.\n\n```php\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Freshdesk\\Api;\n\n$api = new Api(\"your_freshdesk_api_key\", \"your_freshdesk_domain\");\n```\n\n### Resources\n\nThe available methods for each resource are available via a public\nproperty on the api, for example:\n\n```php\n//Contacts\n$contacts = $api-\u003econtacts-\u003eupdate($contactId, $data);\n\n//Agents\n$me = $api-\u003eagents-\u003ecurrent();\n\n//Companies\n$company = $api-\u003ecompanies-\u003ecreate($data);\n\n//Groups\n$deleted = $api-\u003egroups-\u003edelete($groupId);\n\n//Tickets\n$ticket = $api-\u003etickets-\u003eview($filters);\n\n//Time Entries\n$time = $api-\u003etimeEntries-\u003eall($ticket['id']);\n\n//Conversations\n$ticket = $api-\u003econversations-\u003enote($ticketId, $data);\n\n//Categories\n$newCategory = $api-\u003ecategories-\u003ecreate($data);\n\n//Forums\n$forum = $api-\u003eforums-\u003ecreate($categoryId, $data);\n\n//Topics\n$topics = $api-\u003etopics-\u003emonitor($topicId, $userId);\n\n//Comments\n$comment = $api-\u003ecomments-\u003ecreate($forumId);\n\n//Email Configs\n$configs = $api-\u003eemailConfigs-\u003eall();\n\n//Products\n$product = $api-\u003eproducts-\u003eview($productId);\n\n//Business Hours\n$hours = $api-\u003ebusinessHours-\u003eall();\n\n//SLA Policy\n$policies = $api-\u003eslaPolicies-\u003eall();\n\n```\n\n### Responses\n\nAll responses are arrays of data. Please refer to Freshdesk's documentation\nfor further information. \n\n### Filtering\n\nAll `GET` requests accept an optional `array $query` parameter to filter\nresults. For example:\n\n```php\n//Page 2 with 50 results per page\n$page2 = $this-\u003eforums-\u003eall(['page' =\u003e 2, 'per_page' =\u003e 50]);\n\n//Tickets for a specific customer\n$tickets = $this-\u003etickets-\u003eview(['company_id' =\u003e $companyId]);\n\n```\n\nPlease read the Freshdesk documentation for further information on\nfiltering `GET` requests.\n\n## Contributing\n\nThis is a work in progress and PRs are welcome. Please read the \n[contributing guide](.github/CONTRIBUTING.md).\n\nNearly all api calls are available except for the `Solutions` and `Surveys`, \nwhich Freshdesk has not yet implemented.\n\n- [ ] Solutions\n- [ ] Surveys\n- [ ] Uploading files is not yet supported\n- [ ] More tests. You can never have enough!\n- [ ] Nicer documentation\n\n## Author\n\nThe library was written and maintained by [Matthew Clarkson](http://mpclarkson.github.io/) \nfrom [Hilenium](https://hilenium.com).\n\n## Reference\n\n* [Freshdesk API Documentation](https://developer.freshdesk.com/api/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpclarkson%2Ffreshdesk-php-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmpclarkson%2Ffreshdesk-php-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpclarkson%2Ffreshdesk-php-sdk/lists"}