PHPackages net2grid/zendesk\_api\_client\_php - 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. net2grid/zendesk\_api\_client\_php ActiveLibrary net2grid/zendesk\_api\_client\_php ================================== PHP Client for Zendesk REST API. See http://developer.zendesk.com/api-docs v2.1.3(9y ago)0252Apache License Version 2.0PHPPHP >=5.5.0 Since Aug 12Pushed 9y ago1 watchersCompare [ Source](https://github.com/net2grid/zendesk_api_client_php)[ Packagist](https://packagist.org/packages/net2grid/zendesk_api_client_php)[ Docs](https://github.com/zendesk/zendesk_api_client_php)[ RSS](/packages/net2grid-zendesk-api-client-php/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (6)Versions (33)Used By (0) Zendesk PHP API Client Library ============================== [](#zendesk-php-api-client-library) [![Build Status](https://camo.githubusercontent.com/dd2520e4f067fc40438cc9f295fd571c3a7b06aa7b554e1c9042aae579f5e576/68747470733a2f2f7472617669732d63692e6f72672f7a656e6465736b2f7a656e6465736b5f6170695f636c69656e745f7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/zendesk/zendesk_api_client_php)[![Latest Stable Version](https://camo.githubusercontent.com/eb25a4f53916855617a219292e5607fc3043a8c84653c5246186636f7dba299d/68747470733a2f2f706f7365722e707567782e6f72672f7a656e6465736b2f7a656e6465736b5f6170695f636c69656e745f7068702f762f737461626c65)](https://packagist.org/packages/zendesk/zendesk_api_client_php)[![Total Downloads](https://camo.githubusercontent.com/e62962015adba2b06c17f982dcd4ade6a617e3497901c09a10692de843c57f82/68747470733a2f2f706f7365722e707567782e6f72672f7a656e6465736b2f7a656e6465736b5f6170695f636c69656e745f7068702f646f776e6c6f616473)](https://packagist.org/packages/zendesk/zendesk_api_client_php)[![Code Climate](https://camo.githubusercontent.com/3b2a6ad5347d00ce099db6074f64a6c62cf5667ccc8fdfc9e73a4bf2bec6a611/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f7a656e6465736b2f7a656e6465736b5f6170695f636c69656e745f7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/zendesk/zendesk_api_client_php)[![License](https://camo.githubusercontent.com/e47bc0817b8d2e1746c5fc21f8269f35e8daee97739edb4aca6f157f4242efcb/68747470733a2f2f706f7365722e707567782e6f72672f7a656e6465736b2f7a656e6465736b5f6170695f636c69656e745f7068702f6c6963656e7365)](https://packagist.org/packages/zendesk/zendesk_api_client_php) API Client Version ------------------ [](#api-client-version) This is the second version of our PHP API client. The previous version of the API client can be found on the [v1 branch](https://github.com/zendesk/zendesk_api_client_php/tree/v1). API version support ------------------- [](#api-version-support) This client **only** supports Zendesk's API v2. Please see our [API documentation](http://developer.zendesk.com) for more information. Requirements ------------ [](#requirements) - PHP 5.5+ Installation ------------ [](#installation) The Zendesk PHP API client can be installed using [Composer](https://packagist.org/packages/zendesk/zendesk_api_client_php). ### Composer [](#composer) Inside of `composer.json` specify the following: ``` { "require": { "net2grid/zendesk_api_client_php": "dev-master" } } ``` ### Upgrading from V1 to V2 [](#upgrading-from-v1-to-v2) If you are upgrading from [v1](https://github.com/zendesk/zendesk_api_client_php/tree/v1) of the client, we've written an [upgrade guide](https://github.com/zendesk/zendesk_api_client_php/wiki/Upgrading-from-v1-to-v2) to highlight some of the key differences. Configuration ------------- [](#configuration) Configuration is done through an instance of `Zendesk\API\HttpClient`. The block is mandatory and if not passed, an error will be thrown. ``` // load Composer require 'vendor/autoload.php'; use Zendesk\API\HttpClient as ZendeskAPI; $subdomain = "subdomain"; $username = "email@example.com"; // replace this with your registered email $token = "6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv"; // replace this with your token $client = new ZendeskAPI($subdomain); $client->setAuth('basic', ['username' => $username, 'token' => $token]); ``` Usage ----- [](#usage) ### Basic Operations [](#basic-operations) ``` // Get all tickets $tickets = $client->tickets()->findAll(); print_r($tickets); // Create a new ticket $newTicket = $client->tickets()->create([ 'subject' => 'The quick brown fox jumps over the lazy dog', 'comment' => [ 'body' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' . 'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.' ], 'priority' => 'normal' ]); print_r($newTicket); // Update a ticket $client->tickets()->update(123,[ 'priority' => 'high' ]); // Delete a ticket $client->tickets()->delete(123); ``` ### Attachments [](#attachments) ``` $attachment = $client->attachments()->upload([ 'file' => getcwd().'/tests/assets/UK.png', 'type' => 'image/png', 'name' => 'UK.png' // Optional parameter, will default to filename.ext ]); ``` ### Side-loading [](#side-loading) Side-loading allows you to retrieve related records as part of a single request. See \[the documentation\] for more information. ([https://developer.zendesk.com/rest\_api/docs/core/side\_loading](https://developer.zendesk.com/rest_api/docs/core/side_loading)). An example of sideloading with the client is shown below. ``` $tickets = $client->tickets()->sideload(['users', 'groups'])->findAll(); ``` ### Pagination [](#pagination) The Zendesk API offers a way to get the next pages for the requests and is documented in [the Zendesk Deveoloper Documentation](https://developer.zendesk.com/rest_api/docs/core/introduction#pagination). The way to do this is to pass it as an option to your request. ``` $tickets = $this->client->tickets()->findAll(['per_page' => 10, 'page' => 2]); ``` The allowed options are - per\_page - page - sort\_order Copyright and license --------------------- [](#copyright-and-license) Copyright 2013-present Zendesk Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ### Health Score 32 — LowBetter than 72% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community20 Small or concentrated contributor base Maturity69 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 ~31 days Recently: every ~18 days Total 19 Last Release 3570d ago Major Versions v1.x-dev → v2.x-dev2015-08-03 PHP version history (2 changes)v1.0.0PHP >=5.3.1 v2.0.3PHP >=5.5.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/611de639568d4b4de299f5a46fb6a14a2adb78182c33a7609c2da285cae67b98?d=identicon)[NinoSkopac](/maintainers/NinoSkopac) --- Top Contributors [![joseconsador](https://avatars.githubusercontent.com/u/1302819?v=4)](https://github.com/joseconsador "joseconsador (179 commits)")[![miogalang](https://avatars.githubusercontent.com/u/1471573?v=4)](https://github.com/miogalang "miogalang (73 commits)")[![shanitang](https://avatars.githubusercontent.com/u/9438502?v=4)](https://github.com/shanitang "shanitang (36 commits)")[![atroche](https://avatars.githubusercontent.com/u/29839?v=4)](https://github.com/atroche "atroche (27 commits)")[![jmramos02](https://avatars.githubusercontent.com/u/3782351?v=4)](https://github.com/jmramos02 "jmramos02 (21 commits)")[![devarispbrown](https://avatars.githubusercontent.com/u/769307?v=4)](https://github.com/devarispbrown "devarispbrown (17 commits)")[![mikealmond](https://avatars.githubusercontent.com/u/600744?v=4)](https://github.com/mikealmond "mikealmond (9 commits)")[![samgavinio](https://avatars.githubusercontent.com/u/8102514?v=4)](https://github.com/samgavinio "samgavinio (9 commits)")[![dpawluk](https://avatars.githubusercontent.com/u/5264339?v=4)](https://github.com/dpawluk "dpawluk (7 commits)")[![andreionut](https://avatars.githubusercontent.com/u/1051275?v=4)](https://github.com/andreionut "andreionut (4 commits)")[![DQNEO](https://avatars.githubusercontent.com/u/188741?v=4)](https://github.com/DQNEO "DQNEO (3 commits)")[![BDav24](https://avatars.githubusercontent.com/u/5574929?v=4)](https://github.com/BDav24 "BDav24 (3 commits)")[![NinoSkopac](https://avatars.githubusercontent.com/u/1783732?v=4)](https://github.com/NinoSkopac "NinoSkopac (3 commits)")[![eski009](https://avatars.githubusercontent.com/u/811807?v=4)](https://github.com/eski009 "eski009 (3 commits)")[![chrisminett](https://avatars.githubusercontent.com/u/1084019?v=4)](https://github.com/chrisminett "chrisminett (3 commits)")[![ggrossman](https://avatars.githubusercontent.com/u/5636481?v=4)](https://github.com/ggrossman "ggrossman (3 commits)")[![antoscarface](https://avatars.githubusercontent.com/u/1921869?v=4)](https://github.com/antoscarface "antoscarface (3 commits)")[![mbrown-lw](https://avatars.githubusercontent.com/u/243889486?v=4)](https://github.com/mbrown-lw "mbrown-lw (2 commits)")[![TheFrozenFire](https://avatars.githubusercontent.com/u/948014?v=4)](https://github.com/TheFrozenFire "TheFrozenFire (1 commits)")[![danielstjules](https://avatars.githubusercontent.com/u/817212?v=4)](https://github.com/danielstjules "danielstjules (1 commits)") ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/net2grid-zendesk-api-client-php/health.svg) ``` [![Health](https://phpackages.com/badges/net2grid-zendesk-api-client-php/health.svg)](https://phpackages.com/packages/net2grid-zendesk-api-client-php) ``` ### Alternatives [neuron-core/neuron-ai The PHP Agentic Framework. 1.8k245.3k21](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)