Search Results

Reporting & Views ReportData GET /ReportData/{publishedid} Retrieve report data by published ID. Used for accessing publicly published reports. ParameterTypeRequiredDescription publishedidstringYes (path)The published report identifier ReportRepository GET ...

JamfDetails Jamf Pro/Jamf School Apple MDM integration. Follows the standard CRUD pattern. JamfDetails Schema FieldTypeDescription idintegerRecord ID urlstringJamf server URL usernamestringAPI username new_passwordstringAPI password (write-only) new_integratio...

Ticket Configuration (continued) RequestType Schema (continued) FieldTypeDescription fieldsarray of RequestTypeFieldCustom fields configured for this type allowed_teamsarrayTeams allowed for this ticket type allowed_statusarrayStatuses available for this ticke...

Schemas Faults_View The list response wrapper for project/ticket queries. PropertyTypeDescription page_nointegerCurrent page number (when paginating) page_sizeintegerPage size (when paginating) record_countintegerTotal record count ticketsarray of Faults_ListT...

Reporting & Views (continued) ViewListGroup (continued) GET /ViewListGroup/{id} Summary: Get one ViewListGroup Returns a single ViewListGroup instance. Requires authentication. ParameterTypeRequiredDescription idintegerYes (path)The group ID includedetailsbool...

Vendor Integrations: Accounting This section covers the HaloPSA API endpoints for managing accounting software integrations, including Xero, QuickBooks, Sage Business Cloud, MYOB, Kashflow, Fortnox, Exact, Business Central, and Avalara. XeroDetails GET /XeroD...

Security & Single Sign-On SecurityCheck GET /SecurityCheck Performs a security check. GET /SecurityCheck/oldencryption Performs a security check using old encryption. SecurityQuestion GET /SecurityQuestion List all security questions. POST /SecurityQuestion ...

Items & Inventory Item GET /Item — List Items Returns multiple Item records. Requires authentication. ParameterTypeDescription activeinactivestringFilter on active/inactive items — comma separated, first value true/false for active, second for inactive advanc...

Users & Agents Users GET /Users Summary: List of Users Description: Returns multiple Users. Requires authentication. Query Parameters: NameTypeDescription activeinactivestringTwo comma-separated values: first sets includeactive, second sets includeinactive ad...

KashflowDetails (continued) POST /KashflowDetails Summary: Create or update KashflowDetails Request Body: Array of KashflowDetails objects (see schema below) GET /KashflowDetails/{id} Summary: Get one KashflowDetails Description: Returns a single KashflowDeta...

Schemas SecurityQuestion PropertyTypeDescription idintegerQuestion ID namestringQuestion text enabledbooleanWhether the question is active answerstringAnswer to the question _warningstringWarning message if applicable NPR_Result Used for security question val...

Schemas Uname (Agent) Core agent object returned from /Agent endpoints. PropertyTypeDescription idintegerAgent ID namestringDisplay name firstnamestringFirst name surnamestringSurname initialsstringInitials emailstringEmail address jobtitlestringJob title team...

Items & Inventory (continued) ItemStock (continued) POST /ItemStock — Create/Update Item Stock Request body: array of ItemStock objects. GET /ItemStock/{id} — Get One Item Stock Record Returns a single ItemStock record. Requires authentication. ParameterTypeDe...

Vendor Integrations: Marketplace & Distribution This section covers HaloPSA integrations with third-party distribution and marketplace vendors including Pax8, Ingram Micro, Synnex, Arrow Sphere, StreamOne Ion, Tech Data, Datto Commerce, Adobe Commerce, Microso...

Releases & Change Management Release GET /Release List releases. Requires authentication. ParameterTypeDescription countintegerNumber of records to return include_devops_projectbooleanInclude DevOps project details includenotecountbooleanInclude release note c...

Schemas Release PropertyTypeDescription idintegerRelease ID namestringRelease name name_expandedstringExpanded release name releasetype_idintegerRelease type ID releasetype_namestringRelease type name branch_idintegerBranch ID branch_namestringBranch name whor...

Clients & Sites This section covers the core organizational entities in HaloPSA: Clients (Areas), Sites, Companies (Suppliers), Organisations, and related resources like CRM Notes, Popup Notes, and Service Subscriptions. Company (Supplier) Represents supplier...

Assets & Devices Device GET /Asset — List Devices Returns multiple Device records. Requires authentication. Query Parameters NameTypeDescription activeinactivestringFilter on active/inactive assets — comma-separated, first value true/false for active, second f...