PHPackages                             derricksmith/haloapi - 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. derricksmith/haloapi

ActiveLibrary

derricksmith/haloapi
====================

HaloApi is a PHP Wrapper for the HaloITSM API. This class supports all endpoints and methods available in the API.

031[1 PRs](https://github.com/derricksmith/HaloApi/pulls)PHP

Since Nov 30Pushed 3y ago1 watchersCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

 [ ![](https://camo.githubusercontent.com/7f7a99f3e9dbd1ac9e0acab3d373240e43de32a0909e0684ec451f7b86bafb69/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f6465727269636b736d6974682f48616c6f4170692e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/derricksmith/HaloApi/contributors) [ ![](https://camo.githubusercontent.com/b50ef328ff52f75e1c9056f84c52c1cbb19f52ede28d34885e75519f92d29e9f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f6465727269636b736d6974682f48616c6f4170692e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/derricksmith/HaloApi/network/members) [ ![](https://camo.githubusercontent.com/f81c1ca129537297969998c9aabf9d161246fa8e7dad0e58068a2e5f4d2498ca/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6465727269636b736d6974682f48616c6f4170692e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/derricksmith/HaloApi/stargazers) [ ![](https://camo.githubusercontent.com/761a13b4f1bdd01c4e4cc3a4a322d95cf81e4dc4c3c6f8aa0e5c7822c02d0a39/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6465727269636b736d6974682f48616c6f4170692e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/derricksmith/HaloApi/issues) [ ![](https://camo.githubusercontent.com/f134358de4ccfcfc0105874136fb64c974c6c0fcc3e3b7e21a6881ed8ebd3495/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6465727269636b736d6974682f48616c6f4170692e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/derricksmith/HaloApi/blob/master/LICENSE.txt) [ ![](https://camo.githubusercontent.com/d52963778220cbec61d6ed72270f9735024ffceeb551e5c3933d4e03b4694cf1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d4c696e6b6564496e2d626c61636b2e7376673f7374796c653d666f722d7468652d6261646765266c6f676f3d6c696e6b6564696e26636f6c6f72423d353535)](https://www.linkedin.com/in/derrick-smith-cissp-cism-9b355b56/)

 [ ![follow on Twitter](https://camo.githubusercontent.com/d3372efa48d6f3d626ff1198822543dee5ef07939ca952aeebcf873431ff5347/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f6465727269636b5f615f736d6974683f7374796c653d736f6369616c266c6f676f3d74776974746572)](https://twitter.com/intent/follow?screen_name=derrick_a_smith)

### HaloAPI

[](#haloapi)

HaloApi is a PHP Wrapper for the HaloITSM API. This class supports all endpoints and methods available in the API.

About The Project
-----------------

[](#about-the-project)

HaloITSM is a powerful ITIL aligned IT Service Management tool. The REST API provides access to various information in the system. This wrapper was created to make calling the HaloITSM API easier and faster.

([back to top](#readme-top))

Getting Started
---------------

[](#getting-started)

### Prerequisites

[](#prerequisites)

The PHP curl extension is required.

- php curl

Usage
-----

[](#usage)

Install with Composer

```
composer require derricksmith/haloapi:dev-main

```

\------ OR ------

Include the class in your project.

```
require HaloApi.class.php

```

Then instantiate the class with the following parameters. See the [HaloITSM API documentation](https://halo.haloservicedesk.com/apidoc/info) for more information.

client\_id client\_secret grant\_type scope host verifypeer

```
$halo = new HaloApi(array(
	'client_id' => '',
	'client_secret' => '',
	'grant_type' => '',
	'scope' => '',
	'host' => '',
	'verifypeer' => true
));

```

Then call an endpoint method in the class.

```
$request = array(
	'pageinate' => true,
	'page_size' => 50,
	'page_no' => 1,
	'columns_id' => 1,
	'includecolumns' => false,
	'ticketlinktype' => null,
	'searchactions' => null,
	'order' => 'id',
);
$tickets = $halo->getTickets($request);

```

([back to top](#readme-top))

Roadmap
-------

[](#roadmap)

- Testing all api endpoints
- Better error handling

See the [open issues](https://github.com/derricksmith/HaloApi/issues) for a full list of proposed features (and known issues).

([back to top](#readme-top))

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

[](#contributing)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

([back to top](#readme-top))

License
-------

[](#license)

Distributed under the MIT License. See `LICENSE.txt` for more information.

([back to top](#readme-top))

Contact
-------

[](#contact)

Derrick Smith - [@derrick\_a\_smith](https://twitter.com/derrick_a_smith) -

Project Link:

([back to top](#readme-top))

Acknowledgments
---------------

[](#acknowledgments)

- [Jordi Moraleda - PHP Rest Curl](https://github.com/jmoraleda/php-rest-curl)

([back to top](#readme-top))

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity24

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/13d2144256e1eeb0c9d1523d04e40de1819b9993b8c1878b61a7c0a4d58ded53?d=identicon)[derricksmith](/maintainers/derricksmith)

---

Top Contributors

[![derricksmith](https://avatars.githubusercontent.com/u/7143479?v=4)](https://github.com/derricksmith "derricksmith (25 commits)")

### Embed Badge

![Health badge](/badges/derricksmith-haloapi/health.svg)

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

PHPackages © 2026

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