PHPackages                             marqu3s/octadesk-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. marqu3s/octadesk-api

ActiveLibrary[API Development](/categories/api)

marqu3s/octadesk-api
====================

PHP client for Octadesk API.

v1.0.10(11mo ago)02411MITPHPPHP >=7.0.0

Since May 16Pushed 11mo ago1 watchersCompare

[ Source](https://github.com/marqu3s/octadesk-api)[ Packagist](https://packagist.org/packages/marqu3s/octadesk-api)[ RSS](/packages/marqu3s-octadesk-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (12)Used By (0)

octadesk-api
============

[](#octadesk-api)

PHP client for Octadesk API.

This client supports Octadesk API v0.0.1 and is prepared to support the v1.0.0.

*NOTE*: The 1.0.0 version is under development by the time this was written.

Package GuzzleHttp is used to communicate with the API.

Usage
-----

[](#usage)

To query the API v0.0.1 use `OctadeskApi::API_V0` as the parameter to the client's constructor `$version` parameter.

Use `OctadeskApi::API_V1` to query the API v1.0.0.

For v0.0.1 you must get an access token by calling LoginApi and then use this access token in all requests. Pass it to the `$apiToken` parameter in the client's constructor. See the [octadesk documentation](https://api-docs.octadesk.services/docs). The api

For v1.0.0 you must use a token generated at Octadesk API page under admin settings.

### Login

[](#login)

To get an access token for a user, query the LoginApi. The `$apiToken` must be generated at Octadesk UI in the tickets settings, integration code.

```
$subdomain = "mysubdomainatoctadesk";
$userEmail = "user@domain.com";
$apiToken = "octa.yyyyyyyyyyyy.zzzzzzzzzzzz";

$api = new LoginApi($subdomain, $userEmail);
$accessToken = $api->getAccessToken($apiToken);
```

### Tickets search

[](#tickets-search)

```
$apiUrl = "https://api.octadesk.services";
$userEmail = "user@domain.com";

# The token obtained using LoginApi (to use with v0.0.1). See above.
# Or token generated at Octadesk API page under admin settings (to use with v1.0.0)
$accessToken = "OCTADESK.xxxxxx.xxxxxxx.xxxxxxx";

$api = new TicketsApi($apiUrl, $accessToken, $userEmail, "application/json", OctadeskApi::API_V0);

# Get tickets requested by someone.
$filters = [
  [
    "property" => "requester.id",
    "operator" => OctadeskApi::FILTER_OPERATOR_EQ,
    "value" => $personOctadeskUuid,
  ],
];

$sort = ["property" => "number", "direction" => "desc"];
$page = 1;
$ticketsPerPage = 10;

$response = $api->search($filters, $sort, $page, $ticketsPerPage);
```

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance51

Moderate activity, may be stable

Popularity12

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~37 days

Recently: every ~88 days

Total

11

Last Release

347d ago

### Community

Maintainers

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

---

Top Contributors

[![marqu3s](https://avatars.githubusercontent.com/u/2284983?v=4)](https://github.com/marqu3s "marqu3s (14 commits)")

---

Tags

apibotsupporthelpticketoctadeskwhastapp

### Embed Badge

![Health badge](/badges/marqu3s-octadesk-api/health.svg)

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

###  Alternatives

[longman/telegram-bot

PHP Telegram bot

4.0k2.1M50](/packages/longman-telegram-bot)[helpscout/api

Help Scout API v2 Client

1002.1M4](/packages/helpscout-api)[bushlanov-dev/max-bot-api-client-php

Max Bot API Client library

281.6k](/packages/bushlanov-dev-max-bot-api-client-php)

PHPackages © 2026

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