HaloPSA API Reference

REST API v2 reference documentation for HaloPSA. Endpoint specs, schemas, query parameters, and integration patterns.

Core Tickets (Faults)

Fault/ticket endpoints and schemas — list, get, create, update, delete tickets

Ticket Endpoints

Core Tickets (Faults) Tickets in HaloPSA are referred to as "Faults" in the API. All endpoints re...

Faults Schema

Schemas Faults (Ticket) The core ticket object. Key fields: FieldTypeDescription idintegerTicket ...

Actions

Ticket action endpoints — notes, replies, time entries, attachments

Action Endpoints

Actions Endpoints for creating, retrieving, and managing ticket actions (notes, emails, time entr...

Action Endpoints (cont.)

Actions Schema (continued) Ticket Change Fields (used when the action updates the ticket): Proper...

Ticket Configuration

Ticket type, status, priority, category, and SLA configuration endpoints

Ticket Configuration Endpoints

Ticket Configuration This section covers the configuration endpoints for ticket types, statuses, ...

Ticket Configuration Endpoints (cont.)

Ticket Configuration (continued) RequestType Schema (continued) FieldTypeDescription fieldsarray ...

Users & Agents

User and agent management endpoints and schemas

Users & Agents Endpoints

Users & Agents Users GET /Users Summary: List of Users Description: Returns multiple Users. Requ...

Users & Agents Schema

Schemas Uname (Agent) Core agent object returned from /Agent endpoints. PropertyTypeDescription i...

Clients & Sites

Client and site management endpoints

Clients & Sites Endpoints

Clients & Sites This section covers the core organizational entities in HaloPSA: Clients (Areas),...

Clients & Sites Endpoints (cont.)

Clients & Sites (continued) Area (Client) — continued GET /Client — List Clients (continued) Para...

Invoices & Billing

Invoice and billing endpoints and schemas

Invoice Endpoints

Invoices & Billing InvoiceHeader GET /Invoice — List InvoiceHeader Returns multiple InvoiceHeader...

Invoice Schema

Schemas InvoiceHeader The core invoice object used for both standard and recurring invoices. Prop...

Quotes & Orders

Quote and order endpoints and schemas

Quote Endpoints

Quotes & Orders QuotationHeader GET /Quotation Summary: List of QuotationHeader Returns multiple ...

Quote Schema

Schemas QuotationHeader_View Paginated list response for quotation queries. PropertyTypeDescripti...

Contracts

Contract management endpoints and schemas

Contract Endpoints

Contracts Contract Supplier-side contracts. Use /SupplierContract to manage contracts with vendo...

Contract Schema

Schemas Contract Supplier-side contract record. PropertyTypeDescription idintegerUnique contract ...

Projects

Project management endpoints and schemas

Project Endpoints

Projects Projects GET /Projects Summary: List of Faults (Projects) Description: Returns multiple ...

Project Schema

Schemas Faults_View The list response wrapper for project/ticket queries. PropertyTypeDescription...

Items & Inventory

Item catalog and inventory endpoints

Items & Inventory Endpoints

Items & Inventory Item GET /Item — List Items Returns multiple Item records. Requires authentica...

Items & Inventory Endpoints (cont.)

Items & Inventory (continued) ItemStock (continued) POST /ItemStock — Create/Update Item Stock Re...

Assets & Devices

Asset and device management endpoints and schemas

Asset Endpoints

Assets & Devices Device GET /Asset — List Devices Returns multiple Device records. Requires authe...

Asset Schema

Schemas Device_View Paginated list response for GET /Asset. PropertyTypeDescription page_nointege...

Knowledge Base

Knowledge base article endpoints and schemas

Knowledge Base Endpoints

Knowledge Base KBEntry GET /KBArticle Summary: List of KBEntry Returns multiple KBEntry objects. ...

Knowledge Base Schema

Schemas KBEntry The primary KB article object used for both reads and writes. PropertyTypeDescrip...

Email & Communications

Email, mailbox, and communication endpoints

Email & Communications Endpoints

Email & Communications Mail Endpoints for processing inbound mail from various email providers v...

Email & Communications Endpoints (cont.)

Email & Communications (continued) IncomingEmail (continued) POST /incomingemail Create incoming ...

Scheduling & Time Management

Appointment, scheduling, and time entry endpoints

Scheduling Endpoints

Scheduling & Time Management Appointment Appointments represent calendar events, tasks, shifts, a...

Scheduling Schema

Schemas Appointment Core scheduling object used for appointments, tasks, shifts, meetings, and ho...

Automation & Workflows

Workflow, automation, and rule endpoints

Automation Endpoints (Part 1)

Automation & Workflows Automation Automation records track the execution state of runbook/workfl...

Automation Endpoints (Part 2)

Automation & Workflows (continued) EscMsg (Notifications) — continued GET /Notifications — Query ...

Automation Endpoints (Part 3)

Automation & Workflows (continued) Webhook (Outbound Webhooks) Outbound webhook configurations de...

Reporting & Views

Report and view configuration endpoints

Reporting & Views Endpoints

Reporting & Views ReportData GET /ReportData/{publishedid} Retrieve report data by published ID....

Reporting & Views Endpoints (cont.)

Reporting & Views (continued) ViewListGroup (continued) GET /ViewListGroup/{id} Summary: Get one ...

Security & Single Sign-On

Authentication, SSO, and security endpoints

Security & SSO Endpoints

Security & Single Sign-On SecurityCheck GET /SecurityCheck Performs a security check. GET /Secur...

Security & SSO Schema

Schemas SecurityQuestion PropertyTypeDescription idintegerQuestion ID namestringQuestion text ena...

Releases & Change Management

Release and change management endpoints

Releases & Change Endpoints

Releases & Change Management Release GET /Release List releases. Requires authentication. Paramet...

Releases & Change Schema

Schemas Release PropertyTypeDescription idintegerRelease ID namestringRelease name name_expandeds...

Chat & Collaboration

Chat and collaboration endpoints

Chat & Collaboration Endpoints

Chat & Collaboration LiveChatHeader GET /Chat Summary: List of LiveChatHeader Returns multiple Li...

Chat & Collaboration Endpoints (cont.)

Chat & Collaboration (continued) MicrosoftTeams GET /MicrosoftTeams/Get Returns Microsoft Teams i...

Integration Framework

Core integration framework endpoints

Integration Framework Endpoints

Integration Framework This section covers HaloPSA's integration framework — the APIs for connecti...

Integration Framework Endpoints (cont.)

IntegrationDelta (continued) DELETE /IntegrationDelta/{id} Delete a delta record. ParameterTypeDe...

Vendor Integrations: RMM & Security

RMM and security vendor integration endpoints

RMM & Security Endpoints

Vendor Integrations: RMM & Security This section covers HaloPSA's vendor integration endpoints fo...

RMM & Security Endpoints (cont.)

JamfDetails Jamf Pro/Jamf School Apple MDM integration. Follows the standard CRUD pattern. JamfDe...

Vendor Integrations: Accounting

Accounting vendor integration endpoints

Accounting Integration Endpoints

Vendor Integrations: Accounting This section covers the HaloPSA API endpoints for managing accoun...

Accounting Integration Endpoints (cont.)

KashflowDetails (continued) POST /KashflowDetails Summary: Create or update KashflowDetails Reque...

Vendor Integrations: Marketplace & Distribution

Marketplace and distribution vendor integration endpoints

Marketplace & Distribution Endpoints

Vendor Integrations: Marketplace & Distribution This section covers HaloPSA integrations with thi...

Marketplace & Distribution Endpoints (cont.)

DattoCommerceDetails (continued) GET /DattoCommerceDetails/{id} Get a single Datto Commerce integ...

Social Media, CRM & Notifications

Social media, CRM, and notification endpoints

Social Media & CRM Endpoints

Social Media, CRM & Notifications FacebookDetails Manage Facebook integration configurations for ...

Social Media & CRM Endpoints (cont.)

Opps (continued) GET /Opportunities (additional parameters) ParameterTypeDescription order2string...

System Configuration & Administration

System-level configuration and administration endpoints

System Config Endpoints

System Configuration & Administration This section covers system-level configuration endpoints: c...

System Config Endpoints (cont.)

Attachments & Documents Attachment File attachments on tickets, actions, and other entities. GET ...