PHPackages                             wowmaking/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. [API Development](/categories/api)
4. /
5. wowmaking/zendesk\_api\_client\_php

ActiveLibrary[API Development](/categories/api)

wowmaking/zendesk\_api\_client\_php
===================================

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

04PHP

Since Dec 29Pushed 2y agoCompare

[ Source](https://github.com/wowmaking/zendesk_api_client_php)[ Packagist](https://packagist.org/packages/wowmaking/zendesk_api_client_php)[ RSS](/packages/wowmaking-zendesk-api-client-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

THIS REPOSITORY IS NO LONGER SUPPORTED
======================================

[](#this-repository-is-no-longer-supported)

Zendesk PHP API Client Library
==============================

[](#zendesk-php-api-client-library)

[![CI](https://github.com/zendesk/zendesk_api_client_php/actions/workflows/ci.yaml/badge.svg)](https://github.com/zendesk/zendesk_api_client_php/actions/workflows/ci.yaml/badge.svg)[![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 7.4+

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)

Methods like `findAll()` call the API without any pagination parameter. If an endpoint supports pagination, only the first page will be returned. To fetch all resources, you need to make multiple API calls.

#### Iterator (recommended)

[](#iterator-recommended)

The use of the correct type of pagination is encapsulated using an iterator, which allows you to retrieve all resources in all pages, making multiple API calls, without having to worry about pagination at all:

```
$iterator = $client->tickets()->iterator();

foreach ($iterator as $ticket) {
    echo($ticket->id . " ");
}
```

If you want a specific sort order, please refer to the sorting section in the documentation ([Tickets, for example](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#sorting)).

##### Iterator with params example

[](#iterator-with-params-example)

```
$params = ['my' => 'param1', 'extra' => 'param2'];
$iterator = $client->tickets()->iterator($params);

foreach ($iterator as $ticket) {
    echo($ticket->id . " ");
}
```

- Change page size with: `$params = ['page[size]' => 5];`
- Change sorting with: `$params = ['sort' => '-updated_at'];`
    - Refer to the docs for details, including allowed sort fields
- Combine everything: `$params = ['page[size]' => 2, 'sort' => 'updated_at', 'extra' => 'param'];`

**Note**:

- Refer to the documentation for the correct params for sorting with the pagination type you're using
- The helper method `iterator_to_array` doesn't work with this implementation

##### Iterator API call response

[](#iterator-api-call-response)

The latest response is exposed in the iterator at `$iterator->latestResponse()`. This could come handy for debugging.

##### Custom iterators

[](#custom-iterators)

If you want to use the iterator for custom methods, as opposed to the default `findAll()`, you can create an iterator for your collection:

```
$strategy = new CbpStrategy( // Or ObpStrategy or SinglePageStrategy
    "resources_key", // The root key with resources in the response, usually plural and in underscore
    [], // Extra params for your call
);
$iterator = PaginationIterator($client->tickets(), $strategy);
foreach ($ticketsIterator as $ticket) {
    // Use as normal
}
```

This can be useful for filter endpoints like [active automations](https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#list-active-automations). However, in this common case where you only need to change the method from `findAll()` to `findActive()` there's a better shortcut:

```
$iterator = $client->automations()->iterator($params, 'findActive');
```

Which is analogous to:

```
use Zendesk\API\Traits\Utility\Pagination\PaginationIterator;
use Zendesk\API\Traits\Utility\Pagination\CbpStrategy;
$strategy = new CbpStrategy('automations', $params);
$iterator = new PaginationIterator(
    $client->automations(),
    $strategy,
    'findActive'
);
```

See how the [Pagination Trait](src/Zendesk/API/Traits/Resource/Pagination.php) is used if you need more custom implementations.

##### Catching API errors

[](#catching-api-errors)

This doesn't change too much:

```
try {
    foreach ($iterator as $ticket) {
        // your code
    }
} catch (ApiResponseException $e) {
    $errorMessage = $e->getMessage();
    $errorDetails = $e=>getErrorDetails();
}
```

If you need to know at what point you got the error, you can store the required information inside the loop in your code.

#### FindAll using CBP (fine)

[](#findall-using-cbp-fine)

If you still want use `findAll()`, until CBP becomes the default API response, you must explicitly request CBP responses by using the param `page[size]`.

```
// CBP: /path?page[size]=100
$response = $client->tickets()->findAll(['page[size]' => 100]);
process($response->tickets); // Your implementation
do {
    if ($response->meta->has_more) {
        // CBP: /path?page[after]=cursor
        $response = $client->tickets()->findAll(['page[after]' => $response->meta->after_cursor]);
        process($response->tickets);
    }
} while ($response->meta->has_more);
```

**Process data *immediately* upon fetching**. This optimizes memory usage, enables real-time processing, and helps adhere to API rate limits, enhancing efficiency and user experience.

#### Find All using OBP (only recommended if the endpoint doesn't support CBP)

[](#find-all-using-obp-only-recommended-if-the-endpoint-doesnt-support-cbp)

If CBP is not available, this is how you can fetch one page at a time:

```
$pageSize = 100;
$pageNumber = 1;
do {
    // OBP: /path?per_page=100&page=2
    $response = $client->tickets()->findAll(['per_page' => $pageSize, 'page' => $pageNumber]);
    process($response->tickets); // Your implementation
    $pageNumber++;
} while (count($response->tickets) == $pageSize);
```

**Process data *immediately* upon fetching**. This optimizes memory usage, enables real-time processing, and helps adhere to API rate limits, enhancing efficiency and user experience.

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

#### REPL

[](#repl)

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.

#### HTTP client print API calls

[](#http-client-print-api-calls)

You can print a line with details about every API call with:

```
$client = new ZendeskAPI($subdomain);
$client->log_api_calls = true;
```

#### HTTP client debug

[](#http-client-debug)

You can inspect this object for info about requests and responses:

```
$client->getDebug();
```

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

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity20

Early-stage or recently created project

 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.

### Community

Maintainers

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

---

Top Contributors

[![joseconsador](https://avatars.githubusercontent.com/u/1302819?v=4)](https://github.com/joseconsador "joseconsador (207 commits)")[![ecoologic](https://avatars.githubusercontent.com/u/426590?v=4)](https://github.com/ecoologic "ecoologic (92 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)")[![7ail](https://avatars.githubusercontent.com/u/26154804?v=4)](https://github.com/7ail "7ail (13 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)")[![TheMelter](https://avatars.githubusercontent.com/u/2617310?v=4)](https://github.com/TheMelter "TheMelter (4 commits)")[![thekindofme](https://avatars.githubusercontent.com/u/53257?v=4)](https://github.com/thekindofme "thekindofme (4 commits)")[![Lobaster](https://avatars.githubusercontent.com/u/18539158?v=4)](https://github.com/Lobaster "Lobaster (4 commits)")[![yoshdog](https://avatars.githubusercontent.com/u/5410975?v=4)](https://github.com/yoshdog "yoshdog (3 commits)")[![antoscarface](https://avatars.githubusercontent.com/u/1921869?v=4)](https://github.com/antoscarface "antoscarface (3 commits)")

### Embed Badge

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

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

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