Advanced Search
Search Results
110 total results found
Releases & Change Schema
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 Endpoints
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...
Asset Endpoints
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...
Marketplace & Distribution Endpoints (cont.)
DattoCommerceDetails (continued) GET /DattoCommerceDetails/{id} Get a single Datto Commerce integration. Returns a single instance of DattoCommerceDetails. Requires authentication. ParameterTypeRequiredDescription idintegerYes (path)Record ID includedetailsboo...
Chat & Collaboration Endpoints
Chat & Collaboration LiveChatHeader GET /Chat Summary: List of LiveChatHeader Returns multiple LiveChatHeader objects. Requires authentication. ParameterTypeDescription afterstringCursor for pagination chatprofile_idstringFilter by chat profile ID checkavailab...
Asset Schema
Schemas Device_View Paginated list response for GET /Asset. PropertyTypeDescription page_nointegerCurrent page number. page_sizeintegerNumber of records per page. record_countinteger (int64)Total number of matching records. assetsarray[Device_List]Array of ass...
Clients & Sites Endpoints (cont.)
Clients & Sites (continued) Area (Client) — continued GET /Client — List Clients (continued) ParameterTypeDescription idonlybooleanReturn only Area IDs (not compatible with pagination) includeactivebooleanInclude active clients includeazuretenantsbooleanInclud...
Chat & Collaboration Endpoints (cont.)
Chat & Collaboration (continued) MicrosoftTeams GET /MicrosoftTeams/Get Returns Microsoft Teams integration configuration. No query parameters. MicrosoftTeamsMapping GET /MicrosoftTeamsMapping Returns all Microsoft Teams channel mappings. No query parameters....
Social Media & CRM Endpoints
Social Media, CRM & Notifications FacebookDetails Manage Facebook integration configurations for creating tickets from Messenger messages, posts, ratings, and ads. GET /FacebookDetails Summary: List of FacebookDetails Returns multiple FacebookDetails. Requires...
Knowledge Base Endpoints
Knowledge Base KBEntry GET /KBArticle Summary: List of KBEntry Returns multiple KBEntry objects. Requires authentication. Query Parameters: NameTypeDescription activeinactivestringFilter on active/inactive assets — comma separated, first value true or false fo...
Knowledge Base Schema
Schemas KBEntry The primary KB article object used for both reads and writes. PropertyTypeDescription idintegerUnique KB article ID. namestringArticle title. descriptionstringArticle body/description (plain text). description_htmlstringArticle description in H...
Invoice Endpoints
Invoices & Billing InvoiceHeader GET /Invoice — List InvoiceHeader Returns multiple InvoiceHeader records. Requires authentication. Query Parameters NameTypeDescription advanced_searchstringAdvanced search string asset_idintegerFilter by specified asset awaiti...
Social Media & CRM Endpoints (cont.)
Opps (continued) GET /Opportunities (additional parameters) ParameterTypeDescription order2stringSecondary sort field startdatestringStart date (for use with datesearch) enddatestringEnd date (for use with datesearch) datesearchstringDate field to search — e.g...
Invoice Schema
Schemas InvoiceHeader The core invoice object used for both standard and recurring invoices. PropertyTypeDescription idintegerInvoice ID client_idintegerAssociated client ID client_namestringClient display name sitenumberintegerSite ID site_namestringSite disp...
Email & Communications Endpoints
Email & Communications Mail Endpoints for processing inbound mail from various email providers via the HaloIntegrator. POST /Mail/Azure Process an Azure/Microsoft 365 email message. No request body schema documented. POST /Mail/Integrator/Azure Process an Azu...
Email & Communications Endpoints (cont.)
Email & Communications (continued) IncomingEmail (continued) POST /incomingemail Create incoming email records. Request Body: Array of IncomingEmail objects Key IncomingEmail fields: FieldTypeDescription idintegerRecord ID mbidintegerMailbox ID agentidintegerA...
System Config Endpoints
System Configuration & Administration This section covers system-level configuration endpoints: custom fields, screen layouts, SLAs, service catalog, reporting, attachments, automation, integrations, and administrative utilities. Most resources follow standard...
System Config Endpoints (cont.)
Attachments & Documents Attachment File attachments on tickets, actions, and other entities. GET /Attachment — List attachments. Key parameters: ParameterTypeDescription ticket_idintegerReturn attachments for this ticket. action_idintegerReturn attachments fro...