Connect HaloPSA
HaloPSA is a professional services automation (PSA) platform — the system your MSP uses for tickets, clients, assets, contracts, invoices, and projects. Connecting HaloPSA to StackJack lets your AI…
Written By Christopher Scaminaci
Last updated 3 days ago
HaloPSA is a professional services automation (PSA) platform — the system your MSP uses for tickets, clients, assets, contracts, invoices, and projects. Connecting HaloPSA to StackJack lets your AI assistant (Claude, Copilot, or any other MCP-capable client) read and update that data through StackJack's tool catalog. StackJack passes tool results through as raw HaloPSA API responses, so what your AI sees is exactly what HaloPSA returns.
The HaloPSA integration exposes tools with the halo_ prefix spanning:
| Family | Examples of what the AI can do |
|---|---|
| Tickets & service desk | Search, create, and update tickets; actions, SLAs, approval processes, changes, ticket filters |
| Clients & CRM | Clients, sites, users, address book, CRM records, call logs, mail campaigns |
| Assets | Assets, asset groups, discovery results |
| Contracts & billing | Contracts, contract rules and schedules, invoices, CSP invoices, billing templates, accounting details |
| Sales | Quotations, sales orders, products and items, purchase orders, suppliers |
| Projects | Projects and project tickets |
| Knowledge & content | Knowledge base, FAQ lists, canned text, email and PDF templates |
| Reporting & analytics | Reports, custom queries, custom tables, analytics summaries |
| Scheduling & time | Appointments, timesheets, downtime, service availability |
| Automation & admin | Workflows, webhooks, integrations, agents, roles, teams, notifications, tags |
See the generated HaloPSA tool reference for the current inventory, input schemas, plan tiers, and safety notes.
Tool availability depends on your HaloPSA connector plan tier — the in-portal tool selector and the Permissions page (/permissions) show exactly which tools your plan includes.
Choose an authentication method
HaloPSA is one of only two connectors (with NinjaOne) where you choose between two authentication methods in the setup dialog:
- Authorization Code (User OAuth) — recommended. Each team member signs into HaloPSA with their own identity, so ticket updates and audit trails in HaloPSA are attributed to the actual person whose AI session made the change. StackJack maintains the connection automatically with refresh tokens.
- Client Credentials. One shared application identity for the whole team. Simpler to set up, but all activity in HaloPSA is attributed to the API application.
Prerequisites in HaloPSA
You need HaloPSA administrator access to create an API application.
Option A — Authorization Code (User OAuth)
- In HaloPSA, go to Configuration > Integrations > Halo API, click View Applications, and create a new application.
- Set Authentication Method to Authorisation Code (Native Application), choose Use a client secret for the token request, and enable Allow Agent Logins.
- Set the application's redirect URL to the StackJack OAuth callback URL shown in the StackJack connector setup form (there is a copy button next to it).
- On the Permissions tab, enable only the scopes required for the tools you want to use (see the permission summary below).
- Copy the Client ID and one-time Client Secret, then return to StackJack and click Authorize to complete the flow.
Option B — Client Credentials
- In HaloPSA, go to Configuration > Integrations > Halo API, click View Applications, and create a new application. Set Authentication Method to Client ID and Secret (Services).
- Set Agent to log in as to Application identity. Assign least-privilege Identity Roles so StackJack changes are auditable as the application rather than a shared human agent.
- On the Permissions tab, enable only the scopes required for the tools you want to use. The identity role and the selected scopes both restrict access.
- Save the application and its permissions, then edit it and generate/copy the Client ID and Client Secret. Halo hides the secret after you leave the page.
- Return to StackJack and paste them into the connector setup form.
HaloPSA permissions
HaloPSA API applications use granular permission groups. Enable read (and, where you want write tools, edit) access for the areas you plan to use:
| Area | Permissions |
|---|---|
| Tickets | read:tickets / edit:tickets |
| Customers | read:customers / edit:customers |
| Assets | read:assets / edit:assets |
| Contracts | read:contracts / edit:contracts |
| Invoices | read:invoices / edit:invoices |
| Projects | read:projects / edit:projects |
| Knowledge Base | read:kb / edit:kb |
| Reporting | read:reporting / edit:reporting |
| Timesheets | read:timesheets / edit:timesheets |
| Suppliers | read:suppliers / edit:suppliers |
| Quotes | read:quotes / edit:quotes |
| Items | read:items / edit:items |
| Purchase Orders | read:pos / edit:pos |
| Sales Orders | read:sos / edit:sos |
| Calendar | read:calendar / edit:calendar |
| CRM | read:sales / edit:sales |
| Software/Releases | read:software / edit:software |
| Software Licensing (incl. Microsoft CSP / M365 subscriptions) | read:softwarelicensing / edit:softwarelicensing |
| Configuration area and Integrations — Instance & System Setup; Agents, Roles & Security; Custom Fields & Types; Custom Tables; Lookups & Reference; SLA, Workflow & Approvals; Views & Canned Text; Ticket Structure; Mailbox & Email Config; Notifications & Distribution; PDF Templates; Email Templates; Email Rules; Mail Campaigns; MCP & AI; the configuration tools in KB, Projects & Collaboration and in Assets & Stock Extras; and every Integrations group (Integration Data, Integration Data (Extended), Integration Management, Integration Sync, Accounting Details, Integration Connectors, Integration Config: A-E / E-M / M-S / S-X, Integration Mappings, Integration Data Actions, Integration Diagnostics) | admin — HaloPSA's Configuration-area scope. HaloPSA's scope vocabulary has no configuration scope and no integrations scope, so StackJack's permission mapping shows every tool in these groups under admin, reads and writes alike. (Some of these groups displayed a different label before the 2026-08-28 and 2026-08-29 corrections; those names were StackJack's own, never HaloPSA permissions, and are gone.) For the integration passthroughs, access additionally follows the API application's identity/roles and the integration's own connection state rather than a scope toggle. Two tools sit outside this: halo_get_periodic_history (Integration Diagnostics) is mapped to read:invoices (the Invoices row above), and halo_list_licence_role (Agents, Roles & Security) to read:softwarelicensing (the Software Licensing row above). |
Tip: the StackJack Permissions page (/permissions) maps every StackJack tool to the exact HaloPSA permission it needs, so you can scope the application to least privilege.
Set up the connector in StackJack
- In the StackJack portal, go to Connectors and find the HaloPSA card.
- Optional: click How To Connect for the in-portal version of this guide.
- Click Configure.
- Fill in the fields:
| Field | What to enter |
|---|---|
| Authentication Method | Authorization Code (User OAuth) — Recommended or Client Credentials |
| Instance URL | Your HaloPSA URL, e.g. https://yourcompany.halopsa.com. StackJack derives your Halo tenant name from the subdomain automatically. |
| Client ID | From the HaloPSA API application |
| Client Secret | From the HaloPSA API application (required in both modes — in OAuth mode StackJack uses it during the token exchange) |
| Redirect URI (OAuth mode, read-only) | Copy this into the HaloPSA application before clicking Authorize |
- Click Save (Client Credentials) or Authorize (OAuth). In OAuth mode you are sent to HaloPSA to sign in and approve access, then returned to StackJack.
What happens when you save
- Your credentials are stored in Azure Key Vault — never in the StackJack database.
- A Free-tier connector subscription is created automatically if you don't already have one (upgrade any time from the connector card).
- StackJack immediately test-calls your HaloPSA instance (an authenticated "who am I" request). Success shows a confirmation toast; a failed or timed-out test shows a warning toast but does not block the save — StackJack retries validation in the background.
- StackJack proactively refreshes OAuth tokens and re-validates credentials in the background. After 3 consecutive definitive failures the credential is auto-disabled, tool calls stop, and the tenant owner is emailed. The connector card then offers Re-enable and Update Credentials; an invalid-but-enabled card offers Re-test.
If HaloPSA completes the OAuth flow but does not return a refresh token, StackJack refuses to save the connection and shows a missing_refresh_token error — this means the HaloPSA application is missing the offline access / refresh token capability. Fix the application configuration in HaloPSA and authorize again.
Instance URL guidance
There is no region selector — enter your full HaloPSA URL (for example https://yourcompany.halopsa.com). StackJack derives your Halo tenant name from the URL's subdomain and appends API paths automatically; enter only the base URL.
Per-user connections for team members
If you configured HaloPSA with Authorization Code, each team member can connect their own HaloPSA identity:
- The member signs into StackJack, opens the Connectors page, and finds the HaloPSA card in their Your personal sign-ins section.
- The HaloPSA card shows Authorization Required with a Connect button. (Members only see the card if they have at least one HaloPSA tool assigned and the connector subscription is active.)
- Clicking Connect reuses your OAuth application — the member signs into HaloPSA with their own credentials.
- On the member's first HaloPSA sign-in, StackJack automatically creates a personal MCP client key for them (named "member's HaloPSA key") and shows it once on a one-time credentials page. The member pastes it into their AI client. Members who connect through a sign-in AI app (Claude, ChatGPT, Microsoft Copilot) can ignore the key.
- When the member signs in again later — Re-authorize or Reconnect on the card — StackJack renews the sign-in and keeps the key they already have. No new key is created, no key page is shown, and nothing changes in their AI app. StackJack also updates that key's tool list to the member's current tools, so a tool or role granted since the first sign-in reaches it. A member who lost their key can select Revoke my key on the card; their next sign-in then creates a new key and shows it once.
From then on, that member's AI activity runs under their own HaloPSA identity. If a member's connection breaks (for example, their refresh token is revoked in Halo), their card shows Re-authorize Required. If HaloPSA refuses the organization's application instead (its client secret changed, or it does not allow the sign-in method), the card shows Administrator Action Required: an owner or administrator fixes the organization's HaloPSA connection first, and signing in again does not help until then.
When you re-save the shared OAuth application configuration — for example after rotating the client secret in HaloPSA — StackJack copies the new application settings onto each team member's connection and keeps that member's own sign-in, so in the normal case members do not need to reconnect. Three cases fall outside it: a member StackJack could not reach during the save is left unchanged and shows Re-authorize Required; moving the connector to a different HaloPSA address never carries members' sign-ins across, so everyone signs in again; and widening the scopes does not re-consent anyone, so members may need to authorize again before the new scopes work for them. See Updating & Rotating Credentials.
Limits and behavior
| Behavior | Detail |
|---|---|
| Request pacing | StackJack paces outbound HaloPSA requests to 300 requests per 5 minutes per organization, with backoff on HaloPSA 429 responses, to protect your Halo instance. StackJack itself imposes no per-minute limit on your MCP usage — your monthly plan call cap is the enforcement point. |
| Page size | List tools return at most 200 records per page; use page parameters to fetch more. |
| Long-running reports | Halo report generation can take minutes; StackJack allows up to 3 minutes per request. |
| Token lifecycle | Access tokens are cached and refreshed automatically (client-credential tokens re-minted, OAuth refresh tokens rotated proactively in the background). You never manage tokens yourself. |
Microsoft CSP / M365 subscriptions
HaloPSA's Microsoft CSP integration writes each M365 subscription as a Software Licence record — the tenant, offer/SKU, purchased seats, seats in use, seats available, term, billing cycle, auto-renew, dates, status, and price all live on the licence record. To answer subscription questions, use the licence tools, which read Halo's own records:
halo_list_software_licences— per-client subscription lists, Microsoft-tenant pivots (tenantId), and cancelled/expired history (includeInactive).halo_get_software_licence— full detail on one subscription.halo_list_licence_changes— the seat-count change history.halo_list_csp_invoices/halo_get_csp_invoice— Partner Center invoices.halo_list_csp_consumption_data— Azure metered usage.
halo_get_microsoft_csp_data is different: it is a live passthrough into Halo's Partner
Center connection. It only answers when the CSP integration is fully connected in Halo (two
Azure app registrations plus GDAP admin consent), and Halo provides full subscription data to
Tier 1 direct CSP partners only — indirect partners get the "All Subscribed SKUs" import.
Troubleshooting
| Symptom | Likely cause and fix |
|---|---|
missing_refresh_token error after authorizing | The HaloPSA API application doesn't grant refresh tokens. Check the application's authentication settings in HaloPSA, then authorize again. |
403 from halo_get_microsoft_csp_data (or other integration-data tools) | The integration is not fully connected in Halo, the linked Agent lacks integration-data access, or — for Microsoft CSP — the Partner Centre/GDAP setup is incomplete or the partnership is indirect (Tier 2). For subscription questions, use the licence tools above; they do not depend on the live connection. |
| Validation fails right after save (Client Credentials) | Client ID/Secret mistyped, or the application was created with the wrong authentication method. The connector card shows the upstream HaloPSA error with a recommended action. |
| Tools return permission errors | The API application is missing the relevant read: / edit: permission group in HaloPSA, or the connection was authorized before that permission was added. Tick the permission on the API application, then re-authorize the connection. For the organization's shared connection: Connectors → HaloPSA → Configure, enter the client ID and secret again, Authorize and sign in to HaloPSA. For a team member's personal sign-in: that member opens Your personal sign-ins on the Connectors page and selects Reconnect on the HaloPSA card — re-saving the shared connection does not renew personal sign-ins. A sign-in keeps the permissions it had when it was granted, so a permission added afterwards never reaches it until it is authorized again. If HaloPSA also refuses the same action to the agent who authorized the connection, that agent's role needs the permission under Configuration → Teams & Agents → Roles. Use the StackJack Permissions page to see exactly which permission each tool needs. |
| The organization's HaloPSA card shows Disabled | 3 consecutive validation failures auto-disabled the credential. Fix the cause shown in the card's error details, then click Re-enable (StackJack validates against HaloPSA before re-enabling) or Update Credentials. |
| Dashboard shows HaloPSA — Disabled (your personal connection) | Only your own HaloPSA sign-in is disabled. The organization's connection is unchanged, so do not change its authentication method. Open Connectors and go to Your personal sign-ins. If the organization uses Client Credentials, the sign-in shows as an Old personal sign-in card: select Remove. If the organization uses Authorization Code, it shows as a Re-authorize Required card: select Re-authorize. An owner or administrator can also remove it from Team. If you are the organization's primary owner, your own old sign-in appears under Your personal sign-ins on the Connectors page once a separate shared connection exists and the old sign-in is disabled; select Remove there. Team does not list the primary owner's sign-in. |
| Dashboard shows HaloPSA — Authentication failed (your personal connection) | Your own HaloPSA sign-in is still switched on but no longer works, so your tool calls that use it fail. The organization's connection is unchanged. Open Connectors and go to Your personal sign-ins. If the organization uses Client Credentials, the sign-in shows as an Old personal sign-in card with an Authentication failed badge: select Remove, and your tool calls then use the organization's credential. If the organization uses Authorization Code, select Reconnect on your HaloPSA card and sign in again. |
| Team member sees "Re-authorize Required" | The member's own Halo refresh token was revoked or expired. The member selects Re-authorize in their personal sign-ins on the Connectors page. |
| Everything broke after rotating the app secret in Halo | Update the shared credential on the Connectors page. Member connections are usually updated with it; check for any member still showing Re-authorize Required. |
Disconnecting: the Disconnect button deletes the stored credentials for that connection from Key Vault, and HaloPSA calls on it stop immediately. Where the card holds several connections, the others keep working and the connector stays connected until you remove the last one. Removing a connection also removes the team members' HaloPSA sign-ins made on it. Disconnecting does not cancel a paid connector subscription — cancel the plan separately from the connector card if you no longer want it. See Disconnecting a Connector.
HaloPSA tools
halo_ · 1479 tools · Free 781 · Pro 698
Tickets & Actions
| Tool | What it does |
|---|---|
halo_Free · Write | Add an action (note / email / reply / internal note / time entry / status change) to an existing ticket. |
halo_Pro · Write | Add an emoji reaction to a ticket action. |
halo_Free · Write | Add a private/internal note to a ticket — hidden from the end user/customer. |
halo_Pro · Destructive | Change the status of up to 50 tickets in one call, with per-ticket read-back verification. |
halo_Free · Write | Change a ticket's status and record an audit-trail note. |
halo_Pro · Write | Create a draft ticket or action. |
halo_Free · Write | Create a new helpdesk ticket. |
halo_Pro · Destructive | Delete a ticket action (note, email, or time entry). |
halo_Free · Read-only | Retrieve full details for a single action (note, email, or time entry). |
halo_Free · Read-only | Retrieve a single ticket by numeric ID. |
halo_Free · Read-only | List ticket actions (notes, emails, time entries) with optional filters. |
halo_Free · Read-only | Fetch all actions for a single ticket in one call. |
halo_Free · Read-only | List all available ticket types with ticket counts. |
halo_Free · Read-only | List tickets with optional filters. |
halo_Free · Write | Log work time on a ticket. |
halo_Pro · Write | Manager approval/rejection of a ticket action (typically a time entry). |
halo_Free · Read-only | Full-text search across ticket summaries, details, and action notes. |
halo_Free · Write | Send an outbound email reply on a ticket. |
halo_Free · Write | Update an existing action. |
halo_Free · Write | Update an existing ticket's fields such as status, assignment, priority, or custom fields, with best-effort read-back verification: after the write the ticket is re-read, and a value Halo accepted but then overrode (for example a ticket type's Status After Tech Update rule, an allowed-status list, or a status freeze) surfaces as an error naming the field instead of a false success — retrying after that error will not change the outcome. |
halo_Pro · Write | Submit a vote on a ticket. |
Clients
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new client (customer organization) record. |
halo_Free · Read-only | Retrieve full details for a single client by numeric ID. |
halo_Free · Read-only | List all clients (customer organizations) with pagination. |
halo_Free · Read-only | List end users (contacts), optionally filtered by client. |
halo_Free · Read-only | Search clients by name or reference number. |
halo_Pro · Write | Update an existing client's fields such as name, contact details, or custom fields. |
Assets
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new asset (device, hardware, or software) record. |
halo_Free · Read-only | Retrieve full details for a single asset by numeric ID. |
halo_Free · Read-only | Retrieve the next available asset tag number from HaloPSA's auto-numbering sequence. |
halo_Free · Read-only | List change history for assets. |
halo_Free · Read-only | List software discovered on assets, optionally filtered by device. |
halo_Free · Read-only | List software version records across assets. |
halo_Free · Read-only | List all available asset types defined in HaloPSA. |
halo_Free · Read-only | List assets (devices, hardware, software) with optional filters for client and asset type. |
halo_Free · Read-only | List software licences assigned to devices/assets. |
halo_Free · Read-only | Search assets by name, serial number, or asset tag. |
halo_Pro · Write | Update an existing asset's fields such as status, assignment, or custom fields. |
Agents & Teams
| Tool | What it does |
|---|---|
halo_Pro · Write | Clear the cached agent data in HaloPSA. |
halo_Free · Read-only | Retrieve full details for a single agent by numeric ID. |
halo_Free · Read-only | Retrieve details for the currently authenticated agent. |
halo_Free · Read-only | List helpdesk agents (technicians) with optional team and department filters. |
halo_Free · Read-only | List all teams defined in HaloPSA. |
halo_Free · Read-only | Search agents (technicians) by name or email. |
Contracts
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new client contract/agreement. |
halo_Free · Read-only | Retrieve full details for a single contract by numeric ID, including contract lines and billing items. |
halo_Free · Read-only | Retrieve full details for a single supplier contract by numeric ID. |
halo_Free · Read-only | List all charge rates defined in HaloPSA. |
halo_Free · Read-only | List contracts/agreements with optional client filter. |
halo_Free · Read-only | List invoices with optional client and date filters. |
halo_Free · Read-only | List supplier contracts/agreements with optional filters and pagination. |
Invoices
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new invoice. |
halo_Pro · Write | Generate a PDF document for an invoice. |
halo_Free · Read-only | Retrieve a single invoice by numeric ID. |
halo_Free · Read-only | List invoice line items. |
halo_Free · Read-only | List invoice payments with optional filters. |
halo_Pro · Write | Record a payment against an invoice. |
halo_Pro · Write | Update an EXISTING invoice by fetch-merge-write. |
halo_Pro · Destructive | Void an existing invoice by ID. |
Knowledge Base
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a NEW knowledge base article — never pass an existing article's 'id' here (Halo's POST /api/KBArticle is an upsert, so an id turns this into an overwrite of that live article). |
halo_Free · Read-only | Retrieve full details for a single knowledge base article by numeric ID. |
halo_Free · Read-only | List knowledge base articles with pagination. |
halo_Free · Read-only | Search the knowledge base for articles matching a query. |
halo_Pro · Destructive | Overwrite an existing knowledge base article. |
Projects
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new project. |
halo_Free · Read-only | Retrieve full details for a single project by numeric ID. |
halo_Free · Read-only | List tickets/tasks associated with a specific project. |
halo_Free · Read-only | List projects with optional client filter. |
halo_Pro · Write | Update an existing project's fields such as name, dates, status, or budget. |
Reports
| Tool | What it does |
|---|---|
halo_Pro · Write | Generate a PDF from a saved report. |
halo_Free · Read-only | Discover the parameters/filters of a saved report so it can be run parameterized. |
halo_Free · Read-only | List all saved reports available in HaloPSA. |
halo_Free · Read-only | Execute a saved report by its numeric ID and return the result rows as JSON (via GET api/Report/{id}?loadreport=true). |
SLAs
| Tool | What it does |
|---|---|
halo_Free · Read-only | Get full SLA definition by ID including response time targets, resolution time targets, priority-based conditions, and applicable hours. |
halo_Free · Read-only | List all SLA (Service Level Agreement) definitions configured in HaloPSA. |
Sites
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new site (physical location) record. |
halo_Free · Read-only | Retrieve full details for a single site by numeric ID. |
halo_Free · Read-only | List sites (physical locations), optionally filtered by client. |
halo_Pro · Write | Update an existing site's fields such as name, address, or contact information. |
Users
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new client end user (contact) record. |
halo_Free · Read-only | Retrieve full details for a single end user (contact) by numeric ID. |
halo_Free · Read-only | Search end users (contacts) by name or email. |
halo_Pro · Write | Update an existing end user's (contact's) fields such as name, email, phone, or site assignment. |
halo_Pro · Write | Update preferences for an end user (contact). |
Timesheets
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new timesheet entry. |
halo_Free · Read-only | Retrieve timesheet entries for the currently authenticated agent. |
halo_Free · Read-only | Retrieve a single timesheet entry by numeric ID. |
halo_Free · Read-only | List individual time entries with optional filters for agent, client, and date range. |
Lookups
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve values for a specific lookup list by numeric lookup ID. |
halo_Free · Read-only | List all ticket categories configured in the system. |
halo_Free · Read-only | List all currencies configured in HaloPSA. |
halo_Free · Read-only | List all action outcome types configured in the system. |
halo_Free · Read-only | List all priority levels configured in the system. |
halo_Free · Read-only | List all ticket statuses configured in the system. |
halo_Free · Read-only | List all tax rules configured in HaloPSA. |
halo_Free · Read-only | List all tax configurations defined in HaloPSA. |
Categories
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new ticket category. |
halo_Pro · Destructive | Permanently delete a category record by numeric ID. |
halo_Pro · Write | Update an existing category. |
Suppliers
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new supplier/vendor record. |
halo_Pro · Write | Create a new supplier-side user (contact) attached to an existing supplier. |
halo_Free · Read-only | Retrieve a single supplier by numeric ID. |
halo_Free · Read-only | List suppliers/vendors with optional filters. |
Quotations
| Tool | What it does |
|---|---|
halo_Pro · Write | Append NEW line items to an existing quotation (e.g. bulk quote-import workflows). |
halo_Pro · Write | Approve or reject a quotation. |
halo_Pro · Write | Create a new quotation/quote. |
halo_Free · Read-only | Retrieve a single quotation by numeric ID. |
halo_Free · Read-only | List quotations/quotes with optional filters. |
halo_Pro · Destructive | Remove one or more EXISTING line items from a quotation. |
halo_Pro · Write | Update EXISTING line items on a quotation (change pricing/quantity on lines that already exist). |
halo_Free · Read-only | View a quotation in a rendered/presentable format. |
Items & Stock
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new product/item in the catalogue. |
halo_Pro · Write | Create a link between an item and an accounting system account. |
halo_Pro · Write | Create a new item group/category for organising products in the catalogue. |
halo_Pro · Write | Link a supplier to an item/product. |
halo_Pro · Write | Create a new stock bin/warehouse location for storing inventory. |
halo_Pro · Destructive | Delete an item group by numeric ID. |
halo_Pro · Destructive | Remove a supplier link from an item by numeric link ID. |
halo_Pro · Destructive | Delete a stock bin/warehouse location by numeric ID. |
halo_Free · Read-only | Retrieve a single product/item by numeric ID. |
halo_Free · Read-only | Retrieve a single item group by numeric ID. |
halo_Free · Read-only | Retrieve a single stock bin/warehouse location by numeric ID. |
halo_Free · Read-only | List accounting integation links for items. |
halo_Free · Read-only | List item groups/categories used to organise products in the catalogue. |
halo_Free · Read-only | List stock levels for items/products. |
halo_Free · Read-only | List stock level history for items, showing how inventory quantities have changed over time. |
halo_Free · Read-only | List supplier links for items/products. |
halo_Free · Read-only | List products/items in the catalogue with optional search filter. |
halo_Free · Read-only | List stock bin/warehouse locations where inventory is stored. |
halo_Free · Read-only | List stock trace records showing the movement history of inventory items. |
Purchase Orders
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Confirm receipt of goods on a purchase order. |
halo_Pro · Write | Create a new purchase order. |
halo_Free · Read-only | Retrieve a single purchase order by numeric ID. |
halo_Free · Read-only | List purchase orders with optional filters. |
Sales Orders
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a NEW sales order. |
halo_Free · Read-only | Retrieve a single sales order by numeric ID. |
halo_Free · Read-only | List sales orders with optional filters. |
halo_Pro · Destructive | Update EXISTING line items on a sales order (change price, quantity or text on lines that already exist). |
Finance
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new expense record. |
halo_Pro · Write | Create a new prepay/retainer entry for a client. |
halo_Pro · Write | Create a new recurring invoice template for automated billing. |
halo_Pro · Write | Create a new software licence record. |
halo_Free · Read-only | Retrieve a single recurring invoice by numeric ID. |
halo_Free · Read-only | Retrieve a single software licence by numeric ID — including a Microsoft CSP / M365 subscription, which Halo stores AS a Software Licence record. |
halo_Free · Read-only | List billing line items with optional filters by client, contract, and date range. |
halo_Free · Read-only | List expense records with optional filters. |
halo_Free · Read-only | List client prepay/retainer history with optional filters. |
halo_Free · Read-only | List recurring invoice templates with optional client filter. |
halo_Free · Read-only | List software licence records — INCLUDING Microsoft CSP / M365 subscriptions: Halo's Microsoft CSP integration writes each subscription AS a Software Licence record carrying the Microsoft tenant (tenant_id/tenant_name), offer and SKU, purchased seats (count), seats in use (licences_in_use/consumedcount), seats available (licences_available), term length (term_duration), billing cycle, auto-renew, start/end dates, status, and monthly cost/price. |
halo_Pro · Destructive | Trigger invoice generation from one or more recurring invoice templates by their IDs. |
halo_Pro · Write | Amend the line items on an existing recurring invoice template — change quantities, prices, descriptions, deactivate a line, or add new ones. |
halo_Pro · Destructive | Change the schedule of a recurring invoice template: the start date that drives when the next invoice is generated. |
Change Management
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new CAB meeting. |
halo_Pro · Write | Create a new release for change management. |
halo_Free · Read-only | Retrieve a single CAB meeting by numeric ID. |
halo_Free · Read-only | Retrieve a single release by numeric ID. |
halo_Free · Read-only | List Change Advisory Board (CAB) meetings with pagination. |
halo_Free · Read-only | List all Change Advisory Board members. |
halo_Free · Read-only | List all CAB roles. |
halo_Free · Read-only | List all available release types. |
halo_Free · Read-only | List releases with optional filters. |
Service Catalog
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new service status entry. |
halo_Free · Read-only | Retrieve a single service by numeric ID. |
halo_Free · Read-only | List all service categories. |
halo_Free · Read-only | List service status history with optional service filter. |
halo_Free · Read-only | List services in the service catalogue with optional filters. |
Scheduling
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new appointment/calendar entry. |
halo_Pro · Write | Create a new to-do checklist item on a ticket. |
halo_Free · Read-only | Retrieve a single appointment by numeric ID. |
halo_Free · Read-only | Retrieve the current timesheet event for the authenticated agent. |
halo_Free · Read-only | List appointments/calendar entries with optional filters. |
halo_Free · Read-only | List available time slots for scheduling appointments. |
halo_Free · Read-only | List all available booking/appointment types. |
halo_Free · Read-only | List configured holidays. |
halo_Free · Read-only | List agent schedules with optional filters. |
halo_Free · Read-only | List timesheet events (clock-in/clock-out, breaks, and time tracking events). |
halo_Free · Read-only | List to-do checklist items, optionally filtered by ticket ID. |
halo_Free · Read-only | List workday definitions (business hours configuration). |
halo_Pro · Write | Update an existing to-do checklist item — correct its wording ('text'), mark it complete ('done': true), or re-order it ('sequence'). |
CRM
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new CRM note against a client or supplier. |
halo_Pro · Write | Create a new CRM opportunity/deal. |
halo_Free · Read-only | Retrieve a single CRM opportunity by numeric ID. |
halo_Free · Read-only | List all contact groups. |
halo_Free · Read-only | List CRM notes with optional client or supplier filter. |
halo_Free · Read-only | Returns ALL customer satisfaction (CSAT) feedback records from Halo (raw passthrough). |
halo_Free · Read-only | List CRM opportunities/deals with optional filters. |
halo_Free · Read-only | List pending ticket approvals with pagination. |
halo_Pro · Write | Add or remove contacts from a contact group. |
halo_Pro · Write | Process one or more pending approval requests by their IDs. |
halo_Pro · Write | Update an existing CRM opportunity's fields such as stage, value, probability, or expected close date. |
Audit
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve a single audit log entry by numeric ID. |
halo_Free · Read-only | Retrieve a single CUSTOM FIELD definition by numeric ID (GET /FieldInfo/{id}). |
halo_Free · Read-only | List audit log entries with pagination. |
Attachments
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Delete an attachment by numeric ID. |
halo_Pro · Destructive | Permanently delete an attachment's document by ID. |
halo_Pro · Destructive | Permanently delete an attachment's image by its image ID (a GUID). |
halo_Free · Read-only | Download an attachment's binary content by ID. |
halo_Free · Read-only | Download an attachment's document representation by ID. |
halo_Free · Read-only | Download an attachment's image representation by its image ID (a GUID). |
halo_Free · Read-only | Retrieve attachment metadata by numeric ID. |
halo_Free · Read-only | List attachments with optional action/ticket filter and pagination. |
halo_Pro · Write | Upload a file attachment to a ticket (and optionally a specific action/note). |
Discovery & Config
| Tool | What it does |
|---|---|
halo_Free · Read-only | Search across all entity types (tickets, clients, users, assets, knowledge base, etc.) in a single query. |
halo_Free · Read-only | List custom field definitions (GET /FieldInfo), optionally filtered by ticket type. |
halo_Free · Read-only | List all request types (service catalogue items) configured in the system. |
halo_Free · Read-only | List detailed status configurations including workflow transitions, colour codes, and associated ticket types. |
halo_Free · Read-only | List all ticket areas (sub-categories or functional groupings) configured in the system. |
halo_Free · Read-only | List detailed ticket type configurations including workflow rules, field mappings, SLA associations, and default values. |
halo_Free · Read-only | List fields configured for a ticket type, including custom fields and their validation rules. |
halo_Free · Read-only | Retrieve HaloPSA instance information including version, licence details, and system configuration. |
Analytics
| Tool | What it does |
|---|---|
halo_Free · Read-only | Track ticket volume trends for a specific client over multiple periods to identify patterns. |
halo_Free · Read-only | Snapshot of all open tickets grouped by status, priority, team, and ticket type with counts. |
halo_Free · Read-only | Breakdown of open tickets by priority level including average age per priority. |
halo_Free · Read-only | Compare team/queue performance KPIs: average resolution time, resolution rate, open ticket count, and SLA compliance. |
halo_Free · Read-only | Identify open tickets with no activity beyond a threshold, indicating potential neglect or bottlenecks. |
halo_Free · Read-only | View open ticket distribution across agents to identify workload imbalances. |
halo_Free · Read-only | Analyze ticket distribution across categories, types, or priorities for a date range. |
halo_Free · Read-only | Analyze ticket resolution times and rates for a date range, grouped by a chosen dimension. |
halo_Free · Read-only | Analyze how tickets are being created (email, portal, phone, API, etc.) for a date range. |
halo_Free · Read-only | List all open tickets that have no agent assigned, grouped by priority and client. |
Advanced Analytics
| Tool | What it does |
|---|---|
halo_Pro · Read-only | Find assets with recurring ticket activity above a threshold. |
halo_Pro · Read-only | Identify assets with warranties expiring within a specified number of days. |
halo_Pro · Read-only | Track Pre-Pay contract balance utilization (used vs prepaid allowance) from the contract prepay balance fields. |
halo_Pro · Read-only | Customer satisfaction report with ratings breakdown by agent. |
halo_Pro · Read-only | Identify open tickets at risk of breaching SLA or already breached. |
halo_Pro · Read-only | SLA compliance metrics including response and resolution rates for a date range. |
halo_Pro · Read-only | Analyze technician time utilization including billable vs total hours and utilization rate. |
halo_Pro · Read-only | Open tickets grouped by age buckets (today, 1-3 days, 3-7 days, 1-2 weeks, 2-4 weeks, 1-3 months, 3+ months) with counts and details per bucket. |
halo_Pro · Read-only | Summarize timesheet data by agent and client for a date range. |
Intelligence
| Tool | What it does |
|---|---|
halo_Pro · Read-only | Analyze ticket volume outside business hours (before 8am, after 6pm, and weekends). |
halo_Pro · Destructive | Update multiple tickets at once with the same field changes, with per-ticket read-back verification. |
halo_Pro · Read-only | Comprehensive 360-degree view of a client combining contacts, open tickets, assets, contracts, invoices, CSAT scores, and sites into a single consolidated report. |
halo_Pro · Read-only | Audit a client for offboarding readiness. |
halo_Pro · Read-only | Generate an onboarding completeness checklist for a client. |
halo_Pro · Read-only | Assess client churn risk based on ticket volume, SLA breaches, CSAT ratings, and resolution efficiency. |
halo_Pro · Read-only | Generate a compliance snapshot covering SLA compliance rates, ticket closure rates, response time compliance, and time documentation completeness. |
halo_Pro · Read-only | View upcoming contract renewals sorted by expiry date. |
halo_Pro · Read-only | Generate a daily operations briefing with new tickets since yesterday, SLA warnings, stale tickets, unassigned tickets, and priority breakdown. |
halo_Pro · Read-only | Analyze agent availability and workload to optimize ticket dispatch. |
halo_Pro · Read-only | Generate a draft KB article from a resolved ticket. |
halo_Pro · Read-only | Measure first-contact resolution (FCR) rate — tickets resolved within 24 hours of creation. |
halo_Pro · Read-only | Identify knowledge base gaps by comparing ticket categories to existing KB article coverage. |
halo_Pro · Read-only | Check project budget status by comparing budgeted hours/cost against actual time logged on project tickets. |
halo_Pro · Read-only | Detect recurring issues by grouping tickets by client and category, then filtering for groups that meet a minimum occurrence threshold. |
halo_Pro · Read-only | Scan for revenue leakage by identifying billable-but-unbilled time entries, zero-value entries, and comparing billed revenue to logged hours. |
halo_Pro · Read-only | Detect scope creep by comparing ticket categories against contract scope definitions. |
halo_Pro · Read-only | Analyze the open ticket backlog with age distribution buckets, per-agent breakdown, priority distribution, and top clients by backlog size. |
halo_Pro · Read-only | Analyze ticket handoffs (reassignments, transfers, escalations) to identify tickets that bounce between agents. |
halo_Pro · Read-only | Find tickets similar to a given ticket based on summary text matching. |
halo_Pro · Read-only | AI-assisted triage for a ticket. |
halo_Pro · Read-only | Scan timesheet entries for anomalies including zero-minute entries, very long entries (>12 hours), very short entries (<5 minutes), and per-agent daily hour statistics. |
halo_Pro · Read-only | Find billable time entries that haven't been invoiced yet. |
Premium Analytics
| Tool | What it does |
|---|---|
halo_Pro · Read-only | Analyze a single agreement's profitability by comparing revenue to hours worked. |
halo_Pro · Read-only | Composite client health score based on ticket volume, resolution rates, SLA compliance, and CSAT. |
halo_Pro · Read-only | Calculate effective hourly rate across all billable work compared to a target rate. |
halo_Pro · Read-only | Analyze escalation patterns including frequency by ticket type and agent. |
halo_Pro · Read-only | Calculate current MRR from recurring invoices with optional client breakdown and historical trend. |
halo_Pro · Read-only | Comprehensive quarterly business review data pack for a client. |
halo_Pro · Read-only | Identify agreements with negative profitability over a period. |
Ticket Filters
| Tool | What it does |
|---|---|
halo_Free · Read-only | List open tickets with high priority (default priority ID 1 = Critical). |
halo_Free · Read-only | List tickets assigned to the current authenticated agent. |
halo_Free · Read-only | List all open/active tickets. |
halo_Free · Read-only | List open tickets with overdue SLA targets. |
halo_Free · Read-only | List open tickets that have breached their SLA target. |
halo_Free · Read-only | List all tickets for a specific client. |
halo_Free · Read-only | List open tickets with no agent assigned. |
Address Book
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new address book entry. |
halo_Pro · Destructive | Delete an address book entry by numeric ID. |
halo_Free · Read-only | Retrieve a single address book entry by numeric ID. |
halo_Free · Read-only | List address book entries with optional search and pagination. |
halo_Pro · Write | Update an existing address book entry's fields such as name, email, or phone. |
Roles
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new role. |
halo_Pro · Destructive | Delete a role by numeric ID. |
halo_Free · Read-only | Retrieve a single role by numeric ID. |
halo_Free · Read-only | List roles with pagination. |
halo_Pro · Write | Update an existing role's fields such as name, description, or permissions. |
Tags
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new tag. |
halo_Pro · Destructive | Delete a tag by numeric ID. |
halo_Free · Read-only | Retrieve a single tag by numeric ID. |
halo_Free · Read-only | List tags with optional search and pagination. |
Notifications
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new notification. |
halo_Free · Read-only | Retrieve a single notification by numeric ID. |
halo_Free · Read-only | List notifications with optional filters and pagination. |
halo_Pro · Write | Send a notification message to one or more agents. |
Canned Text
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new canned text (quick reply template). |
halo_Pro · Destructive | Delete a canned text template by numeric ID. |
halo_Free · Read-only | Retrieve a single canned text template by numeric ID. |
halo_Free · Read-only | List canned text (quick reply templates) with optional filters and pagination. |
halo_Pro · Write | Update an existing canned text template's fields such as name, content, or team assignment. |
Webhooks
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new webhook subscription. |
halo_Pro · Destructive | Delete a webhook by numeric ID. |
halo_Free · Read-only | Retrieve a single webhook by numeric ID. |
halo_Free · Read-only | List webhook event delivery history with optional webhook filter and pagination. |
halo_Free · Read-only | List configured webhooks with pagination. |
halo_Pro · Write | Update an existing webhook's fields such as name, URL, events, or enabled status. |
Automation
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new automation rule. |
halo_Pro · Destructive | Delete an automation rule by numeric ID. |
halo_Free · Read-only | Retrieve a single automation rule by numeric ID. |
halo_Free · Read-only | List automation rules with pagination. |
halo_Pro · Write | Update an existing automation rule's fields such as name, conditions, actions, or enabled status. |
Workflows
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new workflow. |
halo_Pro · Destructive | Delete a workflow by numeric ID. |
halo_Free · Read-only | Retrieve a single workflow by numeric ID. |
halo_Free · Read-only | List steps for a specific workflow by workflow ID. |
halo_Free · Read-only | List workflows with pagination. |
halo_Pro · Write | Update an existing workflow's fields such as name, description, or configuration. |
Asset Groups
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new asset group. |
halo_Pro · Destructive | Delete an asset group by numeric ID. |
halo_Free · Read-only | Retrieve a single asset group by numeric ID. |
halo_Free · Read-only | List asset groups with pagination. |
halo_Pro · Write | Update an existing asset group's fields such as name or description. |
Release Pipeline
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new release pipeline. |
halo_Pro · Destructive | Delete a release pipeline by numeric ID. |
halo_Free · Read-only | Retrieve a single release pipeline by numeric ID. |
halo_Free · Read-only | List release pipelines with pagination. |
Products & Components
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new product. |
halo_Pro · Write | Create a new product component. |
halo_Pro · Destructive | Delete a product by numeric ID. |
halo_Free · Read-only | Retrieve a single product by numeric ID. |
halo_Free · Read-only | List product components with optional product filter and pagination. |
halo_Free · Read-only | List products with optional search and pagination. |
Downtime
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new downtime record. |
halo_Pro · Destructive | Delete a downtime record by numeric ID. |
halo_Free · Read-only | Retrieve a single downtime record by numeric ID. |
halo_Free · Read-only | List downtime records with optional filters and pagination. |
Service Availability
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new service availability record. |
halo_Pro · Destructive | Delete a service availability record by numeric ID. |
halo_Free · Read-only | Retrieve a single service availability record by numeric ID. |
halo_Free · Read-only | List service availability records with optional filters and pagination. |
Contract Rules
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a contract billing rule that defines how time and items are charged. |
halo_Pro · Destructive | Delete a contract billing rule by ID. |
halo_Free · Read-only | Retrieve a single contract billing rule by numeric ID. |
halo_Free · Read-only | List contract billing rules that define how time and items are charged. |
Contract Schedules
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a contract billing schedule that defines when charges are generated. |
halo_Pro · Destructive | Delete a contract billing schedule by ID. |
halo_Free · Read-only | Retrieve a single contract billing schedule by numeric ID. |
halo_Free · Read-only | List contract billing schedules that define when charges are generated. |
Billing Templates
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a reusable billing template for contracts. |
halo_Pro · Destructive | Delete a billing template by ID. |
halo_Free · Read-only | Retrieve a single billing template by numeric ID. |
halo_Free · Read-only | List reusable billing templates for contracts. |
halo_Pro · Destructive | Push a billing template's configuration out to the clients assigned to it — the "Update Clients" button on a HaloPSA billing template. |
Budget Types
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a budget type for project and contract budgeting. |
halo_Pro · Destructive | Delete a budget type by ID. |
halo_Free · Read-only | Retrieve a single budget type by numeric ID. |
halo_Free · Read-only | List budget types used for project and contract budgeting. |
Cost Centres
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a cost centre for financial categorisation and reporting. |
halo_Pro · Destructive | Delete a cost centre by ID. |
halo_Free · Read-only | Retrieve a single cost centre by numeric ID. |
halo_Free · Read-only | List cost centres for financial categorisation and reporting. |
CSP Invoices
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a CSP invoice record. |
halo_Pro · Destructive | Delete a CSP invoice by ID. |
halo_Free · Read-only | Retrieve a single CSP invoice by numeric ID. |
halo_Free · Read-only | List Microsoft Cloud Solution Provider (CSP) invoices synced from partner centre. |
Custom Queries
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a custom database query for reporting and data extraction. |
halo_Pro · Destructive | Delete a custom query by ID. |
halo_Free · Read-only | Retrieve a single custom query by numeric ID. |
halo_Free · Read-only | List custom database queries used for reporting and data extraction. |
Custom Tables
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a custom data table for extending Halo's data model. |
halo_Pro · Destructive | Delete a custom table by ID. |
halo_Free · Read-only | Retrieve a single custom table by numeric ID. |
halo_Free · Read-only | List custom data tables used for extending Halo's data model. |
PDF Templates
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a PDF template used for generating documents like invoices, quotes, and delivery notes. |
halo_Pro · Destructive | Delete a PDF template by numeric ID. |
halo_Pro · Write | Generate a PDF document from a template. |
halo_Free · Read-only | Retrieve full details for a single PDF template by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single item from the HaloPSA PDF template repository by numeric ID. |
halo_Free · Read-only | Browse the HaloPSA pre-built PDF template repository. |
halo_Free · Read-only | List PDF templates used for generating invoices, quotes, delivery notes, and other documents. |
Email Templates
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an email template for automated notifications and customer communications. |
halo_Pro · Write | Create a custom email template merge variable. |
halo_Pro · Destructive | Delete an email template by numeric ID. |
halo_Pro · Destructive | Delete a custom email template variable by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single email template by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single email template variable by numeric ID. |
halo_Free · Read-only | List all available email template merge variables. |
halo_Free · Read-only | List email templates used for automated notifications, ticket replies, and customer communications. |
halo_Free · Read-only | Render a live preview of an email template with variable substitution against real ticket data. |
Email Rules
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an email rule for inbound email processing. |
halo_Pro · Destructive | Delete an email rule by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single email rule by numeric ID. |
halo_Free · Read-only | List email rules that control how inbound emails are processed into tickets. |
Mail Campaigns
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an individual email within a mail campaign. |
halo_Pro · Write | Create or update a mail campaign for bulk customer communications. |
halo_Pro · Destructive | Delete a campaign email by numeric ID. |
halo_Pro · Destructive | Delete a mail campaign by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single campaign email by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single campaign delivery log entry by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single mail campaign by numeric ID. |
halo_Free · Read-only | List individual email messages within mail campaigns. |
halo_Free · Read-only | List delivery logs for mail campaigns. |
halo_Free · Read-only | List mail campaigns for bulk customer communications. |
Integration Management
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve full details for a single integration configuration by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single integration error by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single integration request by numeric ID. |
halo_Free · Read-only | List all configured integrations with their authentication status and module details. |
halo_Free · Read-only | List integration sync errors with pagination. |
halo_Free · Read-only | List field mappings between Halo and third-party integration fields. |
halo_Free · Read-only | List integration API requests (inbound and outbound) with pagination. |
halo_Free · Read-only | List site mappings between Halo and third-party integrations. |
Integration Data
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve ConnectWise Automate / LabTech data (computers, monitors, scripts) from Halo's connected Automate integration. |
halo_Free · Read-only | Retrieve Auvik data (networks, devices, alerts) from Halo's connected Auvik network monitoring integration. |
halo_Free · Read-only | Retrieve Avalara tax data from Halo's connected tax integration. |
halo_Free · Read-only | Retrieve Azure Active Directory / Entra ID data (users, groups, licenses) from Halo's connected Azure AD integration. |
halo_Free · Read-only | Retrieve Azure Sentinel / Microsoft Sentinel data (incidents, alerts, analytics rules) from Halo's connected Sentinel integration. |
halo_Free · Read-only | Retrieve Microsoft Dynamics 365 Business Central data from Halo's connected accounting integration. |
halo_Free · Read-only | Retrieve ConnectWise Manage data (tickets, companies, contacts) from Halo's connected ConnectWise integration. |
halo_Free · Read-only | Retrieve Datto RMM data (devices, alerts, patch status) from Halo's connected Datto integration. |
halo_Free · Read-only | Retrieve Domotz data (agents, devices, alerts) from Halo's connected Domotz network monitoring integration. |
halo_Free · Read-only | Retrieve Exact Online accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve Fortnox accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve GoCardless data from Halo's connected payments integration. |
halo_Free · Read-only | Retrieve GoCardless payments from Halo's connected payments integration. |
halo_Free · Read-only | Retrieve Sage Intacct accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve Microsoft Intune data (devices, compliance policies, app deployments) from Halo's connected Intune integration. |
halo_Free · Read-only | Retrieve IT Glue data (configurations, flexible assets, documents) from Halo's connected IT Glue integration. |
halo_Free · Read-only | Retrieve Kaseya VSA data (agents, machine groups, procedures) from Halo's connected Kaseya VSA integration. |
halo_Free · Read-only | Retrieve KashFlow accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve Liongard data (inspectors, metrics, timelines) from Halo's connected Liongard integration. |
halo_Free · Read-only | Retrieve LIVE Microsoft Partner Center data through Halo's Microsoft CSP integration passthrough. |
halo_Free · Read-only | Retrieve MYOB accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve N-able N-central data (devices, service items, tasks) from Halo's connected N-central integration. |
halo_Free · Read-only | Retrieve Pax8 data (subscriptions, products, companies) from Halo's connected Pax8 distributor integration. |
halo_Free · Read-only | Retrieve PRTG data (sensors, devices, alerts) from Halo's connected PRTG Network Monitor integration. |
halo_Free · Read-only | Retrieve QuickBooks Online data (e.g. Account, Customer, Payment, Invoice, Item, Vendor) from Halo's connected QuickBooks integration. |
halo_Free · Read-only | Retrieve Sage Business Cloud accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve the SentinelOne integration connection details configured in Halo (returns the /SentinelOneDetails resource). |
halo_Free · Read-only | Retrieve SnelStart accounting data from Halo's connected integration. |
halo_Free · Read-only | Retrieve SolarWinds RMM / N-able RMM data (devices, alerts, patch status) from Halo's connected SolarWinds RMM integration. |
halo_Free · Read-only | Retrieve the Sophos integration connection details configured in Halo (returns the /SophosDetails resource). |
halo_Free · Read-only | Retrieve Stripe data from Halo's connected payments integration. |
halo_Free · Read-only | Retrieve Xero data from Halo's connected Xero accounting integration. |
Accounting Details
| Tool | What it does |
|---|---|
halo_Free · Read-only | Get a single Avalara connection detail by ID. |
halo_Free · Read-only | Get a single Business Central connection detail by ID. |
halo_Free · Read-only | Get a single Fortnox connection detail by ID. |
halo_Free · Read-only | Get a single KashFlow connection detail by ID. |
halo_Free · Read-only | Get a single MYOB connection detail by ID. |
halo_Free · Read-only | Get a single QuickBooks Online connection detail by ID. |
halo_Free · Read-only | Get a single Sage Business Cloud connection detail by ID. |
halo_Free · Read-only | Get a single Xero connection detail by ID. |
halo_Free · Read-only | List Avalara tax-integration connection details configured in Halo. |
halo_Free · Read-only | List Microsoft Dynamics 365 Business Central connection details configured in Halo. |
halo_Free · Read-only | List Fortnox connection details configured in Halo. |
halo_Free · Read-only | List KashFlow connection details configured in Halo. |
halo_Free · Read-only | List MYOB connection details configured in Halo. |
halo_Free · Read-only | List QuickBooks Online connection details configured in Halo. |
halo_Free · Read-only | List Sage Business Cloud connection details configured in Halo. |
halo_Free · Read-only | List Xero connection details configured in Halo. |
MCP & AI
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Create a new MCP (Model Context Protocol) connection. |
halo_Pro · Destructive | Create a new PII (Personally Identifiable Information) detection rule. |
halo_Pro · Destructive | Delete an MCP connection by numeric ID. |
halo_Free · Read-only | Retrieve a single MCP connection by numeric ID. |
halo_Free · Read-only | Retrieve a single PII detection rule by numeric ID. |
halo_Free · Read-only | Retrieve the MCP (Model Context Protocol) configuration linked to a virtual agent. |
halo_Pro · Destructive | Link MCP (Model Context Protocol) capabilities to a virtual agent. |
halo_Free · Read-only | List all MCP (Model Context Protocol) connections configured in HaloPSA. |
halo_Free · Read-only | List all PII (Personally Identifiable Information) detection rules configured in HaloPSA. |
halo_Pro · Destructive | Unlink MCP (Model Context Protocol) capabilities from a virtual agent. |
Integration Diagnostics
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Create or update an integration cursor. |
halo_Pro · Destructive | Create or update an Intermedia connection detail. |
halo_Pro · Destructive | Create or update an SFTP connection detail. |
halo_Pro · Destructive | Delete an integration cursor by numeric ID. |
halo_Pro · Destructive | Delete an Intermedia connection detail by numeric ID. |
halo_Pro · Destructive | Delete an SFTP connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single cluster by numeric ID. |
halo_Free · Read-only | Retrieve a single integration cursor by numeric ID. |
halo_Free · Read-only | Retrieve a single Intermedia connection detail by numeric ID. |
halo_Free · Read-only | Retrieve periodic (recurring) invoice/billing history. |
halo_Free · Read-only | Retrieve a single SFTP connection detail by numeric ID. |
halo_Free · Read-only | List Halo clusters. |
halo_Free · Read-only | List integration cursors. |
halo_Free · Read-only | List configured Intermedia (Unite / cloud PBX) connection details used by Halo's telephony integration. |
halo_Free · Read-only | List configured SFTP connection details used by Halo integrations and imports. |
Invoice & Order Extras
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Create a new invoice status. |
halo_Pro · Destructive | Delete an invoice status by numeric ID. |
halo_Pro · Destructive | Expire one or more client prepay balances. |
halo_Free · Read-only | Retrieve a single invoice status by numeric ID. |
halo_Free · Read-only | List all invoice statuses configured in HaloPSA. |
halo_Pro · Write | Record that a user or contact has viewed an invoice. |
halo_Pro · Write | Record that a user or contact has viewed a knowledge base article. |
halo_Pro · Write | Record that a user or contact has viewed a purchase order. |
halo_Pro · Write | Record that a user or contact has viewed a sales order. |
halo_Pro · Destructive | Mark one or more expenses as reviewed. |
halo_Pro · Destructive | Update one or more invoice line items in bulk. |
CRM & Service Extras
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a reply against a CRM note. |
halo_Pro · Write | Create a new service in the service catalog/service-status surface. |
halo_Pro · Destructive | Delete a CRM note reply by numeric ID. |
halo_Pro · Destructive | Delete a service from the service catalog by numeric ID. |
halo_Free · Read-only | Retrieve a single CRM note reply by numeric ID. |
halo_Free · Read-only | Retrieve the security question to verify a caller for a given call/ticket by numeric ID. |
halo_Free · Read-only | List replies left against CRM notes. |
halo_Free · Read-only | List project milestones. |
halo_Free · Read-only | List the users the current agent can act on behalf of. |
halo_Pro · Destructive | Unsubscribe the current user/agent from a service so they stop receiving status notifications. |
halo_Pro · Write | Validate a user's answer to a security question. |
halo_Pro · Write | Validate a caller's answer to a security question for a call/ticket. |
Integration Data (Extended)
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve Atera data from Halo's connected Atera integration. |
halo_Free · Read-only | Retrieve Autotask data from Halo's connected Autotask integration. |
halo_Free · Read-only | Retrieve Barracuda data from Halo's connected Barracuda integration. |
halo_Free · Read-only | Retrieve ConnectWise Control data from Halo's connected ConnectWise Control integration. |
halo_Free · Read-only | Retrieve ConnectWise RMM data from Halo's connected ConnectWise RMM integration. |
halo_Free · Read-only | Retrieve Datto Commerce data from Halo's connected Datto Commerce integration. |
halo_Free · Read-only | Retrieve Device42 data from Halo's connected Device42 integration. |
halo_Free · Read-only | Retrieve Azure DevOps data from Halo's connected Azure DevOps integration. |
halo_Free · Read-only | Retrieve Dynamics CRM data from Halo's connected Dynamics CRM integration. |
halo_Free · Read-only | Retrieve Freshdesk data from Halo's connected Freshdesk integration. |
halo_Free · Read-only | Retrieve Google Calendars data from Halo's connected Google Calendars integration. |
halo_Free · Read-only | Retrieve Google Workplace data from Halo's connected Google Workplace integration. |
halo_Free · Read-only | Retrieve GoToAssist data from Halo's connected GoToAssist integration. |
halo_Free · Read-only | Retrieve HubSpot data from Halo's connected HubSpot integration. |
halo_Free · Read-only | Retrieve Jamf data from Halo's connected Jamf integration. |
halo_Free · Read-only | Retrieve Jira data from Halo's connected Jira integration. |
halo_Free · Read-only | Retrieve Jira Service Management data from Halo's connected Jira Service Management integration. |
halo_Free · Read-only | Retrieve Lansweeper data from Halo's connected Lansweeper integration. |
halo_Free · Read-only | Retrieve LogicMonitor data from Halo's connected LogicMonitor integration. |
halo_Free · Read-only | Retrieve Meraki data from Halo's connected Meraki integration. |
halo_Free · Read-only | Retrieve NinjaRMM data from Halo's connected NinjaRMM integration. |
halo_Free · Read-only | Retrieve Okta data from Halo's connected Okta integration. |
halo_Free · Read-only | Retrieve PagerDuty data from Halo's connected PagerDuty integration. |
halo_Free · Read-only | Retrieve Passportal data from Halo's connected Passportal integration. |
halo_Free · Read-only | Retrieve Qualys data from Halo's connected Qualys integration. |
halo_Free · Read-only | Retrieve Salesforce data from Halo's connected Salesforce integration. |
halo_Free · Read-only | Retrieve ServiceNow data from Halo's connected ServiceNow integration. |
halo_Free · Read-only | Retrieve ServiceNow Integration data from Halo's connected ServiceNow Integration integration. |
halo_Free · Read-only | Retrieve Shopify data from Halo's connected Shopify integration. |
halo_Free · Read-only | Retrieve Slack data from Halo's connected Slack integration. |
halo_Free · Read-only | Retrieve Snow data from Halo's connected Snow integration. |
halo_Free · Read-only | Retrieve Splashtop data from Halo's connected Splashtop integration. |
halo_Free · Read-only | Retrieve Splunk On-Call data from Halo's connected Splunk On-Call integration. |
halo_Free · Read-only | Retrieve Syncro data from Halo's connected Syncro integration. |
halo_Free · Read-only | Retrieve Tanium data from Halo's connected Tanium integration. |
halo_Free · Read-only | Retrieve Zabbix data from Halo's connected Zabbix integration. |
Integration Sync
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Change the seat quantity of a Microsoft CSP licence via Halo's connected Microsoft Partner Center integration. |
halo_Pro · Destructive | Change the seat quantity of a Pax8 subscription licence via Halo's connected Pax8 integration. |
halo_Pro · Write | Clear Halo's cached Microsoft CSP licence-key lookups, forcing a fresh fetch from Microsoft Partner Center on the next read. |
halo_Pro · Destructive | Trigger an import sync against the connected Microsoft Dynamics 365 Business Central accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected Exact Online accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected Fortnox accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected Sage Intacct accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected KashFlow accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected MYOB accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected QuickBooks Online accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected Sage Business Cloud accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected SnelStart accounting integration. |
halo_Pro · Destructive | Trigger an import sync against the connected Xero accounting integration. |
halo_Pro · Destructive | Push an invoice to the connected Xero accounting integration. |
halo_Pro · Destructive | Create a Stripe PaymentIntent via Halo's connected Stripe payments integration. |
halo_Pro · Destructive | Create a Stripe customer billing portal session via Halo's connected Stripe payments integration. |
halo_Pro · Destructive | Create a Stripe SetupIntent via Halo's connected Stripe payments integration. |
halo_Pro · Destructive | Create a Stripe webhook endpoint via Halo's connected Stripe payments integration. |
halo_Pro · Destructive | Update an invoice payment record in Stripe via Halo's connected Stripe payments integration. |
Standard Request Templates
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new standard request template. |
halo_Pro · Destructive | Delete a standard request template by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single standard request template by numeric ID. |
halo_Free · Read-only | List standard request templates (pre-configured ticket blueprints) with pagination. |
Call Scripts
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve full details for a single call script by numeric ID. |
halo_Free · Read-only | List all call scripts configured in the system. |
Live Chat
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve full details for a single live chat session by numeric ID. |
halo_Free · Read-only | Retrieve full details for a single chat profile by numeric ID. |
halo_Free · Read-only | List messages in a live chat session. |
halo_Free · Read-only | List all live chat profiles configured in the system. |
halo_Free · Read-only | List live chat sessions with optional filtering. |
halo_Pro · Write | Send a message in a live chat session. |
Remote Sessions
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new remote support session. |
halo_Free · Read-only | Retrieve full details for a single remote support session by numeric ID. |
halo_Free · Read-only | List teams configured for remote support sessions. |
halo_Free · Read-only | List remote support sessions with optional filtering by agent or client. |
Approval Processes
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new approval process. |
halo_Pro · Write | Create a new approval rule that defines conditions for triggering approvals. |
halo_Free · Read-only | Retrieve full details for a single approval process by numeric ID. |
halo_Free · Read-only | List all approval processes configured in the system. |
halo_Free · Read-only | List approval rules that define when and how approvals are triggered. |
Saved Views
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve full details for a single saved view by numeric ID. |
halo_Free · Read-only | List available column definitions that can be used in saved views. |
halo_Free · Read-only | List available filter definitions that can be used in saved views. |
halo_Free · Read-only | List saved views configured in the system. |
PowerShell Scripts
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new PowerShell script in the Halo script library. |
halo_Free · Read-only | Retrieve full details for a single PowerShell script by numeric ID. |
halo_Free · Read-only | List PowerShell script execution history. |
halo_Free · Read-only | List PowerShell scripts stored in the Halo script library. |
Call Logs
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new telephone call log entry. |
halo_Free · Read-only | List telephone call logs recorded in the system. |
External Links
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new external link on a Halo entity. |
halo_Pro · Write | Generate a shareable external link (portal link or guest access URL) for a Halo entity. |
halo_Free · Read-only | List external links associated with Halo entities. |
FAQ Lists
| Tool | What it does |
|---|---|
halo_Free · Read-only | Retrieve full details for a single FAQ list by numeric ID. |
halo_Free · Read-only | List FAQ lists (frequently asked questions collections) configured in the system. |
Popup Notes
| Tool | What it does |
|---|---|
halo_Free · Read-only | List popup notes configured for clients, sites, or users. |
halo_Pro · Write | Mark a popup note as read/acknowledged for the current agent. |
Secure Secret Links
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new secure secret link for sharing sensitive information. |
halo_Free · Read-only | List secure secret links (one-time-use password/secret sharing URLs). |
halo_Free · Read-only | Validate a secure secret link token and retrieve the secret if valid. |
Cross-Domain
| Tool | What it does |
|---|---|
halo_Pro · Read-only | Quick counts of open items across all domains: open tickets, active contracts, active assets, pending approvals, and open opportunities. |
halo_Pro · Read-only | For a client: total invoiced revenue, total hours logged, active contracts with values, prepay balance, and recent billing lines. |
halo_Pro · Read-only | Scatter-gather: given a client, fetch open tickets, assets, contracts, users, sites, and opportunities in parallel and return counts and summaries for each entity type. |
halo_Pro · Read-only | Health metrics for a specific team/queue: open ticket count, SLA status, per-agent workload distribution, and ticket age distribution buckets. |
halo_Pro · Read-only | For a given agent: their open tickets by priority, today's timesheets, upcoming appointments, and SLA breach warnings. |
halo_Pro · Read-only | Weekly operations snapshot: new tickets created, tickets closed, total time logged, SLA breaches, and contracts expiring soon. |
Integration Config: A-E
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an Addigy integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Adobe Acrobat integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Adobe Commerce integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Amazon Seller integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Armis integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an ArrowSphere integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Assetbots integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Avalara tax-integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an AWS integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Microsoft Dynamics 365 Business Central connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Confluence integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Datto Commerce integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Datto RMM integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Microsoft Dynamics 365 CRM integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Dynatrace integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Eracent integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Destructive | Delete an Addigy integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Adobe Acrobat integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Adobe Commerce integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Amazon Seller integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Armis integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an ArrowSphere integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Assetbots integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Avalara tax-integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an AWS integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Microsoft Dynamics 365 Business Central connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Confluence integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Datto Commerce integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Datto RMM integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Microsoft Dynamics 365 CRM integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Dynatrace integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete an Eracent integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Addigy integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Adobe Acrobat integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Adobe Commerce integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Amazon Seller integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Armis integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single ArrowSphere integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Assetbots integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single AWS integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Confluence integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Datto Commerce integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Datto RMM integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Microsoft Dynamics 365 CRM integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Dynatrace integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Eracent integration connection-detail record by numeric ID. |
halo_Free · Read-only | List Addigy integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Adobe Acrobat integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Adobe Commerce integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Amazon Seller integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Armis integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List ArrowSphere integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Assetbots integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List AWS integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Confluence integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Datto Commerce integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Datto RMM integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Microsoft Dynamics 365 CRM integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Dynatrace integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Eracent integration connection-detail records configured in HaloPSA. |
Integration Config: E-M
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an Exact Online integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Facebook integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Forecast integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Forethought integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Fortnox integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Google Business Messages integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Google Workspace integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update an Ingram Micro integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update an Ingram Micro Reseller integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Jamf integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Jira integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Kandji integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Kaseya VSA X integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a KashFlow integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a ManageEngine integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Write | Create or update a Mattermost integration connection detail (upsert — include an id in the body to update). |
halo_Pro · Destructive | Delete an Exact Online integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Facebook integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Forecast integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Forethought integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Fortnox integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Google Business Messages integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Google Workspace integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete an Ingram Micro integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete an Ingram Micro Reseller integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Jamf integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Jira integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Kandji integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Kaseya VSA X integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a KashFlow integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a ManageEngine integration connection detail by numeric ID. |
halo_Pro · Destructive | Delete a Mattermost integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Exact Online integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Facebook integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Forecast integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Forethought integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Google Business Messages integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Google Workspace integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Ingram Micro integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Ingram Micro Reseller integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Jamf integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Jira integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Kandji integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Kaseya VSA X integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single ManageEngine integration connection detail by numeric ID. |
halo_Free · Read-only | Retrieve a single Mattermost integration connection detail by numeric ID. |
halo_Free · Read-only | List Exact Online integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Facebook integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Forecast integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Forethought integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Google Business Messages integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Google Workspace integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Ingram Micro integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Ingram Micro Reseller integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Jamf integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Jira integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Kandji integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Kaseya VSA X integration connection details configured in HaloPSA. |
halo_Free · Read-only | List ManageEngine integration connection details configured in HaloPSA. |
halo_Free · Read-only | List Mattermost channel details available for the configured Mattermost integration in HaloPSA. |
halo_Free · Read-only | List Mattermost integration connection details configured in HaloPSA. |
Integration Config: M-S
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a MYOB integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update an N-central integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Pax8 integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a PRTG integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a QuickBooks integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Raynet integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Sage Business Cloud integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a SailPoint integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a SeatGeek integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a SentinelOne integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Shopify integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Slack integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Snipe-IT integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Snow integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Write | Create or update a Sophos integration detail record (upsert — include an "id" in the body to update an existing record). |
halo_Pro · Destructive | Delete a MYOB integration detail record by numeric ID. |
halo_Pro · Destructive | Delete an N-central integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Pax8 integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a PRTG integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a QuickBooks integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Raynet integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Sage Business Cloud integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a SailPoint integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a SeatGeek integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a SentinelOne integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Shopify integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Slack integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Snipe-IT integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Snow integration detail record by numeric ID. |
halo_Pro · Destructive | Delete a Sophos integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single N-central integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Pax8 integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single PRTG integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Raynet integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single SailPoint integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single SeatGeek integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single SentinelOne integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single service request detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Shopify integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Slack integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Snipe-IT integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Snow integration detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Sophos integration detail record by numeric ID. |
halo_Free · Read-only | List all N-central integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all Pax8 integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all PRTG integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all Raynet integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all SailPoint integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all SeatGeek integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all service request detail records configured in HaloPSA. |
halo_Free · Read-only | List all Shopify integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all Slack integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all Snipe-IT integration detail records configured in HaloPSA. |
halo_Free · Read-only | List all Snow integration detail records configured in HaloPSA. |
halo_Pro · Destructive | Uninstall the Slack integration (POST /SlackDetails/Uninstall). |
Integration Config: S-X
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a StreamOne Ion integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Synnex integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Tanium integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a TechData Reseller integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Tenable integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Twilio WhatsApp integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Twitter integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Virima integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a VMware Workspace integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a WordPress integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a WordPress Org integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Xero accounting-integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Destructive | Delete a StreamOne Ion integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Synnex integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Tanium integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a TechData Reseller integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Tenable integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Twilio WhatsApp integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Twitter integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Virima integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a VMware Workspace integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a WordPress integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a WordPress Org integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a Xero accounting-integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single StreamOne Ion integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Synnex integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Tanium integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single TechData Reseller integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Tenable integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Twilio WhatsApp integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Twitter integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single Virima integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single VMware Workspace integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single WordPress integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single WordPress Org integration connection-detail record by numeric ID. |
halo_Free · Read-only | List StreamOne Ion integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Synnex integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Tanium integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List TechData Reseller integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Tenable integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Twilio integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Twilio WhatsApp integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Twitter integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List Virima integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List VMware Workspace integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List WordPress integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List WordPress Org integration connection-detail records configured in HaloPSA. |
Integration Connectors
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a Halo action via the HaloIntegration/CreateAction inbound-integration endpoint. |
halo_Pro · Write | Create or update an Azure AD (Entra ID) connection record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Azure Delta record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an Azure DevOps integration connection-detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a configuration-commit record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a connected-instance record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a CSV import-template record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a CSV import record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an incoming-event record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an incoming-webhook record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an integration-configuration record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an integration-delta record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an integration-error record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an integration-export record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create a Halo ticket via the HaloIntegration/CreateTicket inbound-integration endpoint. |
halo_Pro · Destructive | Delete an Azure AD (Entra ID) connection record by numeric ID. |
halo_Pro · Destructive | Delete an Azure Delta record by numeric ID. |
halo_Pro · Destructive | Delete an Azure DevOps integration connection-detail record by numeric ID. |
halo_Pro · Destructive | Delete a configuration-commit record by numeric ID. |
halo_Pro · Destructive | Delete a connected-instance record by numeric ID. |
halo_Pro · Destructive | Delete a CSV import-template record by numeric ID. |
halo_Pro · Destructive | Delete a CSV import record by numeric ID. |
halo_Pro · Destructive | Delete an incoming-event record by numeric ID. |
halo_Pro · Destructive | Delete an incoming-webhook record by numeric ID. |
halo_Pro · Destructive | Delete an integration-delta record by numeric ID. |
halo_Pro · Destructive | Delete an integration-error record by numeric ID. |
halo_Pro · Destructive | Delete an integration-export record by numeric ID. |
halo_Free · Read-only | Retrieve a single Azure AD (Entra ID) connection record by numeric ID. |
halo_Free · Read-only | Retrieve a single Azure Delta record by numeric ID. |
halo_Free · Read-only | Retrieve a single Azure DevOps integration connection-detail record by numeric ID. |
halo_Free · Read-only | Retrieve a single configuration-commit record by numeric ID. |
halo_Free · Read-only | Retrieve a single connected-instance record by numeric ID. |
halo_Free · Read-only | Retrieve a single CSV import-template record by numeric ID. |
halo_Free · Read-only | Retrieve HaloIntegration inbound-integration data via the HaloIntegration/Get endpoint. |
halo_Free · Read-only | Retrieve a single CSV import record by numeric ID. |
halo_Free · Read-only | Retrieve a single incoming-event record by numeric ID. |
halo_Free · Read-only | Retrieve a single incoming-webhook record by numeric ID. |
halo_Free · Read-only | Retrieve a single integration-delta record by numeric ID. |
halo_Free · Read-only | List Azure AD (Entra ID) connection records configured in HaloPSA. |
halo_Free · Read-only | List Azure AD (Entra ID) field-mapping records configured in HaloPSA. |
halo_Free · Read-only | List Azure Delta records configured in HaloPSA. |
halo_Free · Read-only | List Azure DevOps integration connection-detail records configured in HaloPSA. |
halo_Free · Read-only | List configuration-commit records in HaloPSA. |
halo_Free · Read-only | List connected-instance records in HaloPSA. |
halo_Free · Read-only | List CSV import-template records in HaloPSA. |
halo_Free · Read-only | List CSV import records in HaloPSA. |
halo_Free · Read-only | List incoming-event records in HaloPSA. |
halo_Free · Read-only | List incoming-webhook records in HaloPSA. |
halo_Free · Read-only | List integration-delta records in HaloPSA. |
halo_Free · Read-only | List integration-export records in HaloPSA. |
halo_Pro · Destructive | Process pending incoming events via the IncomingEvent/Process endpoint. |
halo_Pro · Destructive | Process queued incoming webhook attempts via the IncomingWebhook/Process endpoint. |
Integration Mappings
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an integration field-data mapping record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an integration request record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Microsoft subscription mapping record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Microsoft Teams mapping record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an outbound (custom) integration (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an outbound (custom) integration method (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a Slack chat app record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a SQL import configuration (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a webhook event record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Destructive | Delete an integration field-data mapping record by numeric ID. |
halo_Pro · Destructive | Delete an integration request record by numeric ID. |
halo_Pro · Destructive | Delete a Microsoft subscription mapping record by numeric ID. |
halo_Pro · Destructive | Delete a Microsoft Teams mapping record by numeric ID. |
halo_Pro · Destructive | Delete an outbound (custom) integration by numeric ID. |
halo_Pro · Destructive | Delete an outbound (custom) integration method by numeric ID. |
halo_Pro · Destructive | Delete a Slack chat app record by numeric ID. |
halo_Pro · Destructive | Delete a SQL import configuration by numeric ID. |
halo_Free · Read-only | Retrieve a single integration field-data mapping record by numeric ID. |
halo_Free · Read-only | Retrieve a single integration runbook variable group by numeric ID. |
halo_Free · Read-only | Retrieve a single Microsoft subscription mapping record by numeric ID. |
halo_Free · Read-only | Retrieve a single Microsoft Teams mapping record by numeric ID. |
halo_Free · Read-only | Retrieve a single outbound (custom) integration by numeric ID. |
halo_Free · Read-only | Retrieve a single outbound (custom) integration method by numeric ID. |
halo_Free · Read-only | Retrieve a single outbound (custom) integration repository entry by numeric ID. |
halo_Free · Read-only | Retrieve a single Slack chat app record by numeric ID. |
halo_Free · Read-only | Retrieve a single SQL import configuration by numeric ID. |
halo_Free · Read-only | Retrieve a single webhook event record by its GUID. |
halo_Free · Read-only | Retrieve a single webhook repository entry by its GUID. |
halo_Free · Read-only | Retrieve a single asset-type (XType) mapping record by numeric ID. |
halo_Free · Read-only | List integration field-data mapping records configured in HaloPSA. |
halo_Free · Read-only | List integration runbook variable groups configured in HaloPSA. |
halo_Free · Read-only | List Microsoft subscription mapping records configured in HaloPSA. |
halo_Free · Read-only | List Microsoft Teams mapping records configured in HaloPSA. |
halo_Free · Read-only | List object-mapping profiles configured in HaloPSA. |
halo_Free · Read-only | List outbound (custom) integrations configured in HaloPSA. |
halo_Free · Read-only | List outbound (custom) integration methods configured in HaloPSA. |
halo_Free · Read-only | List outbound (custom) integration method values configured in HaloPSA. |
halo_Free · Read-only | List the outbound (custom) integration repository entries available in HaloPSA. |
halo_Free · Read-only | List PagerDuty mapping records configured in HaloPSA. |
halo_Free · Read-only | List SailPoint role mapping records configured in HaloPSA. |
halo_Free · Read-only | List SailPoint user mapping records configured in HaloPSA. |
halo_Free · Read-only | List Slack chat app records configured in HaloPSA. |
halo_Free · Read-only | List SQL import configurations defined in HaloPSA. |
halo_Free · Read-only | List the webhook repository entries available in HaloPSA. |
halo_Free · Read-only | List asset-type (XType) mapping records configured in HaloPSA. |
halo_Free · Read-only | List asset-type (XType) role records configured in HaloPSA. |
Custom Fields & Types
| Tool | What it does |
|---|---|
halo_Pro · Write | Add an existing ASSET-TYPE field to all field groups via the Field/AddFieldToAll action. |
halo_Pro · Write | Create or update an ASSET-TYPE field definition — the fields that make up an asset type's field_list (POST /Field; HaloPSA POST is an upsert, so include an "id" to update an existing field). |
halo_Pro · Write | Create or update a field group (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update a CUSTOM FIELD definition (POST /FieldInfo; HaloPSA POST is an upsert, so include an "id" to update). |
halo_Pro · Write | Create or update a screen layout (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update an agent team / section (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update a style profile (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update a ticket action outcome (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update a top-level tree node (TopLevel) (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update a ticket status (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Write | Create or update an asset type (HaloPSA POST is an upsert — include an "id" field to update). |
halo_Pro · Destructive | Delete an ASSET-TYPE field definition by numeric ID (DELETE /Field/{id}). |
halo_Pro · Destructive | Delete a field group by numeric ID. |
halo_Pro · Destructive | Delete a CUSTOM FIELD definition by numeric ID (DELETE /FieldInfo/{id}). |
halo_Pro · Destructive | Delete a screen layout by numeric ID. |
halo_Pro · Destructive | Delete an agent team / section by numeric ID. |
halo_Pro · Destructive | Delete a style profile by numeric ID. |
halo_Pro · Destructive | Delete a ticket action outcome by numeric ID. |
halo_Pro · Destructive | Delete a top-level tree node (TopLevel) by numeric ID. |
halo_Pro · Destructive | Delete a ticket status by numeric ID. |
halo_Pro · Destructive | Delete an asset type by numeric ID. |
halo_Free · Read-only | Retrieve a single category definition by numeric ID from the HaloPSA Category configuration. |
halo_Free · Read-only | Retrieve a single field group by numeric ID. |
halo_Free · Read-only | Retrieve a single screen layout by numeric ID. |
halo_Free · Read-only | Retrieve a single agent team / section by numeric ID from the HaloPSA Team configuration. |
halo_Free · Read-only | Retrieve the agent team (section) hierarchy as a tree via the Team/Tree endpoint. |
halo_Free · Read-only | Retrieve a single style profile by numeric ID. |
halo_Free · Read-only | Retrieve a single ticket action outcome by numeric ID from the HaloPSA Outcome configuration. |
halo_Free · Read-only | Retrieve a single top-level tree node (TopLevel) by numeric ID. |
halo_Free · Read-only | Retrieve a single ticket status by numeric ID from the HaloPSA Status configuration. |
halo_Free · Read-only | Retrieve a single asset type by numeric ID from the HaloPSA AssetType configuration. |
halo_Free · Read-only | List criteria groups configured in HaloPSA — the reusable condition sets referenced by rules, automations and views. |
halo_Free · Read-only | List field groups configured in HaloPSA — the containers that organise custom fields into sections on forms. |
halo_Free · Read-only | List the built-in HaloField catalog — the standard (system) field definitions available across HaloPSA. |
halo_Free · Read-only | List screen layouts configured in HaloPSA — the form/screen designs that control how fields are arranged for ticket types, assets and other entities. |
halo_Free · Read-only | List style profiles configured in HaloPSA — the branding/appearance profiles that control colours and styling of portals and emails. |
halo_Free · Read-only | List top-level tree nodes (TopLevel) configured in HaloPSA — the top-level category groupings used to organise ticket types and areas. |
halo_Free · Read-only | List asset type info (AssetTypeInfo) — a lightweight summary of the asset types configured in HaloPSA. |
Ticket Structure
| Tool | What it does |
|---|---|
halo_Pro · Write | Allocate/return the next new account ID for a HaloPSA Client (Area) via the /Client/NewAccountsId endpoint. |
halo_Pro · Write | Update the stored payment method for a HaloPSA Client (Area) via the /Client/PaymentMethodUpdate endpoint. |
halo_Pro · Write | Create or update a ticket auto-assign rule via the /TicketRules endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing rule). |
halo_Pro · Write | Create or update a confirm-closure rule via the /ConfirmClosure endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing rule). |
halo_Pro · Write | Create or update a journey via the /Journey endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing journey). |
halo_Pro · Write | Create or update a qualification via the /Qualification endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing qualification). |
halo_Pro · Write | Create or update a ticket request type via the /TicketType endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing request type). |
halo_Pro · Write | Create or update a ticket request-type group via the /TicketTypeGroup endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing group). |
halo_Pro · Write | Create or update a setup tab via the /SetupTab endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing setup tab). |
halo_Pro · Write | Create or update a tab name via the /Tabs endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing tab name). |
halo_Pro · Write | Create or update a ticket-area record via the /TicketArea endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a workflow target via the /WorkflowTarget endpoint (HaloPSA POST is an upsert — include an "id" field to update an existing target). |
halo_Pro · Destructive | Delete a HaloPSA Client (Area) record by numeric ID via the /Client/{id} endpoint. |
halo_Pro · Destructive | Delete an Area (Client) CRM note by numeric ID via the /CRMNote/{id} endpoint. |
halo_Pro · Destructive | Delete a ticket auto-assign rule by numeric ID via the /TicketRules/{id} endpoint. |
halo_Pro · Destructive | Delete a confirm-closure rule by numeric ID via the /ConfirmClosure/{id} endpoint. |
halo_Pro · Destructive | Delete a journey by numeric ID via the /Journey/{id} endpoint. |
halo_Pro · Destructive | Delete a qualification by numeric ID via the /Qualification/{id} endpoint. |
halo_Pro · Destructive | Delete a ticket request type by numeric ID via the /TicketType/{id} endpoint. |
halo_Pro · Destructive | Delete a ticket request-type group by numeric ID via the /TicketTypeGroup/{id} endpoint. |
halo_Pro · Destructive | Delete a tab name by numeric ID via the /Tabs/{id} endpoint. |
halo_Pro · Destructive | Delete a ticket-area record by numeric ID via the /TicketArea/{id} endpoint. |
halo_Pro · Destructive | Delete a workflow target by numeric ID via the /WorkflowTarget/{id} endpoint. |
halo_Free · Read-only | Retrieve the HaloPSA Client (Area) record associated with the currently authenticated user via the /Client/me endpoint. |
halo_Free · Read-only | Retrieve a single Area (Client) CRM note by numeric ID via the /CRMNote/{id} endpoint. |
halo_Free · Read-only | Retrieve a single Area↔request-type link by numeric ID via the /AreaRequestType/{id} endpoint. |
halo_Free · Read-only | Retrieve a single ticket auto-assign rule by numeric ID via the /TicketRules/{id} endpoint. |
halo_Free · Read-only | Retrieve a single confirm-closure rule by numeric ID via the /ConfirmClosure/{id} endpoint. |
halo_Free · Read-only | Retrieve a single journey by numeric ID via the /Journey/{id} endpoint. |
halo_Free · Read-only | Retrieve a single qualification by numeric ID via the /Qualification/{id} endpoint. |
halo_Free · Read-only | Retrieve a single ticket request type by numeric ID via the /TicketType/{id} endpoint. |
halo_Free · Read-only | Retrieve a single ticket request-type group by numeric ID via the /TicketTypeGroup/{id} endpoint. |
halo_Free · Read-only | Retrieve a single setup tab by numeric ID via the /SetupTab/{id} endpoint. |
halo_Free · Read-only | Retrieve a single setup-tab group by numeric ID via the /SetupTabGroup/{id} endpoint. |
halo_Free · Read-only | Retrieve a single tab name by numeric ID via the /Tabs/{id} endpoint. |
halo_Free · Read-only | Retrieve a single ticket-area record by numeric ID via the /TicketArea/{id} endpoint. |
halo_Free · Read-only | Retrieve a single workflow target by numeric ID via the /WorkflowTarget/{id} endpoint. |
halo_Free · Read-only | List the Azure-tenant links associated with HaloPSA Areas (Clients). |
halo_Free · Read-only | List Area recurring-item records via the /RecurringItem endpoint. |
halo_Free · Read-only | List ticket auto-assign rules via the /TicketRules endpoint. |
halo_Free · Read-only | List confirm-closure rules via the /ConfirmClosure endpoint. |
halo_Free · Read-only | List journeys via the /Journey endpoint. |
halo_Free · Read-only | List qualifications via the /Qualification endpoint. |
halo_Free · Read-only | List ticket request-type groups via the /TicketTypeGroup endpoint. |
halo_Free · Read-only | List setup tabs via the /SetupTab endpoint. |
halo_Free · Read-only | List setup-tab groups via the /SetupTabGroup endpoint. |
halo_Free · Read-only | List tab names via the /Tabs endpoint. |
halo_Free · Read-only | List workflow targets via the /WorkflowTarget endpoint. |
Mailbox & Email Config
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Ingest an incoming email onto a ticket via the incomingemail/AddToTicket endpoint. |
halo_Pro · Destructive | Invoke the Mail/Azure endpoint, which connects/authorises an Azure (Microsoft 365) mailbox for HaloPSA mail processing. |
halo_Pro · Write | Create or update an email-store record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a formatted (templated) email record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an incoming-email record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a mailbox configuration (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a mailbox-credential record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update an outgoing-email record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a sales-mailbox configuration (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Write | Create or update a sales-mailbox detail record (HaloPSA POST is an upsert — include an "id" field to update an existing record). |
halo_Pro · Destructive | Delete an email-store record by numeric ID. |
halo_Pro · Destructive | Delete a formatted (templated) email record by numeric ID. |
halo_Pro · Destructive | Delete an incoming-email record by numeric ID. |
halo_Pro · Destructive | Delete a mailbox configuration by numeric ID. |
halo_Pro · Destructive | Delete a mailbox-credential record by numeric ID. |
halo_Pro · Destructive | Delete an outgoing-mail server configuration by numeric ID. |
halo_Pro · Destructive | Delete an outgoing-email record by numeric ID. |
halo_Pro · Destructive | Delete a sales-mailbox configuration by numeric ID. |
halo_Free · Read-only | Retrieve a single email-store record by numeric ID. |
halo_Free · Read-only | Retrieve a single formatted (templated) email record by numeric ID. |
halo_Free · Read-only | Retrieve a single incoming-email record by numeric ID. |
halo_Free · Read-only | Retrieve a single mailbox configuration by numeric ID. |
halo_Free · Read-only | Retrieve a single mailbox-credential record by numeric ID. |
halo_Free · Read-only | Retrieve a single outgoing-mail server configuration by numeric ID. |
halo_Free · Read-only | Retrieve a single sales-mailbox configuration by numeric ID. |
halo_Pro · Destructive | Invoke the Mail/Integrator/Azure endpoint, which runs the Azure mail-integrator connect/process action for HaloPSA mailbox ingestion. |
halo_Pro · Destructive | Invoke the Mail/Integrator/Google endpoint, which runs the Google (Gmail/Workspace) mail-integrator connect/process action for HaloPSA mailbox ingestion. |
halo_Pro · Destructive | Invoke the Mail/Integrator/IMAP endpoint, which runs the IMAP mail-integrator connect/process action for HaloPSA mailbox ingestion. |
halo_Pro · Destructive | Invoke the Mail/Integrator/Pop3 endpoint, which runs the POP3 mail-integrator connect/process action for HaloPSA mailbox ingestion. |
halo_Free · Read-only | List the email address book (users/contacts available as email recipients) configured in HaloPSA. |
halo_Free · Read-only | List email-store records in HaloPSA (stored/queued email items). |
halo_Free · Read-only | List formatted (templated) email records in HaloPSA. |
halo_Free · Read-only | List incoming-email records in HaloPSA (emails received into the system). |
halo_Free · Read-only | List mailbox configurations in HaloPSA (the mailboxes HaloPSA polls for inbound email). |
halo_Free · Read-only | List mailbox-credential records in HaloPSA (the stored auth credentials used to connect to mailboxes). |
halo_Free · Read-only | List the Outlook contacts associated with a HaloPSA mailbox via the Mailbox/{id}/OutlookContacts endpoint. |
halo_Free · Read-only | List outgoing-mail server configurations in HaloPSA (the SMTP/send profiles HaloPSA uses to send email). |
halo_Free · Read-only | List outgoing-email records in HaloPSA (emails sent/queued for sending by the system). |
halo_Free · Read-only | List sales-mailbox configurations in HaloPSA (mailboxes used for CRM/sales lead ingestion). |
halo_Free · Read-only | List sales-mailbox detail records in HaloPSA (the detailed per-mailbox sales configuration entries). |
halo_Pro · Destructive | Invoke the Mail/ProcessMail endpoint, which processes the specified queued mailbox items in HaloPSA (creating/updating tickets and firing notifications). |
halo_Pro · Destructive | Act on queued outgoing mail items by ID (POST /Outgoing). |
Notifications & Distribution
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update an AddressStore record (POST /Address). |
halo_Pro · Write | Create or update a distribution list (POST /DistributionLists). |
halo_Pro · Write | Create or update a distribution list log entry (POST /DistributionListsLog). |
halo_Pro · Write | Create or update an escalation/notification message (POST /Notifications). |
halo_Pro · Write | Create or update an event rule (POST /EventRule). |
halo_Pro · Write | Create or update a marketing open record (POST /MO). |
halo_Pro · Write | Create or update a marketing unsubscribe record (POST /MarketingUnsubscribe). |
halo_Pro · Write | Create or update an unsubscribed email service user record (POST /UnsubServiceEmails). |
halo_Pro · Destructive | Delete an AddressStore record by numeric ID (DELETE /Address/{id}). |
halo_Pro · Destructive | Delete a distribution list by numeric ID (DELETE /DistributionLists/{id}). |
halo_Pro · Destructive | Delete a distribution list log entry by numeric ID (DELETE /DistributionListsLog/{id}). |
halo_Pro · Destructive | Delete an escalation/notification message by ID (DELETE /Notifications/{id}). |
halo_Pro · Destructive | Delete an event definition by numeric ID (DELETE /Event/{id}). |
halo_Pro · Destructive | Delete an event rule by numeric ID (DELETE /EventRule/{id}). |
halo_Pro · Destructive | Delete a marketing open record by numeric ID (DELETE /MO/{id}). |
halo_Pro · Destructive | Delete a marketing unsubscribe record by numeric ID (DELETE /MarketingUnsubscribe/{id}). |
halo_Pro · Destructive | Delete a notification content record by numeric ID (DELETE /NotificationMessage/{id}). |
halo_Pro · Destructive | Delete an external (Teams) chat message record by numeric ID (DELETE /ExternalChatMessage/{id}). |
halo_Pro · Destructive | Delete an unsubscribed email service user record by numeric ID (DELETE /UnsubServiceEmails/{id}). |
halo_Free · Read-only | Retrieve a single AddressStore record by numeric ID (GET /Address/{id}). |
halo_Free · Read-only | Retrieve a single distribution list by numeric ID (GET /DistributionLists/{id}). |
halo_Free · Read-only | Retrieve a single distribution list log entry by numeric ID (GET /DistributionListsLog/{id}). |
halo_Free · Read-only | Retrieve a single escalation/notification message by ID (GET /Notifications/{id}). |
halo_Free · Read-only | Retrieve a single event by numeric ID (GET /Event/{id}). |
halo_Free · Read-only | Retrieve a single event rule by numeric ID (GET /EventRule/{id}). |
halo_Free · Read-only | Retrieve a single marketing open record by numeric ID (GET /MO/{id}). |
halo_Free · Read-only | Retrieve a single marketing unsubscribe record by numeric ID (GET /MarketingUnsubscribe/{id}). |
halo_Free · Read-only | Retrieve a single notification content record by numeric ID (GET /NotificationMessage/{id}). |
halo_Free · Read-only | Retrieve a single external (Teams) chat message by numeric ID (GET /ExternalChatMessage/{id}). |
halo_Free · Read-only | Retrieve a single unsubscribed email service user record by numeric ID (GET /UnsubServiceEmails/{id}). |
halo_Free · Read-only | List AddressStore records (GET /Address) — the marketing/distribution address book HaloPSA uses for bulk email. |
halo_Free · Read-only | List distribution lists (GET /DistributionLists) — the recipient groups HaloPSA uses for bulk/marketing email. |
halo_Free · Read-only | List distribution list log entries (GET /DistributionListsLog) — the send/activity history for HaloPSA distribution lists. |
halo_Free · Read-only | List escalation/notification messages (GET /Notifications) — the EscMsg records that drive HaloPSA escalation notifications. |
halo_Free · Read-only | List configured events (GET /Event) — the event definitions HaloPSA uses to trigger notifications and automation. |
halo_Free · Read-only | List event rules (GET /EventRule) — the conditions/criteria that gate HaloPSA event firing. |
halo_Free · Read-only | List marketing open records (GET /MO) — the email-open tracking records for HaloPSA marketing campaigns. |
halo_Free · Read-only | List marketing unsubscribe records (GET /MarketingUnsubscribe) — the opt-out list for HaloPSA marketing email. |
halo_Free · Read-only | List notification content records (GET /NotificationMessage) — the rendered notification message bodies HaloPSA has generated. |
halo_Free · Read-only | List external (Microsoft Teams) chat messages (GET /ExternalChatMessage) tracked by HaloPSA. |
halo_Free · Read-only | List unsubscribed email service users (GET /UnsubServiceEmails) — the service users who have opted out of HaloPSA email. |
halo_Free · Read-only | Undocumented HaloPSA endpoint (/MO/b) — exact semantics are not in the API spec; passes through raw. |
halo_Free · Read-only | Undocumented HaloPSA endpoint (/MO/r) — exact semantics are not in the API spec; passes through raw. |
halo_Pro · Destructive | Trigger processing of pending HaloPSA escalation/notification messages (POST /Notifications/process). |
halo_Pro · Destructive | Act on event records by ID (POST /Event). |
halo_Pro · Destructive | Send an external (Microsoft Teams) chat message via HaloPSA (POST /ExternalChatMessage). |
Instance & System Setup
| Tool | What it does |
|---|---|
halo_Pro · Write | Create an audit-log entry. |
halo_Pro · Write | Create or update a contract schedule plan (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update a dashboard link (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update a Halo news/announcement item (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update an organisation (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update a publish profile (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update a release note group (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update a view list group (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Destructive | Delete an audit-log entry by numeric ID. |
halo_Pro · Destructive | Delete a company/supplier record by numeric ID (HaloPSA models companies under the Supplier resource). |
halo_Pro · Destructive | Delete a contract schedule plan by numeric ID. |
halo_Pro · Destructive | Delete a dashboard link by numeric ID. |
halo_Pro · Destructive | Delete a Halo news/announcement item by numeric ID. |
halo_Pro · Destructive | Delete an NH server configuration record by numeric ID. |
halo_Pro · Destructive | Delete an organisation by numeric ID. |
halo_Pro · Destructive | Delete a publish profile by numeric ID. |
halo_Pro · Destructive | Delete a release note group by numeric ID. |
halo_Pro · Destructive | Delete a view list group by numeric ID. |
halo_Free · Read-only | Retrieve a single contract schedule plan by numeric ID. |
halo_Free · Read-only | Retrieve a single dashboard link by numeric ID. |
halo_Free · Read-only | Retrieve the available filter values for dashboard links. |
halo_Free · Read-only | Retrieve a single dashboard links repository entry by numeric ID. |
halo_Free · Read-only | Retrieve a single Halo news/announcement item by numeric ID. |
halo_Free · Read-only | Retrieve a single HaloPSA instance configuration record by numeric ID. |
halo_Free · Read-only | Retrieve a single module/feature setup record by numeric ID (HaloPSA models module setup under the Features resource). |
halo_Free · Read-only | Retrieve a single NH server configuration record by numeric ID. |
halo_Free · Read-only | Retrieve a single organisation by numeric ID. |
halo_Free · Read-only | Retrieve a single publish profile by numeric ID. |
halo_Free · Read-only | Retrieve a single release note group by numeric ID. |
halo_Free · Read-only | Retrieve a single report repository entry (AnalyzerProfile) by numeric ID. |
halo_Free · Read-only | Retrieve a single view list group by numeric ID. |
halo_Free · Read-only | List contract schedule plans with pagination. |
halo_Free · Read-only | List dashboard links with pagination. |
halo_Free · Read-only | List the dashboard links repository (shared/template dashboard links) with pagination. |
halo_Free · Read-only | List Halo news/announcement items with pagination. |
halo_Free · Read-only | List HaloPSA instance configuration records with pagination. |
halo_Free · Read-only | List module/feature setup records with pagination (HaloPSA models module setup under the Features resource). |
halo_Free · Read-only | List NH server configuration records with pagination. |
halo_Free · Read-only | List organisations with pagination. |
halo_Free · Read-only | List publish profiles with pagination. |
halo_Free · Read-only | List release note groups with pagination. |
halo_Free · Read-only | List the report repository (shared/template report AnalyzerProfiles) with pagination. |
halo_Free · Read-only | List the report categories available in the report repository. |
halo_Free · Read-only | List tenant configuration records with pagination. |
halo_Free · Read-only | List user change records with pagination. |
halo_Free · Read-only | List view list groups with pagination. |
halo_Pro · Write | Mark Halo news/announcement item(s) as read for the current user. |
halo_Pro · Write | Update HaloPSA instance configuration (POST is an upsert — include the 'id' field to target an existing instance record). |
halo_Pro · Write | Update module/feature setup (POST is an upsert — include the 'id' field to target an existing feature; HaloPSA models module setup under the Features resource). |
halo_Pro · Write | Update NH server configuration (POST is an upsert — include the 'id' field to target an existing record). |
halo_Pro · Write | Update tenant configuration (POST is an upsert — include the 'id' field to target an existing tenant record). |
Agents, Roles & Security
| Tool | What it does |
|---|---|
halo_Pro · Write | Create a new audit password field. |
halo_Pro · Destructive | Create a new certificate. |
halo_Pro · Write | Create a new custom button. |
halo_Pro · Write | Create a custom button audit record (logs a custom-button invocation/change). |
halo_Pro · Write | Create a new identity/OAuth application registration. |
halo_Pro · Write | Add federated credentials to an identity/OAuth application. |
halo_Pro · Destructive | Create a new key vault entry (stored secret/credential). |
halo_Pro · Destructive | Create a new LDAP/Active Directory connection. |
halo_Pro · Destructive | Create a new policy (HaloPSA models policies under the Priority resource). |
halo_Pro · Write | Create a new security question. |
halo_Pro · Destructive | Create a new single sign-on (SSO/SAML) application. |
halo_Pro · Write | Create a new user role. |
halo_Pro · Destructive | Delete a certificate by numeric ID. |
halo_Pro · Destructive | Delete a custom button by numeric ID. |
halo_Pro · Destructive | Delete an identity/OAuth application by numeric ID. |
halo_Pro · Destructive | Delete a key vault entry by numeric ID. |
halo_Pro · Destructive | Delete an LDAP/Active Directory connection by numeric ID. |
halo_Pro · Destructive | Delete a policy by numeric ID (HaloPSA models policies under the Priority resource). |
halo_Pro · Destructive | Delete a security question by numeric ID. |
halo_Pro · Destructive | Delete a single sign-on (SSO/SAML) application by numeric ID. |
halo_Pro · Destructive | Delete a user role by numeric ID. |
halo_Free · Read-only | Retrieve an agent's image/avatar by numeric agent ID. |
halo_Free · Read-only | Retrieve a single audit password field by numeric ID. |
halo_Free · Read-only | Retrieve a single certificate by numeric ID. |
halo_Free · Read-only | Retrieve a single custom button by numeric ID. |
halo_Free · Read-only | Retrieve a single identity/OAuth application by numeric ID. |
halo_Free · Read-only | Retrieve a single key vault entry by numeric ID. |
halo_Free · Read-only | Retrieve a single LDAP/Active Directory connection by numeric ID. |
halo_Free · Read-only | Retrieve a single policy by numeric ID (HaloPSA models policies under the Priority resource). |
halo_Free · Read-only | Retrieve a single security question by numeric ID. |
halo_Free · Read-only | Retrieve a single single sign-on (SSO/SAML) application by numeric ID. |
halo_Free · Read-only | Retrieve a team's image/avatar by numeric team ID. |
halo_Free · Read-only | Retrieve a single user role by numeric ID. |
halo_Free · Read-only | List audit password fields (password-field audit configuration) with pagination. |
halo_Free · Read-only | List certificates with pagination. |
halo_Free · Read-only | List custom buttons with pagination. |
halo_Free · Read-only | List identity/OAuth applications (the NHD identity application registrations) with pagination. |
halo_Free · Read-only | List key vault entries (stored secrets/credentials configuration) with pagination. |
halo_Free · Read-only | List LDAP/Active Directory connections with pagination. |
halo_Free · Read-only | List software licence roles (from the SoftwareLicenceRole resource) with pagination. |
halo_Free · Read-only | List security questions with pagination. |
halo_Free · Read-only | List the security-question validation configuration with pagination. |
halo_Free · Read-only | List service restrictions with pagination. |
halo_Free · Read-only | List single sign-on (SSO/SAML) applications with pagination. |
halo_Free · Read-only | List user roles with pagination. |
Lookups & Reference
| Tool | What it does |
|---|---|
halo_Pro · Write | Clear the server-side lookup cache (POST /Lookup/ClearCache). |
halo_Pro · Write | Create or update a currency (POST /Currency). |
halo_Pro · Write | Create or update a holiday / holiday-set entry (POST /Holiday). |
halo_Pro · Write | Create or update a language pack (POST /Languages). |
halo_Pro · Write | Create or update HaloPSA licence information (POST /LicenseInfo). |
halo_Pro · Write | Create or update a lookup value (POST /Lookup). |
halo_Pro · Write | Create or update a release type (POST /ReleaseType). |
halo_Pro · Write | Create or update a service category (POST /ServiceCategory). |
halo_Pro · Write | Create or update a tax (POST /Tax). |
halo_Pro · Write | Create or update a tax rule (POST /TaxRule). |
halo_Pro · Write | Create or update a custom language-pack translation override (POST /Translation). |
halo_Pro · Write | Create or update a workday / work-pattern entry (POST /Workday). |
halo_Pro · Destructive | Delete a currency by numeric ID (DELETE /Currency/{id}). |
halo_Pro · Destructive | Delete a holiday entry by numeric ID (DELETE /Holiday/{id}). |
halo_Pro · Destructive | Delete a language pack by numeric ID (DELETE /Languages/{id}). |
halo_Pro · Destructive | Delete a lookup value by numeric ID (DELETE /Lookup/{id}). |
halo_Pro · Destructive | Delete a release type by numeric ID (DELETE /ReleaseType/{id}). |
halo_Pro · Destructive | Delete a service category by numeric ID (DELETE /ServiceCategory/{id}). |
halo_Pro · Destructive | Delete a tax by numeric ID (DELETE /Tax/{id}). |
halo_Pro · Destructive | Delete a tax rule by numeric ID (DELETE /TaxRule/{id}). |
halo_Pro · Destructive | Delete a workday / work-pattern entry by numeric ID (DELETE /Workday/{id}). |
halo_Free · Read-only | Retrieve a single charge rate by numeric ID (GET /ChargeRate/{id}). |
halo_Free · Read-only | Retrieve a single currency by numeric ID (GET /Currency/{id}). |
halo_Free · Read-only | Retrieve a single holiday entry by numeric ID (GET /Holiday/{id}). |
halo_Free · Read-only | Retrieve a single language pack by numeric ID (GET /Languages/{id}). |
halo_Free · Read-only | Retrieve the licence-info password value (GET /LicenseInfo/password). |
halo_Free · Read-only | Retrieve a single lookup value by numeric ID (GET /Lookup/{id}). |
halo_Free · Read-only | Retrieve a single release type by numeric ID (GET /ReleaseType/{id}). |
halo_Free · Read-only | Retrieve a single resource type by numeric ID (GET /ResourceType/{id}). |
halo_Free · Read-only | Retrieve a single service category by numeric ID (GET /ServiceCategory/{id}). |
halo_Free · Read-only | Retrieve a single tax by numeric ID (GET /Tax/{id}). |
halo_Free · Read-only | Retrieve a single tax rule by numeric ID (GET /TaxRule/{id}). |
halo_Free · Read-only | Retrieve a single workday / work-pattern entry by numeric ID (GET /Workday/{id}). |
halo_Free · Read-only | List the language packs configured in HaloPSA (GET /Languages). |
halo_Free · Read-only | List HaloPSA licence information (GET /LicenseInfo). |
halo_Free · Read-only | List resource types (GET /ResourceType). |
halo_Free · Read-only | List custom language-pack translations (GET /Translation). |
SLA, Workflow & Approvals
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a ticket approval record (POST /TicketApproval). |
halo_Pro · Write | Create or update a schedule (POST /Schedule). |
halo_Pro · Write | Create or update an SLA (POST /SLA). |
halo_Pro · Destructive | Delete an approval process by numeric ID (DELETE /ApprovalProcess/{id}). |
halo_Pro · Destructive | Delete an approval process rule by numeric ID (DELETE /ApprovalProcessRule/{id}). |
halo_Pro · Destructive | Delete a ticket (fault) approval by its composite key (DELETE /TicketApproval/{id}&{seq}). |
halo_Pro · Destructive | Delete an SLA by numeric ID (DELETE /SLA/{id}). |
halo_Free · Read-only | Retrieve a single approval process rule by numeric ID (GET /ApprovalProcessRule/{id}). |
halo_Free · Read-only | Retrieve a single ticket (fault) approval by numeric ID (GET /TicketApproval/{id}). |
halo_Free · Read-only | Retrieve a single schedule by numeric ID (GET /Schedule/{id}). |
halo_Free · Read-only | Retrieve a single schedule occurrence by numeric ID (GET /ScheduleOccurrence/{id}). |
halo_Free · Read-only | List schedule occurrences (GET /ScheduleOccurrence). |
halo_Pro · Destructive | Act on schedule occurrences by ID (POST /ScheduleOccurrence). |
Views & Canned Text
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a view columns definition (POST /ViewColumns). |
halo_Pro · Write | Create or update a view filter (POST /ViewFilter). |
halo_Pro · Write | Create or update a view list (POST /ViewLists). |
halo_Pro · Destructive | Delete a view columns definition by numeric ID (DELETE /ViewColumns/{id}). |
halo_Pro · Destructive | Delete a view filter by numeric ID (DELETE /ViewFilter/{id}). |
halo_Pro · Destructive | Delete a view list by numeric ID (DELETE /ViewLists/{id}). |
halo_Pro · Write | Mark a canned text (predefined reply snippet) as a favourite for quick access (POST /CannedText/favourite). |
halo_Free · Read-only | Retrieve a single view columns definition by numeric ID (GET /ViewColumns/{id}). |
halo_Free · Read-only | Retrieve a single view filter by numeric ID (GET /ViewFilter/{id}). |
Integration Data Actions
| Tool | What it does |
|---|---|
halo_Pro · Destructive | Start an outbound export to Lansweeper via HaloPSA's connected integration (passthrough to POST /IntegrationData/Export/Lansweeper). |
halo_Free · Read-only | Format / normalize a JSON array using HaloPSA's IntegrationData helper (passthrough to POST /IntegrationData/FormatJsonArray). |
halo_Free · Read-only | Retrieve Amazon Seller data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/AmazonSeller). |
halo_Free · Read-only | Retrieve ArrowSphere data from HaloPSA's connected distributor integration (passthrough to GET /IntegrationData/Get/ArrowSphere). |
halo_Free · Read-only | Retrieve the Azure AD / Entra ID delta (incremental change) feed from HaloPSA's connected Azure AD integration (passthrough to GET /IntegrationData/Get/AzureAD/Delta). |
halo_Free · Read-only | Retrieve BeyondTrust authorization/session code data from HaloPSA's connected BeyondTrust integration (passthrough to GET /IntegrationData/Get/BeyondTrust/Code). |
halo_Free · Read-only | Retrieve the BigPanda device list from HaloPSA's connected BigPanda integration (passthrough to GET /IntegrationData/BigPanda/GetDeviceList). |
halo_Free · Read-only | Retrieve Cloud Marketplace data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/CloudMarketplace). |
halo_Free · Read-only | Retrieve Confluence data (spaces, pages) from HaloPSA's connected Confluence integration (passthrough to GET /IntegrationData/Get/Confluence). |
halo_Free · Read-only | Retrieve Datagate telecom billing data from HaloPSA's connected Datagate integration (passthrough to GET /IntegrationData/Get/Datagate). |
halo_Free · Read-only | Retrieve deleted-mail data from HaloPSA's connected mailbox integration (passthrough to GET /IntegrationData/Get/DeletedMail). |
halo_Free · Read-only | Retrieve Dicker Data distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/DickerData). |
halo_Free · Read-only | Retrieve Dynatrace monitoring data from HaloPSA's connected Dynatrace integration (passthrough to GET /IntegrationData/Get/Dynatrace). |
halo_Free · Read-only | Retrieve Etilize product-catalog data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Etilize). |
halo_Free · Read-only | Retrieve Microsoft Exchange calendar data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/ExchangeCalendars). |
halo_Free · Read-only | Retrieve Microsoft Exchange calendar data via EWS (Exchange Web Services) from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/ExchangeCalendars/EWS). |
halo_Free · Read-only | Retrieve Facebook data (pages, messages) from HaloPSA's connected Facebook integration (passthrough to GET /IntegrationData/Get/Facebook). |
halo_Free · Read-only | Retrieve Giacom cloud-marketplace data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Giacom). |
halo_Free · Read-only | Retrieve Google Business Profile data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/GoogleBusiness). |
halo_Free · Read-only | Retrieve HaloLink (Halo-to-Halo linked instance) data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/HaloLink). |
halo_Free · Read-only | Retrieve public-holiday data from HaloPSA's connected Holiday API integration (passthrough to GET /IntegrationData/Get/HolidayAPI). |
halo_Free · Read-only | Retrieve Icinga monitoring data (hosts, services, alerts) from HaloPSA's connected Icinga integration (passthrough to GET /IntegrationData/Get/Icinga). |
halo_Free · Read-only | Retrieve Ingram Micro distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/IngramMicro). |
halo_Free · Read-only | Retrieve Interact intranet data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Interact). |
halo_Free · Read-only | Retrieve intY (CASCADE cloud-marketplace) data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/intY). |
halo_Free · Read-only | Retrieve LogMeIn remote-access data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/LogMeIn). |
halo_Free · Read-only | Retrieve mail data from HaloPSA's connected mailbox integration (passthrough to GET /IntegrationData/Get/Mail). |
halo_Free · Read-only | Retrieve Mattermost data (teams, channels) from HaloPSA's connected Mattermost integration (passthrough to GET /IntegrationData/Get/Mattermost). |
halo_Free · Read-only | Retrieve the Microsoft SKU / subscribed-license catalog from HaloPSA's connected Microsoft integration (passthrough to GET /IntegrationData/Get/MicrosoftSkus). |
halo_Free · Read-only | Retrieve New Relic observability data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/NewRelic). |
halo_Free · Read-only | Retrieve Prometheus monitoring data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Prometheus). |
halo_Free · Read-only | Retrieve Quoter quoting data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Quoter). |
halo_Free · Read-only | Retrieve Rhipe (Pax8 EMEA) subscription data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Rhipe). |
halo_Free · Read-only | Retrieve sales-mailbox data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/SalesMailbox). |
halo_Free · Read-only | Retrieve a single sales mailbox by numeric ID from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/SalesMailbox/{id}). |
halo_Free · Read-only | Retrieve this HaloPSA instance's SAML Service Provider (SP) metadata (passthrough to GET /IntegrationData/SAML/SP/Metadata). |
halo_Free · Read-only | Retrieve Sherweb distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Sherweb). |
halo_Free · Read-only | Verify / retrieve Shopify connection data from HaloPSA's connected Shopify integration (passthrough to GET /IntegrationData/Get/ShopifyVerify). |
halo_Free · Read-only | Retrieve Snipe-IT asset-management data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/SnipeIT). |
halo_Free · Read-only | Retrieve TD SYNNEX StreamOne Ion data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/StreamOneIon). |
halo_Free · Read-only | Retrieve TD SYNNEX distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Synnex). |
halo_Free · Read-only | Retrieve Tech Data distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/TechData). |
halo_Free · Read-only | Retrieve Twitter / X data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Twitter). |
halo_Free · Read-only | Retrieve VMware Workspace ONE data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/VMWorkspace). |
halo_Free · Read-only | Retrieve WordPress.com data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/WordpressCom). |
halo_Free · Read-only | Retrieve self-hosted WordPress.org data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/WordpressOrg). |
halo_Free · Read-only | Retrieve Xensam software-asset-management data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Xensam). |
halo_Pro · Destructive | Import data from BeyondTrust into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/BeyondTrust). |
halo_Pro · Destructive | Import work items from Azure DevOps into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/DevOps). |
halo_Pro · Destructive | Import Exchange calendar data via EWS into HaloPSA (passthrough to POST /IntegrationData/Import/ExchangeCalendars/EWS). |
halo_Pro · Destructive | Import subscriptions from Ingram Micro into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/IngramMicro/Subscriptions). |
halo_Pro · Destructive | Import issues from Jira into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/Jira). |
halo_Pro · Destructive | Link a HaloPSA record to an Azure DevOps work item via the connected integration (passthrough to POST /IntegrationData/Link/DevOps). |
halo_Pro · Destructive | Link a HaloPSA record to a Jira issue via the connected integration (passthrough to POST /IntegrationData/Link/Jira). |
halo_Pro · Destructive | Move a mail item in the connected mailbox via HaloPSA's integration (passthrough to POST /IntegrationData/Move/Mail). |
halo_Pro · Destructive | Create a webhook in Confluence via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Confluence/create-webhook). |
halo_Pro · Destructive | Post / write Google Calendar data via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/GoogleCalendars). |
halo_Pro · Destructive | Post / write a customer to Liongard via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Liongard/Customer). |
halo_Pro · Destructive | Post / write metrics to Liongard via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Liongard/Metrics). |
halo_Pro · Destructive | Create a webhook in Mattermost via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Mattermost/create-webhook). |
halo_Pro · Destructive | Delete a webhook in Mattermost via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Mattermost/delete-webhook). |
halo_Pro · Destructive | Send a message through a Mattermost webhook via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Mattermost/send-webhook). |
halo_Pro · Write | Generate the Microsoft Teams app manifest for the HaloPSA Teams integration (passthrough to POST /IntegrationData/MicrosoftTeams/Manifest; request schema TeamsManifestCreate). |
halo_Pro · Destructive | Send a request to OpenAI via HaloPSA's connected OpenAI integration (passthrough to POST /IntegrationData/Post/OpenAi). |
halo_Pro · Destructive | Submit SAML Identity Provider (IdP) metadata to configure single sign-on in HaloPSA (passthrough to POST /IntegrationData/SAML/IdP/Metadata). |
halo_Free · Read-only | Search Azure DevOps work items via HaloPSA's connected Azure DevOps integration (passthrough to GET /IntegrationData/Search/DevOps). |
halo_Free · Read-only | Search Jira issues via HaloPSA's connected Jira integration (passthrough to GET /IntegrationData/Search/Jira). |
halo_Pro · Destructive | Remove the link between a HaloPSA record and an Azure DevOps work item (passthrough to POST /IntegrationData/Unlink/DevOps). |
halo_Pro · Destructive | Remove a HaloLink (Halo-to-Halo linked instance) linkage (passthrough to POST /IntegrationData/Unlink/HaloLink). |
halo_Pro · Destructive | Remove the link between a HaloPSA record and a Jira issue (passthrough to POST /IntegrationData/Unlink/Jira). |
halo_Free · Read-only | Validate the HaloPSA Jira integration connection (passthrough to GET /IntegrationData/Validate/Jira). |
KB, Projects & Collaboration
| Tool | What it does |
|---|---|
halo_Pro · Write | Approve (or record an approval decision on) a client contract. |
halo_Pro · Write | Book an appointment against an available slot. |
halo_Pro · Write | Bookmark (favourite) a saved report so it surfaces in the reporting shortcuts. |
halo_Pro · Write | Create or update a live chat session header (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update a chatbot conversation flow (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update chatbot matching data (intent/keyword matching used to route conversations). |
halo_Pro · Write | Create or update a chat profile (a chatbot channel/behaviour configuration). |
halo_Pro · Write | Create or update a FAQ list (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update the HaloPSA instance's MCP (Model Context Protocol) server configuration (POST api/mcp — upsert). |
halo_Pro · Write | Create or update project setup lines (the task/phase template lines that seed a project). |
halo_Pro · Write | Create or update a saved report / analyzer profile (HaloPSA POST is an upsert — include an 'id' field to update an existing report). |
halo_Pro · Write | Create or update a supplier contract (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Write | Create or update an AI virtual agent (HaloPSA POST is an upsert — include an 'id' field to update). |
halo_Pro · Destructive | Delete a calendar appointment by numeric ID. |
halo_Pro · Destructive | Delete a chat profile by numeric ID. |
halo_Pro · Destructive | Delete a client contract (ClientContract / contract header) by numeric ID. |
halo_Pro · Destructive | Delete an external link by numeric ID. |
halo_Pro · Destructive | Delete a FAQ list by numeric ID. |
halo_Pro · Destructive | Delete a knowledge base article by numeric ID. |
halo_Pro · Destructive | Delete the HaloPSA instance's MCP (Model Context Protocol) server configuration (DELETE api/mcp). |
halo_Pro · Destructive | Delete a project by numeric ID. |
halo_Pro · Destructive | Delete a release by numeric ID. |
halo_Pro · Destructive | Delete a release (product) component by numeric ID. |
halo_Pro · Destructive | Delete a remote support session record by numeric ID. |
halo_Pro · Destructive | Delete a saved report / analyzer profile by numeric ID. |
halo_Pro · Destructive | Delete a secure secret link by numeric ID. |
halo_Pro · Destructive | Delete a supplier contract by numeric ID. |
halo_Pro · Destructive | Delete an AI virtual agent by its UUID/GUID. |
halo_Pro · Write | Generate recurring / scheduled appointments from their definitions. |
halo_Free · Read-only | Retrieve the downtime calendar — scheduled/recorded downtime events rendered for a calendar view (GET api/Downtime/DowntimeCalendar). |
halo_Free · Read-only | Retrieve a single external link by numeric ID (GET api/ExternalLink/{id}). |
halo_Free · Read-only | Retrieve a single anonymously-accessible (self-service portal) knowledge base article by its slug (GET api/KBArticleAnon/{slug}). |
halo_Free · Read-only | Retrieve the HaloPSA instance's MCP (Model Context Protocol) server configuration (GET api/mcp). |
halo_Free · Read-only | Retrieve a single release (product) component by numeric ID (GET api/ProductComponent/{id}). |
halo_Free · Read-only | Retrieve a single secure secret link by numeric ID (GET api/SecureSecretLink/{id}). |
halo_Free · Read-only | Retrieve a single AI virtual agent by its UUID/GUID (GET api/VirtualAgent/{id}). |
halo_Free · Read-only | List anonymously-accessible (self-service portal) knowledge base articles with pagination (GET api/KBArticleAnon). |
halo_Free · Read-only | List release (product) branches with pagination (GET api/ProductBranch). |
halo_Free · Read-only | List AI virtual agents configured in HaloPSA with pagination (GET api/VirtualAgent). |
halo_Pro · Write | Get the next auto-generated reference for a client contract. |
halo_Pro · Write | Get the next auto-generated reference for a supplier contract. |
halo_Pro · Write | Produce a printable rendering of a saved report. |
halo_Pro · Write | Query projects against a server-side view/filter definition. |
halo_Pro · Destructive | Execute an automation runbook by its numeric runbook ID. |
halo_Pro · Destructive | Send an 'is typing' presence signal into a live chat conversation. |
halo_Pro · Write | Record a helpful/not-helpful vote on a knowledge base article. |
Scripts & Automation
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a call script (an agent-facing scripted question/answer flow used when logging a ticket). |
halo_Pro · Write | Create or update PowerShell script criteria (targeting rules for a script). |
halo_Pro · Destructive | Create a PowerShell script processing record — this queues/dispatches a PowerShell script for execution against its targets. |
halo_Pro · Destructive | Delete a call script by numeric ID. |
halo_Pro · Destructive | Delete a PowerShell script by numeric ID. |
halo_Pro · Destructive | Delete a PowerShell script criteria record by numeric ID. |
halo_Pro · Destructive | Delete a PowerShell script processing record by numeric ID. |
halo_Free · Read-only | Retrieve a single PowerShell script criteria record by numeric ID. |
halo_Free · Read-only | Retrieve a single PowerShell script processing record by numeric ID. |
halo_Free · Read-only | List PowerShell script criteria — the targeting/matching rules that decide which devices or tickets a PowerShell script applies to. |
Tickets & Collaboration Extras
| Tool | What it does |
|---|---|
halo_Pro · Write | Register a completed direct-to-S3 attachment upload (api/Attachment/PresignedURLUploadComplete). |
halo_Pro · Write | Create or update an AI suggestion rule. |
halo_Pro · Write | Create or update a ticket through the object endpoint (api/Tickets/Object), which accepts a single ticket object rather than the array HaloPSA's main ticket endpoint expects. |
halo_Pro · Write | Create or update a timesheet event — an entry on an agent's timesheet such as logged work, a break, an appointment or holiday. |
halo_Pro · Write | Create or update a to-do group (checklist template). |
halo_Pro · Write | Create or update a stored transcription record. |
halo_Pro · Destructive | Delete an AI suggestion rule by numeric ID. |
halo_Pro · Destructive | Delete a CAB (Change Advisory Board) meeting by numeric ID. |
halo_Pro · Destructive | Delete a service status record by numeric ID. |
halo_Pro · Destructive | Delete a ticket by numeric ID. |
halo_Pro · Destructive | Delete a timesheet event by numeric ID. |
halo_Pro · Destructive | Delete a to-do group (checklist template) by numeric ID. |
halo_Pro · Destructive | Delete a stored transcription by numeric ID. |
halo_Free · Read-only | Retrieve a single AI suggestion rule by numeric ID. |
halo_Free · Read-only | Retrieve an inline attachment image using a HaloPSA-issued access token (api/Attachment/image). |
halo_Free · Read-only | Retrieve an attachment served through the HaloPSA NHServer (on-premises agent/file-server) route by numeric attachment ID, using a HaloPSA-issued access token (api/Attachment/nhserver/{id}). |
halo_Pro · Write | Request an S3 presigned upload URL for a large attachment (api/Attachment/GetS3PresignedURL). |
halo_Free · Read-only | Retrieve a single telephony call log entry by numeric ID. |
halo_Free · Read-only | Retrieve the change management calendar — the scheduled change windows and change requests plotted against dates. |
halo_Free · Read-only | Retrieve a single service status record by numeric ID. |
halo_Free · Read-only | Retrieve the status-notification subscription for a service by its numeric service ID. |
halo_Free · Read-only | Retrieve the sales mailbox configuration used for ticket intake — the mailbox HaloPSA monitors to raise sales/opportunity tickets from inbound email. |
halo_Free · Read-only | Retrieve the Zapier ticket feed — the trimmed ticket payload HaloPSA exposes for Zapier polling triggers. |
halo_Free · Read-only | Retrieve a single timesheet event by numeric ID. |
halo_Free · Read-only | Retrieve the timesheet forecasting view — HaloPSA's projection of upcoming agent capacity and committed work, used for resource planning. |
halo_Free · Read-only | Retrieve the organisation-wide agent timesheet capacity grid — the per-agent, per-day utilisation view HaloPSA shows on the timesheet screen. |
halo_Free · Read-only | Retrieve a single to-do group (checklist template) by numeric ID. |
halo_Free · Read-only | Retrieve a single transcription by numeric ID. |
halo_Free · Read-only | List AI suggestion rules — the rules that let HaloPSA propose an outcome, template or resolution on a ticket based on matching historical tickets. |
halo_Free · Read-only | List to-do groups — the reusable checklist templates that seed per-ticket to-do items. |
halo_Free · Read-only | List stored transcriptions — the speech-to-text results HaloPSA produces for recorded calls and audio attachments. |
halo_Pro · Write | Cascade a parent ticket's update down to its child tickets (api/Tickets/processchildren). |
halo_Pro · Write | Query tickets against a server-side view/filter definition. |
halo_Pro · Write | Mark a ticket's linked project as billable (api/Tickets/SetBillableProject). |
halo_Pro · Write | Subscribe to (or unsubscribe from) status notifications for a service. |
halo_Pro · Write | Upload a document attachment via the document-specific endpoint (api/Attachment/document). |
Billing Extras
| Tool | What it does |
|---|---|
halo_Pro · Write | Add lines to a recurring invoice template (POSTs api/RecurringInvoice/Lines). |
halo_Pro · Write | Create or update a stock consignment (HaloPSA POST is an upsert — include an 'id' field to update an existing consignment). |
halo_Pro · Write | Create or update a Microsoft CSP consumption record (HaloPSA POST is an upsert — include an 'id' field to update an existing row). |
halo_Pro · Write | Create or update an invoice change record (HaloPSA POST is an upsert — include an 'id' field to update an existing record). |
halo_Pro · Destructive | Delete a stock consignment by numeric ID. |
halo_Pro · Destructive | Delete a single Microsoft CSP consumption record by numeric ID. |
halo_Pro · Destructive | Delete a Microsoft CSP consumption PARENT record and the consumption rows grouped beneath it (DELETEs api/CSPConsumptionData/Parent/{id}). |
halo_Pro · Destructive | Delete an invoice by numeric ID. |
halo_Pro · Destructive | Delete an invoice payment by numeric ID. |
halo_Pro · Destructive | Delete a client pre-pay history entry by numeric ID. |
halo_Pro · Destructive | Delete a supplier purchase order by numeric ID. |
halo_Pro · Destructive | Delete a quotation by numeric ID. |
halo_Pro · Destructive | Delete a recurring invoice template by ID. |
halo_Pro · Destructive | Delete a sales order by numeric ID. |
halo_Free · Read-only | Retrieve a single stock consignment by numeric ID. |
halo_Free · Read-only | Retrieve a single Microsoft CSP consumption record by numeric ID. |
halo_Free · Read-only | Retrieve a single invoice payment by numeric ID. |
halo_Free · Read-only | Retrieve a single client pre-pay history entry by numeric ID. |
halo_Free · Read-only | List stock consignment headers — the dispatch/return documents that move stock out against a sales order. |
halo_Free · Read-only | List Microsoft CSP consumption (metered usage) records imported for billing. |
halo_Free · Read-only | List invoice change records — the audit trail of amendments made to invoices and invoice lines. |
halo_Free · Read-only | List invoice detail lines directly from api/Invoice/lines — a flat feed of invoice line records across invoices, rather than lines nested under one invoice. |
halo_Free · Read-only | List pro-rata invoice detail rows — the part-period charges generated when a recurring invoice line starts or changes mid-cycle. |
halo_Free · Read-only | List sales order line records from api/OrderLine — a flat feed of order lines across sales orders. |
halo_Pro · Write | Run a bulk manage operation over Microsoft CSP consumption data (POSTs api/CSPConsumptionData/manage). |
halo_Pro · Write | Apply a bulk pricing change to Microsoft CSP subscriptions (POSTs api/CSPSubscriptionPricing/manage). |
Assets & Stock Extras
| Tool | What it does |
|---|---|
halo_Pro · Write | Allocate a new accounting-system ID for a catalogue item (POSTs api/Item/NewAccountsId). |
halo_Pro · Write | Create or update an asset change record — the audit entry describing a change to an asset, its user assignment, or a licence allocation (HaloPSA POST is an upsert — include an 'id' field to update an existing record). |
halo_Pro · Write | Create or update a database (parts) lookup definition (HaloPSA POST is an upsert — include an 'id' field to update an existing lookup). |
halo_Pro · Write | Record a confirmation that a database (parts) lookup result was accepted on a ticket or form (HaloPSA POST is an upsert — include an 'id' field to update an existing confirmation). |
halo_Pro · Write | Create or update an item stock record — the quantity of an item held in a particular stock bin or location (HaloPSA POST is an upsert — include an 'id' field to update an existing record). |
halo_Pro · Destructive | Delete an asset (device / configuration item) by numeric ID. |
halo_Pro · Destructive | Delete a database (parts) lookup definition by numeric ID. |
halo_Pro · Destructive | Delete a catalogue item (product/part) by numeric ID. |
halo_Pro · Destructive | Delete an item-to-accounting-code link by numeric ID. |
halo_Pro · Destructive | Delete an item stock record by numeric ID. |
halo_Pro · Destructive | Delete a software licence record by numeric ID. |
halo_Free · Read-only | Retrieve a single database (parts) lookup definition by numeric ID. |
halo_Free · Read-only | Retrieve a single database (parts) lookup confirmation by numeric ID. |
halo_Free · Read-only | Retrieve a single item-to-accounting-code link by numeric ID. |
halo_Free · Read-only | Retrieve a single item stock record by numeric ID. |
halo_Free · Read-only | Retrieve a single item stock history entry by numeric ID. |
halo_Free · Read-only | Retrieve a single item-to-supplier link by numeric ID. |
halo_Free · Read-only | Retrieve a single stock trace record by numeric ID. |
halo_Free · Read-only | List configured database (parts) lookups — the SQL-backed lookups that resolve external part, price or reference data into HaloPSA fields. |
halo_Free · Read-only | List software licence change records — the audit trail of seat count and allocation changes against software licences, INCLUDING Microsoft CSP / M365 subscription seat-count history (Halo stores CSP subscriptions as Software Licence records, so a subscription's seat changes land here). |
halo_Pro · Destructive | Bulk-migrate item accounting-code links from one accounting configuration to another (POSTs api/ItemAccountsLink/Migrate). |
halo_Pro · Write | Execute a configured database (parts) lookup and return the matched values (POSTs api/DatabaseLookup/run). |
CRM Extras
| Tool | What it does |
|---|---|
halo_Pro · Write | Create or update a contact group — a named list of contacts used for marketing and bulk communication (HaloPSA POST is an upsert — include an 'id' field to update an existing group). |
halo_Pro · Write | Create or update an e-commerce order record (HaloPSA POST is an upsert — include an 'id' field to update an existing order). |
halo_Pro · Write | Create or update a customer satisfaction (CSAT) feedback record (HaloPSA POST is an upsert — include an 'id' field to update an existing record). |
halo_Pro · Destructive | Delete a contact group by numeric ID. |
halo_Pro · Destructive | Remove a contact from a contact group by deleting the membership record ID. |
halo_Pro · Destructive | Delete an e-commerce order by numeric ID. |
halo_Pro · Destructive | Delete a customer satisfaction (CSAT) feedback record by numeric ID. |
halo_Pro · Destructive | Delete a sales opportunity by numeric ID. |
halo_Pro · Destructive | Delete a client site by numeric ID. |
halo_Pro · Destructive | Delete an end user / contact by numeric ID. |
halo_Free · Read-only | Retrieve a single contact group by numeric ID. |
halo_Free · Read-only | Retrieve a single contact-group membership record by numeric ID. |
halo_Free · Read-only | Retrieve the user record for the identity the current API credentials authenticate as (api/Users/me). |
halo_Free · Read-only | Retrieve a single e-commerce order by numeric ID. |
halo_Free · Read-only | Retrieve a single customer satisfaction (CSAT) feedback record by numeric ID. |
halo_Free · Read-only | Retrieve the configured feedback (CSAT survey) message shown to customers when they are asked to rate a ticket. |
halo_Free · Read-only | List contact-group membership records — the rows linking contacts (users) to contact groups. |
halo_Free · Read-only | List e-commerce orders imported from a connected shop (Shopify, Adobe Commerce, Amazon and similar). |
halo_Free · Read-only | List the sites that act as stock bins / stock locations (api/Site/StockBins). |
halo_Pro · Write | Register that an opportunity has been viewed (POSTs api/Opportunities/View). |
More in Connector guides
Connect Acronis Cyber Protect CloudConnect Action1Connect AddigyConnect AlertOpsStill need help? Ask the team