Advanced Search
Search Results
110 total results found
Vendor Integrations: Marketplace & Distribution
Marketplace and distribution vendor integration endpoints
Social Media, CRM & Notifications
Social media, CRM, and notification endpoints
System Configuration & Administration
System-level configuration and administration endpoints
Quote Endpoints
Quotes & Orders QuotationHeader GET /Quotation Summary: List of QuotationHeader Returns multiple QuotationHeader records. Requires authentication. ParameterTypeDescription awaiting_approvalbooleanFilter by quotes awaiting approval client_idintegerFilter by cli...
Scheduling Endpoints
Scheduling & Time Management Appointment Appointments represent calendar events, tasks, shifts, and scheduled activities. They can be linked to tickets, clients, agents, and recurring schedules. GET /Appointment — List Appointments Returns multiple appointmen...
Ticket Endpoints
Core Tickets (Faults) Tickets in HaloPSA are referred to as "Faults" in the API. All endpoints require authentication. Faults GET /Tickets Summary: List of Faults Description: Returns multiple Fault records. Supports extensive filtering, sorting, pagination, ...
Quote Schema
Schemas QuotationHeader_View Paginated list response for quotation queries. PropertyTypeDescription page_nointegerCurrent page number page_sizeintegerRecords per page record_countintegerTotal matching records quotesarray of QuotationHeaderQuote records columns...
Integration Framework Endpoints
Integration Framework This section covers HaloPSA's integration framework — the APIs for connecting external systems, configuring integration modules, exchanging data with third-party services, and managing sync state. HaloIntegration Internal integration end...
Scheduling Schema
Schemas Appointment Core scheduling object used for appointments, tasks, shifts, meetings, and holidays. PropertyTypeDescription idintegerAppointment ID agent_idintegerAssigned agent ID agentsarray[Uname]Multiple assigned agents ticket_idintegerAssociated tick...
Faults Schema
Schemas Faults (Ticket) The core ticket object. Key fields: FieldTypeDescription idintegerTicket ID dateoccurreddate-timeDate ticket was opened summarystringTicket subject/summary detailsstringTicket details (plain text) details_htmlstringTicket details (HTML)...
Integration Framework Endpoints (cont.)
IntegrationDelta (continued) DELETE /IntegrationDelta/{id} Delete a delta record. ParameterTypeDescription idinteger (path, required)Delta record ID IntegrationError Logs errors encountered during integration sync operations. GET /IntegrationError List integ...
Contract Endpoints
Contracts Contract Supplier-side contracts. Use /SupplierContract to manage contracts with vendors and suppliers. GET /SupplierContract Summary: List of Contract Description: Returns multiple Contract records. Requires authentication. Query Parameters: NameT...
Automation Endpoints (Part 1)
Automation & Workflows Automation Automation records track the execution state of runbook/workflow automations, including retry state, execution trace, and iteration details. GET /Automation List automation execution records. Response: Automation_View Proper...
Action Endpoints
Actions Endpoints for creating, retrieving, and managing ticket actions (notes, emails, time entries, and status changes), as well as canned text (saved reply templates). Actions GET /Actions Summary: List of Actions Description: Returns multiple Actions. Req...
Contract Schema
Schemas Contract Supplier-side contract record. PropertyTypeDescription idintegerUnique contract ID. refstringContract reference number. contract_descriptionstringDescription of the contract. supplier_idintegerID of the associated supplier. supplier_namestring...
Action Endpoints (cont.)
Actions Schema (continued) Ticket Change Fields (used when the action updates the ticket): PropertyTypeDescription new_statusintegerNew ticket status ID. new_status_namestringNew ticket status name. old_statusintegerPrevious ticket status ID. new_agentintegerN...
Automation Endpoints (Part 2)
Automation & Workflows (continued) EscMsg (Notifications) — continued GET /Notifications — Query Parameters (continued) NameTypeDescription countintegerNumber of records to return newer_than_idintegerReturn only records newer than this ID older_than_idintegerR...
RMM & Security Endpoints
Vendor Integrations: RMM & Security This section covers HaloPSA's vendor integration endpoints for RMM tools, security platforms, monitoring solutions, asset management systems, identity providers, and remote session tooling. Common Pattern: *Details Resources...