PHPackages                             innovaat/topdesk-api - 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. innovaat/topdesk-api

ActiveLibrary[API Development](/categories/api)

innovaat/topdesk-api
====================

A PHP implementation for the TOPdesk API

v0.0.5(4y ago)334.5k↓45.5%2[1 issues](https://github.com/innovaat/topdesk-php/issues)[2 PRs](https://github.com/innovaat/topdesk-php/pulls)MITPHPPHP 7.\*|^8.0

Since Oct 3Pushed 3y ago1 watchersCompare

[ Source](https://github.com/innovaat/topdesk-php)[ Packagist](https://packagist.org/packages/innovaat/topdesk-api)[ Docs](https://github.com/innovaat/topdesk-php)[ RSS](/packages/innovaat-topdesk-api/feed)WikiDiscussions master Synced yesterday

READMEChangelog (4)Dependencies (1)Versions (9)Used By (0)

topdesk-php
===========

[](#topdesk-php)

[![Latest Stable Version](https://camo.githubusercontent.com/5d6d808351c20018ffe6fb3069835a3c3231621611fc0eca5f2059d7ec297595/68747470733a2f2f706f7365722e707567782e6f72672f696e6e6f766161742f746f706465736b2d6170692f762f737461626c65)](https://packagist.org/packages/innovaat/topdesk-api)[![Total Downloads](https://camo.githubusercontent.com/70c95b46264a311538c8edcb26226d0fe755050b0d4ffa59302dee07134a8c46/68747470733a2f2f706f7365722e707567782e6f72672f696e6e6f766161742f746f706465736b2d6170692f646f776e6c6f616473)](https://packagist.org/packages/innovaat/topdesk-api)[![License](https://camo.githubusercontent.com/5d37038e482a2d94bad36ac10bfe66ce266b2a17c11888ef5634e18e5dba008e/68747470733a2f2f706f7365722e707567782e6f72672f696e6e6f766161742f746f706465736b2d6170692f6c6963656e7365)](https://packagist.org/packages/innovaat/topdesk-api)

A PHP wrapper for the TOPdesk API.

Installation
------------

[](#installation)

```
composer require innovaat/topdesk-api

```

Guide
-----

[](#guide)

Our TOPdesk API implementation contains the following features:

- Simple login using application passwords (recommended) or tokens (legacy).
- Automatic retry functionionality that retries requests when connection errors or status codes >= 500 occur. We have experienced various instabilities with the TOPdesk API, and hopefully this minimizes these shortcomings.
- Direct function calls for much used api endpoints (`createIncident($params)`, `getIncidentById($id)`, `getListOfIncidents()`, `escalateIncidentById($id)`, `deescalateIncidentById($id)`, `getListOfDepartments()`, `createDepartment($params)`, `getListOfBranches()`, `createBranch($params)` among others).
- Easy syntax for all other endpoints using `$api->request($method, $uri, $json = [], $query = [])`.

```
// Create a new API instance, endpoint should end on "/tas/".
$api = new \Innovaat\Topdesk\Api('https://partnerships.topdesk.net/tas/');
```

Call either `useLogin` or `useApplicationPassword` depending on your authentication choice:

```
// RECOMMENDED
$api->useApplicationPassword('yourusername', 'ipsal-a7aid-6ybuq-ucjwg-axt4i');
```

```
// LEGACY LOGIN WITH TOKEN
$api->useLogin('yourusername', 'yourpassword', function($token) {
    // Callback function that receives a single parameter `$token` for you to persist.
    // It should return the persisted token as well.
    if($token) {
        file_put_contents('token.txt', $token);
    }
    return file_exists('token.txt') ? file_get_contents('token.txt') : null;
});
```

Now your API should be ready to use:

```
$incidents = $api->getListOfIncidents([
    'start' => 0,
    'page_size' => 10
]);

foreach($incidents as $incident) {
    var_dump($incident['number']);
}
```

Many requests have been implemented as direct functions of the API. However, not all of them have been implemented. For manual API requests, use the `request()` function:

```
$api->request('GET', 'api/incidents/call_types', [
    // Optional array to be sent as JSON body (for POST/PUT requests).
], [
    // Optional (search) query parameters, see API documentation for supported values.
], [
    // Optional parameters for the Guzzle request itself.
    // @see http://docs.guzzlephp.org/en/stable/request-options.html
])
```

Documentation
-------------

[](#documentation)

-
-
-

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance13

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 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 ~227 days

Total

5

Last Release

1556d ago

PHP version history (2 changes)v0.0.1PHP 7.\*

v0.0.4PHP 7.\*|^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/10498595?v=4)[Bert](/maintainers/bert-w)[@bert-w](https://github.com/bert-w)

---

Top Contributors

[![bert-w](https://avatars.githubusercontent.com/u/10498595?v=4)](https://github.com/bert-w "bert-w (5 commits)")[![marnickmenting](https://avatars.githubusercontent.com/u/10233625?v=4)](https://github.com/marnickmenting "marnickmenting (3 commits)")[![TomHermsen](https://avatars.githubusercontent.com/u/13489260?v=4)](https://github.com/TomHermsen "TomHermsen (3 commits)")

---

Tags

apiphptopdeskapitopdeskinnovaatitil

### Embed Badge

![Health badge](/badges/innovaat-topdesk-api/health.svg)

```
[![Health](https://phpackages.com/badges/innovaat-topdesk-api/health.svg)](https://phpackages.com/packages/innovaat-topdesk-api)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M47](/packages/tencentcloud-tencentcloud-sdk-php)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[resend/resend-php

Resend PHP library.

617.2M43](/packages/resend-resend-php)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

563.6M13](/packages/checkout-checkout-sdk-php)[scriptdevelop/whatsapp-manager

Paquete para manejo de WhatsApp Business API en Laravel

783.8k](/packages/scriptdevelop-whatsapp-manager)

PHPackages © 2026

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