PHPackages                             webnuvola/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. webnuvola/zendesk\_api\_client\_php

Abandoned → [zendesk/zendesk\_api\_client\_php](/?search=zendesk%2Fzendesk_api_client_php)ArchivedLibrary

webnuvola/zendesk\_api\_client\_php
===================================

PHP Client for Zendesk REST API. See https://developer.zendesk.com/rest\_api/docs/core/introduction .

v2.2.9(5y ago)03.9kApache-2.0PHPPHP >=5.5.0

Since Jan 14Pushed 5y agoCompare

[ Source](https://github.com/Webnuvola/zendesk_api_client_php)[ Packagist](https://packagist.org/packages/webnuvola/zendesk_api_client_php)[ Docs](https://github.com/zendesk/zendesk_api_client_php)[ RSS](/packages/webnuvola-zendesk-api-client-php/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (7)Versions (39)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)

To install run `composer require zendesk/zendesk_api_client_php`

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

// Get all tickets regarding a specific user.
$tickets = $client->users($requesterId)->tickets()->requested();
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);

// Get all users
$users = $client->users()->findAll();
print_r($users);
```

### 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
]);
```

Attaching files to comments

```
$ticket = $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.',
        'uploads'   => [$attachment->upload->token]
    ]
]);
```

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

### Retrying Requests

[](#retrying-requests)

Add the `RetryHandler` middleware on the `HandlerStack` of your `GuzzleHttp\Client` instance. By default `Zendesk\Api\HttpClient`retries:

- timeout requests
- those that throw `Psr\Http\Message\RequestInterface\ConnectException:class`
- and those that throw `Psr\Http\Message\RequestInterface\RequestException:class` that are identified as ssl issue.

#### Available options

[](#available-options)

Options are passed on `RetryHandler` as an array of values.

- max = 2 *limit of retries*
- interval = 300 *base delay between retries in milliseconds*
- max\_interval = 20000 *maximum delay value*
- backoff\_factor = 1 *backoff factor*
- exceptions = \[ConnectException::class\] *Exceptions to retry without checking retry\_if*
- retry\_if = null *callable function that can decide whether to retry the request or not*

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

[](#contributing)

Pull Requests are always welcome but before you send one please read our [contribution guidelines](#CONTRIBUTING.md). It would speed up the process and would make sure that everybody follows the community's standard.

### Debugging

[](#debugging)

To help would be contributors, we've added a REPL tool. It is a simple wrapper for [psysh](http://psysh.org) and symfony's console. On your terminal, run `bin/console   `. This would automatically create an instance of `Zendesk\API\HttpClient` on $client variable. After that you would be able to enter any valid php statement. The goal of the tool is to speed up the process in which developers can experiment on the code base.

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

34

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor3

3 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 ~57 days

Recently: every ~242 days

Total

37

Last Release

2053d ago

Major Versions

v1.2.0 → 2.0.0-beta2015-08-03

v1.2.1 → v2.2.82018-11-09

PHP version history (2 changes)v1.0.0PHP >=5.3.1

v2.0.3PHP >=5.5.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/bee6fac3ff235d06469b2a8a3afa880ec3e48807f520fa2b98fb9f8a761bcc16?d=identicon)[fab120](/maintainers/fab120)

---

Top Contributors

[![joseconsador](https://avatars.githubusercontent.com/u/1302819?v=4)](https://github.com/joseconsador "joseconsador (207 commits)")[![miogalang](https://avatars.githubusercontent.com/u/1471573?v=4)](https://github.com/miogalang "miogalang (76 commits)")[![samgavinio](https://avatars.githubusercontent.com/u/8102514?v=4)](https://github.com/samgavinio "samgavinio (52 commits)")[![kcasas](https://avatars.githubusercontent.com/u/1477171?v=4)](https://github.com/kcasas "kcasas (40 commits)")[![shanitang](https://avatars.githubusercontent.com/u/9438502?v=4)](https://github.com/shanitang "shanitang (36 commits)")[![jmramos02](https://avatars.githubusercontent.com/u/3782351?v=4)](https://github.com/jmramos02 "jmramos02 (29 commits)")[![atroche](https://avatars.githubusercontent.com/u/29839?v=4)](https://github.com/atroche "atroche (27 commits)")[![ghermans](https://avatars.githubusercontent.com/u/1594411?v=4)](https://github.com/ghermans "ghermans (18 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)")[![dpawluk](https://avatars.githubusercontent.com/u/5264339?v=4)](https://github.com/dpawluk "dpawluk (7 commits)")[![shershennm](https://avatars.githubusercontent.com/u/1130311?v=4)](https://github.com/shershennm "shershennm (7 commits)")[![andreionut](https://avatars.githubusercontent.com/u/1051275?v=4)](https://github.com/andreionut "andreionut (4 commits)")[![Lobaster](https://avatars.githubusercontent.com/u/18539158?v=4)](https://github.com/Lobaster "Lobaster (4 commits)")[![TheMelter](https://avatars.githubusercontent.com/u/2617310?v=4)](https://github.com/TheMelter "TheMelter (4 commits)")[![jaydiablo](https://avatars.githubusercontent.com/u/136907?v=4)](https://github.com/jaydiablo "jaydiablo (3 commits)")[![DQNEO](https://avatars.githubusercontent.com/u/188741?v=4)](https://github.com/DQNEO "DQNEO (3 commits)")[![cmourizard](https://avatars.githubusercontent.com/u/295190?v=4)](https://github.com/cmourizard "cmourizard (3 commits)")[![nogates](https://avatars.githubusercontent.com/u/6021597?v=4)](https://github.com/nogates "nogates (3 commits)")[![armen](https://avatars.githubusercontent.com/u/6529?v=4)](https://github.com/armen "armen (3 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/webnuvola-zendesk-api-client-php/health.svg)

```
[![Health](https://phpackages.com/badges/webnuvola-zendesk-api-client-php/health.svg)](https://phpackages.com/packages/webnuvola-zendesk-api-client-php)
```

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k20](/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

255.2k](/packages/aedart-athenaeum)

PHPackages © 2026

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