HaloAPI
1.3.0-Beta1
This module provides an interface to the Halo API.
Minimum PowerShell version
7.0
See the version list below for details.
Installation Options
Owners
Copyright
(c) 2021 Mikey O'Toole & Luke Whitelock. All rights reserved.
Package Details
Author(s)
- Mikey O'Toole / Luke Whitelock
Tags
HaloPSA PSA Halo API HaloServiceSolutions HaloITSM HaloServiceDesk ITSM Service Desk REST MSP Automation
Functions
Connect-HaloAPI Get-HaloAction Get-HaloAgent Get-HaloAppointment Get-HaloAsset Get-HaloAttachment Get-HaloClient Get-HaloContract Get-HaloCustomButton Get-HaloField Get-HaloInvoice Get-HaloItem Get-HaloKBArticle Get-HaloLookup Get-HaloOpportunity Get-HaloProject Get-HaloPurchaseOrder Get-HaloQuote Get-HaloRelease Get-HaloReport Get-HaloSalesOrder Get-HaloService Get-HaloSite Get-HaloStatus Get-HaloSupplier Get-HaloTeam Get-HaloObjectTemplate Get-HaloTicket Get-HaloTicketType Get-HaloTimesheet Get-HaloUser New-HaloAction New-HaloAgent New-HaloAppointment New-HaloAsset New-HaloAttachment New-HaloClient New-HaloContract New-HaloInvoice New-HaloItem New-HaloKBArticle New-HaloOpportunity New-HaloProject New-HaloQuote New-HaloReport New-HaloSite New-HaloStatus New-HaloSupplier New-HaloTeam New-HaloTicket New-HaloTicketType New-HaloUser Set-HaloAction Set-HaloAgent Set-HaloAppointment Set-HaloAsset Set-HaloAttachment Set-HaloClient Set-HaloContract Set-HaloInvoice Set-HaloItem Set-HaloKBArticle Set-HaloOpportunity Set-HaloProject Set-HaloQuote Set-HaloReport Set-HaloSite Set-HaloStatus Set-HaloSupplier Set-HaloTeam Set-HaloTicket Set-HaloTicketType Set-HaloUser Remove-HaloAction Remove-HaloTicket
Dependencies
This module has no dependencies.
Release Notes
Add an `-AuthPath` parameter to Connect-HaloAPI for non-standard authentication routes.
FileList
- HaloAPI.nuspec
- CHANGELOG.md
- HaloAPI.psd1
- HaloAPI.psm1
- LICENSE.md
- README.md
- Classes\HaloAuth.psm1
- Classes\HaloCustomButton.psm1
- Classes\HaloLookup.psm1
- Classes\Completers\HaloAuthScopesCompleter.psm1
- Classes\Completers\HaloCustomButtonCompleter.psm1
- Classes\Completers\HaloLookupCompleter.psm1
- Classes\Validators\HaloAuthScopesValidator.psm1
- Classes\Validators\HaloCustomButtonValidator.psm1
- Classes\Validators\HaloLookupValidator.psm1
- Data\Templates\Action.json
- Data\Templates\Agent.json
- Data\Templates\Appointment.json
- Data\Templates\Asset.json
- Data\Templates\Attachment.json
- Data\Templates\Client.json
- Data\Templates\Contract.json
- Data\Templates\CustomButton.json
- Data\Templates\Invoice.json
- Data\Templates\Item.json
- Data\Templates\KBArticle.json
- Data\Templates\Opportunity.json
- Data\Templates\Project.json
- Data\Templates\Quote.json
- Data\Templates\Report.json
- Data\Templates\Site.json
- Data\Templates\Status.json
- Data\Templates\Supplier.json
- Data\Templates\Team.json
- Data\Templates\Ticket.json
- Data\Templates\TicketType.json
- Data\Templates\User.json
- Private\Get-HaloNullObject.ps1
- Private\Get-TokenExpiry.ps1
- Private\Invoke-HaloPreFlightChecks.ps1
- Private\Invoke-HaloRequest.ps1
- Private\New-HaloDELETERequest.ps1
- Private\New-HaloErrorRecord.ps1
- Private\New-HaloGETRequest.ps1
- Private\New-HaloPOSTRequest.ps1
- Private\New-HaloQuery.ps1
- Private\Write-Success.ps1
- Public\Connect-HaloAPI.ps1
- Public\Get\Get-HaloAction.ps1
- Public\Get\Get-HaloAgent.ps1
- Public\Get\Get-HaloAppointment.ps1
- Public\Get\Get-HaloAsset.ps1
- Public\Get\Get-HaloAttachment.ps1
- Public\Get\Get-HaloClient.ps1
- Public\Get\Get-HaloContract.ps1
- Public\Get\Get-HaloCustomButton.ps1
- Public\Get\Get-HaloField.ps1
- Public\Get\Get-HaloInvoice.ps1
- Public\Get\Get-HaloItem.ps1
- Public\Get\Get-HaloKBArticle.ps1
- Public\Get\Get-HaloLookup.ps1
- Public\Get\Get-HaloObjectTemplate.ps1
- Public\Get\Get-HaloOpportunity.ps1
- Public\Get\Get-HaloProject.ps1
- Public\Get\Get-HaloPurchaseOrder.ps1
- Public\Get\Get-HaloQuote.ps1
- Public\Get\Get-HaloRelease.ps1
- Public\Get\Get-HaloReport.ps1
- Public\Get\Get-HaloSalesOrder.ps1
- Public\Get\Get-HaloService.ps1
- Public\Get\Get-HaloSite.ps1
- Public\Get\Get-HaloStatus.ps1
- Public\Get\Get-HaloSupplier.ps1
- Public\Get\Get-HaloTeam.ps1
- Public\Get\Get-HaloTicket.ps1
- Public\Get\Get-HaloTicketType.ps1
- Public\Get\Get-HaloTimesheet.ps1
- Public\Get\Get-HaloUser.ps1
- Public\New\New-HaloAction.ps1
- Public\New\New-HaloAgent.ps1
- Public\New\New-HaloAppointment.ps1
- Public\New\New-HaloAsset.ps1
- Public\New\New-HaloAttachment.ps1
- Public\New\New-HaloClient.ps1
- Public\New\New-HaloContract.ps1
- Public\New\New-HaloCustomButton.ps1
- Public\New\New-HaloInvoice.ps1
- Public\New\New-HaloItem.ps1
- Public\New\New-HaloKBArticle.ps1
- Public\New\New-HaloOpportunity.ps1
- Public\New\New-HaloProject.ps1
- Public\New\New-HaloQuote.ps1
- Public\New\New-HaloReport.ps1
- Public\New\New-HaloSite.ps1
- Public\New\New-HaloStatus.ps1
- Public\New\New-HaloSupplier.ps1
- Public\New\New-HaloTeam.ps1
- Public\New\New-HaloTicket.ps1
- Public\New\New-HaloTicketType.ps1
- Public\New\New-HaloUser.ps1
- Public\Remove\Remove-HaloAction.ps1
- Public\Remove\Remove-HaloTicket.ps1
- Public\Set\Set-HaloAction.ps1
- Public\Set\Set-HaloAgent.ps1
- Public\Set\Set-HaloAppointment.ps1
- Public\Set\Set-HaloAsset.ps1
- Public\Set\Set-HaloAttachment.ps1
- Public\Set\Set-HaloClient.ps1
- Public\Set\Set-HaloContract.ps1
- Public\Set\Set-HaloCustomButton.ps1
- Public\Set\Set-HaloInvoice.ps1
- Public\Set\Set-HaloItem.ps1
- Public\Set\Set-HaloKBArticle.ps1
- Public\Set\Set-HaloOpportunity.ps1
- Public\Set\Set-HaloProject.ps1
- Public\Set\Set-HaloQuote.ps1
- Public\Set\Set-HaloReport.ps1
- Public\Set\Set-HaloSite.ps1
- Public\Set\Set-HaloStatus.ps1
- Public\Set\Set-HaloSupplier.ps1
- Public\Set\Set-HaloTeam.ps1
- Public\Set\Set-HaloTicket.ps1
- Public\Set\Set-HaloTicketType.ps1
- Public\Set\Set-HaloUser.ps1
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 1.26.0 | 279 | 10/12/2026 |
| 1.25.2 | 322 | 9/28/2026 |
| 1.25.1 | 367 | 9/10/2026 |
| 1.25.0-beta1 | 10 | 8/27/2026 |
| 1.24.0-beta1 | 21 | 6/1/2026 |
| 1.23.3 | 7,865 | 4/30/2026 |
| 1.23.1 | 15 | 4/29/2026 |
| 1.23.0 | 7,498 | 4/26/2026 |
| 1.22.1 | 212,430 | 8/1/2024 |
| 1.22.0 | 10,674 | 7/11/2024 |
| 1.21.2 | 2,848 | 7/5/2024 |
| 1.21.1 | 514 | 7/4/2024 |
| 1.21.0 | 49 | 7/4/2024 |
| 1.20.0 | 88,544 | 1/12/2024 |
| 1.19.0 | 56 | 1/12/2024 |
| 1.18.0 | 3,848 | 1/4/2024 |
| 1.17.0 | 7,268 | 12/19/2023 |
| 1.16.0 | 15,627 | 11/17/2023 |
| 1.15.0 | 11,707 | 10/23/2023 |
| 1.14.1 | 85,340 | 4/4/2023 |
| 1.14.0 | 5,306 | 3/10/2023 |
| 1.13.2 | 5,316 | 1/1/2023 |
| 1.13.1 | 613 | 1/1/2023 |
| 1.13.0 | 3,717 | 11/18/2022 |
| 1.12.0-Beta4 | 5,906 | 10/3/2022 |
| 1.12.0-Beta3 | 236 | 10/2/2022 |
| 1.12.0-Beta2 | 26 | 10/2/2022 |
| 1.11.1 | 5,662 | 9/16/2022 |
| 1.11.0-Beta2 | 7,289 | 8/22/2022 |
| 1.11.0-Beta1 | 2,354 | 8/16/2022 |
| 1.10.1 | 18,898 | 7/2/2022 |
| 1.10.0 | 158 | 7/1/2022 |
| 1.10.0-Beta3 | 313 | 6/30/2022 |
| 1.10.0-Beta2 | 65 | 6/30/2022 |
| 1.10.0-Beta1 | 181 | 6/28/2022 |
| 1.9.1 | 1,075 | 6/21/2022 |
| 1.9.1-Beta7 | 25 | 6/21/2022 |
| 1.9.1-Beta4 | 24 | 6/8/2022 |
| 1.9.1-Beta3 | 21 | 6/2/2022 |
| 1.9.1-Beta2 | 21 | 6/2/2022 |
| 1.9.1-Beta1 | 23 | 3/29/2022 |
| 1.9.0 | 5,673 | 3/23/2022 |
| 1.9.0-Beta4 | 120 | 3/23/2022 |
| 1.9.0-Beta3 | 22 | 3/20/2022 |
| 1.9.0-Beta2 | 19 | 3/16/2022 |
| 1.9.0-beta1 | 22 | 3/15/2022 |
| 1.8.0 | 233 | 3/15/2022 |
| 1.7.0 | 979 | 2/6/2022 |
| 1.7.0-Beta1 | 29 | 2/3/2022 |
| 1.5.0 | 535 | 1/4/2022 |
| 1.4 | 316 | 11/11/2021 |
| 1.3.2 | 857 | 10/1/2021 |
| 1.3.1 | 21 | 10/1/2021 |
| 1.3.0-Beta5 | 28 | 9/3/2021 |
| 1.3.0-Beta4 | 22 | 8/25/2021 |
| 1.3.0-Beta3 | 20 | 8/25/2021 |
| 1.3.0-Beta2 | 21 | 8/25/2021 |
| 1.3.0-Beta1 (current version) | 20 | 8/25/2021 |
| 1.2.3 | 52 | 8/24/2021 |
| 1.2.2 | 21 | 8/24/2021 |
| 1.2.1 | 77 | 8/23/2021 |
| 1.2.0 | 29 | 8/22/2021 |
| 1.1.0 | 574 | 8/12/2021 |
| 1.0.2 | 43 | 8/11/2021 |
| 1.0.1 | 26 | 8/10/2021 |