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

ActiveLibrary[API Development](/categories/api)

fredbradley/topdesk
===================

A Laravel Service Provider for the TOPdesk API

v3.0.15(1y ago)12071[5 PRs](https://github.com/fredbradley/topdesk/pulls)MITPHPPHP ^8.0CI passing

Since Jun 7Pushed 1y ago1 watchersCompare

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

READMEChangelog (10)Dependencies (8)Versions (116)Used By (0)

TOPdesk API Service Provider
============================

[](#topdesk-api-service-provider)

[![Latest Version on Packagist](https://camo.githubusercontent.com/acef069c9d9192a586af3e5b171561ce1f2014bfdddccf5b268d5b5d3ca4e526/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f66726564627261646c65792f746f706465736b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/fredbradley/topdesk)[![Total Downloads](https://camo.githubusercontent.com/fd79b69bb8a2b67734fabd3acddf1fa223821b79dddcb2f9a1c956d81ba03244/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f66726564627261646c65792f746f706465736b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/fredbradley/topdesk)[![StyleCI Status](https://camo.githubusercontent.com/1c5a9690af51d2e6d4247acf572c3557dfe4230210f3885b0a546a08232dfafd/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3237303434343635312f736869656c64)](https://camo.githubusercontent.com/1c5a9690af51d2e6d4247acf572c3557dfe4230210f3885b0a546a08232dfafd/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3237303434343635312f736869656c64)

This is a TOPdesk API wrapper for Laravel. Using Laravel's HTTP Facade. Please check out the [Version 1 releases](https://github.com/fredbradley/topdesk/tree/v1.2.15) if you do not use Laravel, or the original package from [Innovaat](https://github.com/innovaat/topdesk-php).

Minimum Requirements
--------------------

[](#minimum-requirements)

- PHP 8.0 or higher

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

[](#installation)

Via Composer

```
$ composer require fredbradley/topdesk
```

Set up
------

[](#set-up)

Ensure you understand the TOPdesk API configuration and your TOPdesk environment is set up to use the API. More details can be found at [developers.topdesk.com](https://developers.topdesk.com/tutorial.html#:~:text=To%20create%20an%20Application%20password,in%20the%20Application%20passwords%20block.&text=In%20addition%20to%20a%20name,be%20set%20for%20the%20password.).

Add three variables to your `.env` file

```
TOPdesk_endpoint="" # Your TOPdesk url, ending in "`tas/`"
TOPdesk_app_username="" # Your username you wish to authenticate with
TOPdesk_app_password="" # Your application password for that username.
```

Guide
-----

[](#guide)

Our TOPdesk API implementation contains the following features:

- Simple login using application passwords.
- Automatic retry functionality 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 = [])`.

Now your API should be ready to use:

```
$incidents = TOPDesk::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:

```
TOPDesk::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)

-

Change log
----------

[](#change-log)

Please see the [changelog](changelog.md) for more information on what has changed recently.

Testing
-------

[](#testing)

```
$ composer test
```

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

[](#contributing)

Please see [CONTRIBUTING.md](contributing.md) for details and a todolist.

Security
--------

[](#security)

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits
-------

[](#credits)

- [Fred Bradley](https://www.fredbradley.uk) - Laravel Wrapper
- [Innovaat](https://github.com/innovaat/topdesk-php) - Initial TOPdesk API PHP Wrapper

License
-------

[](#license)

MIT. Please see the [license file](LICENSE.md) for more information.

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance47

Moderate activity, may be stable

Popularity14

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity77

Established project with proven stability

 Bus Factor1

Top contributor holds 91.6% of commits — single point of failure

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

Recently: every ~67 days

Total

109

Last Release

397d ago

Major Versions

v1.3.1 → v2.0.02023-03-07

v2.0.34 → 3.0.02023-09-15

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1639226?v=4)[Fred Bradley](/maintainers/fredbradley)[@fredbradley](https://github.com/fredbradley)

---

Top Contributors

[![fredbradley](https://avatars.githubusercontent.com/u/1639226?v=4)](https://github.com/fredbradley "fredbradley (152 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (14 commits)")

---

Tags

laraveltopdesk

###  Code Quality

TestsPHPUnit

Code StyleLaravel Pint

### Embed Badge

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

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

###  Alternatives

[andreaselia/laravel-api-to-postman

Generate a Postman collection automatically from your Laravel API

1.0k586.2k3](/packages/andreaselia-laravel-api-to-postman)[mollie/laravel-mollie

Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite

3624.1M28](/packages/mollie-laravel-mollie)[api-ecosystem-for-laravel/dingo-api

A RESTful API package for the Laravel and Lumen frameworks.

3121.5M10](/packages/api-ecosystem-for-laravel-dingo-api)[essa/api-tool-kit

set of tools to build an api with laravel

52680.5k](/packages/essa-api-tool-kit)[mll-lab/laravel-graphiql

Easily integrate GraphiQL into your Laravel project

683.2M9](/packages/mll-lab-laravel-graphiql)[kirschbaum-development/laravel-openapi-validator

Automatic OpenAPI validation for Laravel HTTP tests

581.1M5](/packages/kirschbaum-development-laravel-openapi-validator)

PHPackages © 2026

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