Skip to main content
Connector guides

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:

FamilyExamples of what the AI can do
Tickets & service deskSearch, create, and update tickets; actions, SLAs, approval processes, changes, ticket filters
Clients & CRMClients, sites, users, address book, CRM records, call logs, mail campaigns
AssetsAssets, asset groups, discovery results
Contracts & billingContracts, contract rules and schedules, invoices, CSP invoices, billing templates, accounting details
SalesQuotations, sales orders, products and items, purchase orders, suppliers
ProjectsProjects and project tickets
Knowledge & contentKnowledge base, FAQ lists, canned text, email and PDF templates
Reporting & analyticsReports, custom queries, custom tables, analytics summaries
Scheduling & timeAppointments, timesheets, downtime, service availability
Automation & adminWorkflows, 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)

  1. In HaloPSA, go to Configuration > Integrations > Halo API, click View Applications, and create a new application.
  2. Set Authentication Method to Authorisation Code (Native Application), choose Use a client secret for the token request, and enable Allow Agent Logins.
  3. 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).
  4. On the Permissions tab, enable only the scopes required for the tools you want to use (see the permission summary below).
  5. Copy the Client ID and one-time Client Secret, then return to StackJack and click Authorize to complete the flow.

Option B — Client Credentials

  1. 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).
  2. 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.
  3. 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.
  4. 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.
  5. 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:

AreaPermissions
Ticketsread:tickets / edit:tickets
Customersread:customers / edit:customers
Assetsread:assets / edit:assets
Contractsread:contracts / edit:contracts
Invoicesread:invoices / edit:invoices
Projectsread:projects / edit:projects
Knowledge Baseread:kb / edit:kb
Reportingread:reporting / edit:reporting
Timesheetsread:timesheets / edit:timesheets
Suppliersread:suppliers / edit:suppliers
Quotesread:quotes / edit:quotes
Itemsread:items / edit:items
Purchase Ordersread:pos / edit:pos
Sales Ordersread:sos / edit:sos
Calendarread:calendar / edit:calendar
CRMread:sales / edit:sales
Software/Releasesread: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

  1. In the StackJack portal, go to Connectors and find the HaloPSA card.
  2. Optional: click How To Connect for the in-portal version of this guide.
  3. Click Configure.
  4. Fill in the fields:
FieldWhat to enter
Authentication MethodAuthorization Code (User OAuth) — Recommended or Client Credentials
Instance URLYour HaloPSA URL, e.g. https://yourcompany.halopsa.com. StackJack derives your Halo tenant name from the subdomain automatically.
Client IDFrom the HaloPSA API application
Client SecretFrom 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
  1. 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:

  1. The member signs into StackJack, opens the Connectors page, and finds the HaloPSA card in their Your personal sign-ins section.
  2. 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.)
  3. Clicking Connect reuses your OAuth application — the member signs into HaloPSA with their own credentials.
  4. 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.
  5. 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

BehaviorDetail
Request pacingStackJack 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 sizeList tools return at most 200 records per page; use page parameters to fetch more.
Long-running reportsHalo report generation can take minutes; StackJack allows up to 3 minutes per request.
Token lifecycleAccess 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

SymptomLikely cause and fix
missing_refresh_token error after authorizingThe 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 errorsThe 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 Disabled3 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 HaloUpdate 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

ToolWhat it does
halo_add_action
Free · Write
Add an action (note / email / reply / internal note / time entry / status change) to an existing ticket.
halo_add_action_reaction
Pro · Write
Add an emoji reaction to a ticket action.
halo_add_internal_note
Free · Write
Add a private/internal note to a ticket — hidden from the end user/customer.
halo_bulk_change_ticket_status
Pro · Destructive
Change the status of up to 50 tickets in one call, with per-ticket read-back verification.
halo_change_ticket_status_with_note
Free · Write
Change a ticket's status and record an audit-trail note.
halo_create_draft
Pro · Write
Create a draft ticket or action.
halo_create_ticket
Free · Write
Create a new helpdesk ticket.
halo_delete_action
Pro · Destructive
Delete a ticket action (note, email, or time entry).
halo_get_action
Free · Read-only
Retrieve full details for a single action (note, email, or time entry).
halo_get_ticket
Free · Read-only
Retrieve a single ticket by numeric ID.
halo_list_actions
Free · Read-only
List ticket actions (notes, emails, time entries) with optional filters.
halo_list_ticket_actions
Free · Read-only
Fetch all actions for a single ticket in one call.
halo_list_ticket_types
Free · Read-only
List all available ticket types with ticket counts.
halo_list_tickets
Free · Read-only
List tickets with optional filters.
halo_log_time
Free · Write
Log work time on a ticket.
halo_review_action
Pro · Write
Manager approval/rejection of a ticket action (typically a time entry).
halo_search_tickets
Free · Read-only
Full-text search across ticket summaries, details, and action notes.
halo_send_email_reply
Free · Write
Send an outbound email reply on a ticket.
halo_update_action
Free · Write
Update an existing action.
halo_update_ticket
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_vote_ticket
Pro · Write
Submit a vote on a ticket.

Clients

ToolWhat it does
halo_create_client
Pro · Write
Create a new client (customer organization) record.
halo_get_client
Free · Read-only
Retrieve full details for a single client by numeric ID.
halo_list_clients
Free · Read-only
List all clients (customer organizations) with pagination.
halo_list_users
Free · Read-only
List end users (contacts), optionally filtered by client.
halo_search_clients
Free · Read-only
Search clients by name or reference number.
halo_update_client
Pro · Write
Update an existing client's fields such as name, contact details, or custom fields.

Assets

ToolWhat it does
halo_create_asset
Pro · Write
Create a new asset (device, hardware, or software) record.
halo_get_asset
Free · Read-only
Retrieve full details for a single asset by numeric ID.
halo_get_asset_next_tag
Free · Read-only
Retrieve the next available asset tag number from HaloPSA's auto-numbering sequence.
halo_list_asset_changes
Free · Read-only
List change history for assets.
halo_list_asset_software
Free · Read-only
List software discovered on assets, optionally filtered by device.
halo_list_asset_software_versions
Free · Read-only
List software version records across assets.
halo_list_asset_types
Free · Read-only
List all available asset types defined in HaloPSA.
halo_list_assets
Free · Read-only
List assets (devices, hardware, software) with optional filters for client and asset type.
halo_list_device_licences
Free · Read-only
List software licences assigned to devices/assets.
halo_search_assets
Free · Read-only
Search assets by name, serial number, or asset tag.
halo_update_asset
Pro · Write
Update an existing asset's fields such as status, assignment, or custom fields.

Agents & Teams

ToolWhat it does
halo_clear_agent_cache
Pro · Write
Clear the cached agent data in HaloPSA.
halo_get_agent
Free · Read-only
Retrieve full details for a single agent by numeric ID.
halo_get_agent_me
Free · Read-only
Retrieve details for the currently authenticated agent.
halo_list_agents
Free · Read-only
List helpdesk agents (technicians) with optional team and department filters.
halo_list_teams
Free · Read-only
List all teams defined in HaloPSA.
halo_search_agents
Free · Read-only
Search agents (technicians) by name or email.

Contracts

ToolWhat it does
halo_create_contract
Pro · Write
Create a new client contract/agreement.
halo_get_contract
Free · Read-only
Retrieve full details for a single contract by numeric ID, including contract lines and billing items.
halo_get_supplier_contract
Free · Read-only
Retrieve full details for a single supplier contract by numeric ID.
halo_list_charge_rates
Free · Read-only
List all charge rates defined in HaloPSA.
halo_list_contracts
Free · Read-only
List contracts/agreements with optional client filter.
halo_list_invoices
Free · Read-only
List invoices with optional client and date filters.
halo_list_supplier_contracts
Free · Read-only
List supplier contracts/agreements with optional filters and pagination.

Invoices

ToolWhat it does
halo_create_invoice
Pro · Write
Create a new invoice.
halo_generate_invoice_pdf
Pro · Write
Generate a PDF document for an invoice.
halo_get_invoice
Free · Read-only
Retrieve a single invoice by numeric ID.
halo_list_invoice_lines
Free · Read-only
List invoice line items.
halo_list_invoice_payments
Free · Read-only
List invoice payments with optional filters.
halo_record_invoice_payment
Pro · Write
Record a payment against an invoice.
halo_update_invoice
Pro · Write
Update an EXISTING invoice by fetch-merge-write.
halo_void_invoice
Pro · Destructive
Void an existing invoice by ID.

Knowledge Base

ToolWhat it does
halo_create_kb_article
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_get_kb_article
Free · Read-only
Retrieve full details for a single knowledge base article by numeric ID.
halo_list_kb_articles
Free · Read-only
List knowledge base articles with pagination.
halo_search_kb
Free · Read-only
Search the knowledge base for articles matching a query.
halo_update_kb_article
Pro · Destructive
Overwrite an existing knowledge base article.

Projects

ToolWhat it does
halo_create_project
Pro · Write
Create a new project.
halo_get_project
Free · Read-only
Retrieve full details for a single project by numeric ID.
halo_list_project_tasks
Free · Read-only
List tickets/tasks associated with a specific project.
halo_list_projects
Free · Read-only
List projects with optional client filter.
halo_update_project
Pro · Write
Update an existing project's fields such as name, dates, status, or budget.

Reports

ToolWhat it does
halo_create_report_pdf
Pro · Write
Generate a PDF from a saved report.
halo_get_report_parameters
Free · Read-only
Discover the parameters/filters of a saved report so it can be run parameterized.
halo_list_reports
Free · Read-only
List all saved reports available in HaloPSA.
halo_run_report
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

ToolWhat it does
halo_get_sla
Free · Read-only
Get full SLA definition by ID including response time targets, resolution time targets, priority-based conditions, and applicable hours.
halo_list_slas
Free · Read-only
List all SLA (Service Level Agreement) definitions configured in HaloPSA.

Sites

ToolWhat it does
halo_create_site
Pro · Write
Create a new site (physical location) record.
halo_get_site
Free · Read-only
Retrieve full details for a single site by numeric ID.
halo_list_sites
Free · Read-only
List sites (physical locations), optionally filtered by client.
halo_update_site
Pro · Write
Update an existing site's fields such as name, address, or contact information.

Users

ToolWhat it does
halo_create_user
Pro · Write
Create a new client end user (contact) record.
halo_get_user
Free · Read-only
Retrieve full details for a single end user (contact) by numeric ID.
halo_search_users
Free · Read-only
Search end users (contacts) by name or email.
halo_update_user
Pro · Write
Update an existing end user's (contact's) fields such as name, email, phone, or site assignment.
halo_update_user_prefs
Pro · Write
Update preferences for an end user (contact).

Timesheets

ToolWhat it does
halo_create_timesheet
Pro · Write
Create a new timesheet entry.
halo_get_my_timesheets
Free · Read-only
Retrieve timesheet entries for the currently authenticated agent.
halo_get_timesheet
Free · Read-only
Retrieve a single timesheet entry by numeric ID.
halo_list_timesheets
Free · Read-only
List individual time entries with optional filters for agent, client, and date range.

Lookups

ToolWhat it does
halo_get_lookup_values
Free · Read-only
Retrieve values for a specific lookup list by numeric lookup ID.
halo_list_categories
Free · Read-only
List all ticket categories configured in the system.
halo_list_currencies
Free · Read-only
List all currencies configured in HaloPSA.
halo_list_outcomes
Free · Read-only
List all action outcome types configured in the system.
halo_list_priorities
Free · Read-only
List all priority levels configured in the system.
halo_list_statuses
Free · Read-only
List all ticket statuses configured in the system.
halo_list_tax_rules
Free · Read-only
List all tax rules configured in HaloPSA.
halo_list_taxes
Free · Read-only
List all tax configurations defined in HaloPSA.

Categories

ToolWhat it does
halo_create_category
Pro · Write
Create a new ticket category.
halo_delete_category
Pro · Destructive
Permanently delete a category record by numeric ID.
halo_update_category
Pro · Write
Update an existing category.

Suppliers

ToolWhat it does
halo_create_supplier
Pro · Write
Create a new supplier/vendor record.
halo_create_supplier_user
Pro · Write
Create a new supplier-side user (contact) attached to an existing supplier.
halo_get_supplier
Free · Read-only
Retrieve a single supplier by numeric ID.
halo_list_suppliers
Free · Read-only
List suppliers/vendors with optional filters.

Quotations

ToolWhat it does
halo_add_quotation_lines
Pro · Write
Append NEW line items to an existing quotation (e.g. bulk quote-import workflows).
halo_approve_quotation
Pro · Write
Approve or reject a quotation.
halo_create_quotation
Pro · Write
Create a new quotation/quote.
halo_get_quotation
Free · Read-only
Retrieve a single quotation by numeric ID.
halo_list_quotations
Free · Read-only
List quotations/quotes with optional filters.
halo_remove_quotation_lines
Pro · Destructive
Remove one or more EXISTING line items from a quotation.
halo_update_quotation_lines
Pro · Write
Update EXISTING line items on a quotation (change pricing/quantity on lines that already exist).
halo_view_quotation
Free · Read-only
View a quotation in a rendered/presentable format.

Items & Stock

ToolWhat it does
halo_create_item
Pro · Write
Create a new product/item in the catalogue.
halo_create_item_account_link
Pro · Write
Create a link between an item and an accounting system account.
halo_create_item_group
Pro · Write
Create a new item group/category for organising products in the catalogue.
halo_create_item_supplier_link
Pro · Write
Link a supplier to an item/product.
halo_create_stock_bin
Pro · Write
Create a new stock bin/warehouse location for storing inventory.
halo_delete_item_group
Pro · Destructive
Delete an item group by numeric ID.
halo_delete_item_supplier_link
Pro · Destructive
Remove a supplier link from an item by numeric link ID.
halo_delete_stock_bin
Pro · Destructive
Delete a stock bin/warehouse location by numeric ID.
halo_get_item
Free · Read-only
Retrieve a single product/item by numeric ID.
halo_get_item_group
Free · Read-only
Retrieve a single item group by numeric ID.
halo_get_stock_bin
Free · Read-only
Retrieve a single stock bin/warehouse location by numeric ID.
halo_list_item_account_links
Free · Read-only
List accounting integation links for items.
halo_list_item_groups
Free · Read-only
List item groups/categories used to organise products in the catalogue.
halo_list_item_stock
Free · Read-only
List stock levels for items/products.
halo_list_item_stock_history
Free · Read-only
List stock level history for items, showing how inventory quantities have changed over time.
halo_list_item_suppliers
Free · Read-only
List supplier links for items/products.
halo_list_items
Free · Read-only
List products/items in the catalogue with optional search filter.
halo_list_stock_bins
Free · Read-only
List stock bin/warehouse locations where inventory is stored.
halo_list_stock_traces
Free · Read-only
List stock trace records showing the movement history of inventory items.

Purchase Orders

ToolWhat it does
halo_confirm_receipt
Pro · Destructive
Confirm receipt of goods on a purchase order.
halo_create_purchase_order
Pro · Write
Create a new purchase order.
halo_get_purchase_order
Free · Read-only
Retrieve a single purchase order by numeric ID.
halo_list_purchase_orders
Free · Read-only
List purchase orders with optional filters.

Sales Orders

ToolWhat it does
halo_create_sales_order
Pro · Write
Create a NEW sales order.
halo_get_sales_order
Free · Read-only
Retrieve a single sales order by numeric ID.
halo_list_sales_orders
Free · Read-only
List sales orders with optional filters.
halo_update_sales_order_lines
Pro · Destructive
Update EXISTING line items on a sales order (change price, quantity or text on lines that already exist).

Finance

ToolWhat it does
halo_create_expense
Pro · Write
Create a new expense record.
halo_create_prepay_entry
Pro · Write
Create a new prepay/retainer entry for a client.
halo_create_recurring_invoice
Pro · Write
Create a new recurring invoice template for automated billing.
halo_create_software_licence
Pro · Write
Create a new software licence record.
halo_get_recurring_invoice
Free · Read-only
Retrieve a single recurring invoice by numeric ID.
halo_get_software_licence
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_list_billing_lines
Free · Read-only
List billing line items with optional filters by client, contract, and date range.
halo_list_expenses
Free · Read-only
List expense records with optional filters.
halo_list_prepay_history
Free · Read-only
List client prepay/retainer history with optional filters.
halo_list_recurring_invoices
Free · Read-only
List recurring invoice templates with optional client filter.
halo_list_software_licences
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_process_recurring_invoices
Pro · Destructive
Trigger invoice generation from one or more recurring invoice templates by their IDs.
halo_update_recurring_invoice_lines
Pro · Write
Amend the line items on an existing recurring invoice template — change quantities, prices, descriptions, deactivate a line, or add new ones.
halo_update_recurring_invoice_schedule
Pro · Destructive
Change the schedule of a recurring invoice template: the start date that drives when the next invoice is generated.

Change Management

ToolWhat it does
halo_create_cab_meeting
Pro · Write
Create a new CAB meeting.
halo_create_release
Pro · Write
Create a new release for change management.
halo_get_cab_meeting
Free · Read-only
Retrieve a single CAB meeting by numeric ID.
halo_get_release
Free · Read-only
Retrieve a single release by numeric ID.
halo_list_cab_meetings
Free · Read-only
List Change Advisory Board (CAB) meetings with pagination.
halo_list_cab_members
Free · Read-only
List all Change Advisory Board members.
halo_list_cab_roles
Free · Read-only
List all CAB roles.
halo_list_release_types
Free · Read-only
List all available release types.
halo_list_releases
Free · Read-only
List releases with optional filters.

Service Catalog

ToolWhat it does
halo_create_service_status
Pro · Write
Create a new service status entry.
halo_get_service
Free · Read-only
Retrieve a single service by numeric ID.
halo_list_service_categories
Free · Read-only
List all service categories.
halo_list_service_statuses
Free · Read-only
List service status history with optional service filter.
halo_list_services
Free · Read-only
List services in the service catalogue with optional filters.

Scheduling

ToolWhat it does
halo_create_appointment
Pro · Write
Create a new appointment/calendar entry.
halo_create_todo
Pro · Write
Create a new to-do checklist item on a ticket.
halo_get_appointment
Free · Read-only
Retrieve a single appointment by numeric ID.
halo_get_timesheet_event_mine
Free · Read-only
Retrieve the current timesheet event for the authenticated agent.
halo_list_appointments
Free · Read-only
List appointments/calendar entries with optional filters.
halo_list_available_slots
Free · Read-only
List available time slots for scheduling appointments.
halo_list_booking_types
Free · Read-only
List all available booking/appointment types.
halo_list_holidays
Free · Read-only
List configured holidays.
halo_list_schedules
Free · Read-only
List agent schedules with optional filters.
halo_list_timesheet_events
Free · Read-only
List timesheet events (clock-in/clock-out, breaks, and time tracking events).
halo_list_todos
Free · Read-only
List to-do checklist items, optionally filtered by ticket ID.
halo_list_workdays
Free · Read-only
List workday definitions (business hours configuration).
halo_update_todo
Pro · Write
Update an existing to-do checklist item — correct its wording ('text'), mark it complete ('done': true), or re-order it ('sequence').

CRM

ToolWhat it does
halo_create_crm_note
Pro · Write
Create a new CRM note against a client or supplier.
halo_create_opportunity
Pro · Write
Create a new CRM opportunity/deal.
halo_get_opportunity
Free · Read-only
Retrieve a single CRM opportunity by numeric ID.
halo_list_contact_groups
Free · Read-only
List all contact groups.
halo_list_crm_notes
Free · Read-only
List CRM notes with optional client or supplier filter.
halo_list_feedback
Free · Read-only
Returns ALL customer satisfaction (CSAT) feedback records from Halo (raw passthrough).
halo_list_opportunities
Free · Read-only
List CRM opportunities/deals with optional filters.
halo_list_ticket_approvals
Free · Read-only
List pending ticket approvals with pagination.
halo_manage_contact_group_members
Pro · Write
Add or remove contacts from a contact group.
halo_process_approval
Pro · Write
Process one or more pending approval requests by their IDs.
halo_update_opportunity
Pro · Write
Update an existing CRM opportunity's fields such as stage, value, probability, or expected close date.

Audit

ToolWhat it does
halo_get_audit_entry
Free · Read-only
Retrieve a single audit log entry by numeric ID.
halo_get_field
Free · Read-only
Retrieve a single CUSTOM FIELD definition by numeric ID (GET /FieldInfo/{id}).
halo_list_audit_entries
Free · Read-only
List audit log entries with pagination.

Attachments

ToolWhat it does
halo_delete_attachment
Pro · Destructive
Delete an attachment by numeric ID.
halo_delete_attachment_document
Pro · Destructive
Permanently delete an attachment's document by ID.
halo_delete_attachment_image
Pro · Destructive
Permanently delete an attachment's image by its image ID (a GUID).
halo_download_attachment
Free · Read-only
Download an attachment's binary content by ID.
halo_download_attachment_document
Free · Read-only
Download an attachment's document representation by ID.
halo_download_attachment_image
Free · Read-only
Download an attachment's image representation by its image ID (a GUID).
halo_get_attachment
Free · Read-only
Retrieve attachment metadata by numeric ID.
halo_list_attachments
Free · Read-only
List attachments with optional action/ticket filter and pagination.
halo_upload_attachment
Pro · Write
Upload a file attachment to a ticket (and optionally a specific action/note).

Discovery & Config

ToolWhat it does
halo_global_search
Free · Read-only
Search across all entity types (tickets, clients, users, assets, knowledge base, etc.) in a single query.
halo_list_custom_fields
Free · Read-only
List custom field definitions (GET /FieldInfo), optionally filtered by ticket type.
halo_list_request_types
Free · Read-only
List all request types (service catalogue items) configured in the system.
halo_list_status_details
Free · Read-only
List detailed status configurations including workflow transitions, colour codes, and associated ticket types.
halo_list_ticket_areas
Free · Read-only
List all ticket areas (sub-categories or functional groupings) configured in the system.
halo_list_ticket_type_details
Free · Read-only
List detailed ticket type configurations including workflow rules, field mappings, SLA associations, and default values.
halo_list_ticket_type_fields
Free · Read-only
List fields configured for a ticket type, including custom fields and their validation rules.
halo_system_info
Free · Read-only
Retrieve HaloPSA instance information including version, licence details, and system configuration.

Analytics

ToolWhat it does
halo_client_ticket_trends
Free · Read-only
Track ticket volume trends for a specific client over multiple periods to identify patterns.
halo_open_ticket_summary
Free · Read-only
Snapshot of all open tickets grouped by status, priority, team, and ticket type with counts.
halo_priority_distribution
Free · Read-only
Breakdown of open tickets by priority level including average age per priority.
halo_queue_performance_comparison
Free · Read-only
Compare team/queue performance KPIs: average resolution time, resolution rate, open ticket count, and SLA compliance.
halo_stale_ticket_report
Free · Read-only
Identify open tickets with no activity beyond a threshold, indicating potential neglect or bottlenecks.
halo_team_workload_balance
Free · Read-only
View open ticket distribution across agents to identify workload imbalances.
halo_ticket_categorization_analysis
Free · Read-only
Analyze ticket distribution across categories, types, or priorities for a date range.
halo_ticket_resolution_analytics
Free · Read-only
Analyze ticket resolution times and rates for a date range, grouped by a chosen dimension.
halo_ticket_source_analysis
Free · Read-only
Analyze how tickets are being created (email, portal, phone, API, etc.) for a date range.
halo_unassigned_ticket_report
Free · Read-only
List all open tickets that have no agent assigned, grouped by priority and client.

Advanced Analytics

ToolWhat it does
halo_asset_ticket_correlation
Pro · Read-only
Find assets with recurring ticket activity above a threshold.
halo_asset_warranty_expiry_report
Pro · Read-only
Identify assets with warranties expiring within a specified number of days.
halo_contract_utilization_tracker
Pro · Read-only
Track Pre-Pay contract balance utilization (used vs prepaid allowance) from the contract prepay balance fields.
halo_csat_report
Pro · Read-only
Customer satisfaction report with ratings breakdown by agent.
halo_sla_breach_alerts
Pro · Read-only
Identify open tickets at risk of breaching SLA or already breached.
halo_sla_compliance_dashboard
Pro · Read-only
SLA compliance metrics including response and resolution rates for a date range.
halo_technician_utilization_report
Pro · Read-only
Analyze technician time utilization including billable vs total hours and utilization rate.
halo_ticket_aging_report
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_timesheet_summary
Pro · Read-only
Summarize timesheet data by agent and client for a date range.

Intelligence

ToolWhat it does
halo_after_hours_impact_report
Pro · Read-only
Analyze ticket volume outside business hours (before 8am, after 6pm, and weekends).
halo_bulk_ticket_update
Pro · Destructive
Update multiple tickets at once with the same field changes, with per-ticket read-back verification.
halo_client_360_view
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_client_offboarding_audit
Pro · Read-only
Audit a client for offboarding readiness.
halo_client_onboarding_checklist
Pro · Read-only
Generate an onboarding completeness checklist for a client.
halo_client_risk_assessment
Pro · Read-only
Assess client churn risk based on ticket volume, SLA breaches, CSAT ratings, and resolution efficiency.
halo_compliance_snapshot
Pro · Read-only
Generate a compliance snapshot covering SLA compliance rates, ticket closure rates, response time compliance, and time documentation completeness.
halo_contract_renewal_pipeline
Pro · Read-only
View upcoming contract renewals sorted by expiry date.
halo_daily_operations_briefing
Pro · Read-only
Generate a daily operations briefing with new tickets since yesterday, SLA warnings, stale tickets, unassigned tickets, and priority breakdown.
halo_dispatch_optimizer
Pro · Read-only
Analyze agent availability and workload to optimize ticket dispatch.
halo_draft_kb_from_ticket
Pro · Read-only
Generate a draft KB article from a resolved ticket.
halo_first_contact_resolution
Pro · Read-only
Measure first-contact resolution (FCR) rate — tickets resolved within 24 hours of creation.
halo_kb_gap_analysis
Pro · Read-only
Identify knowledge base gaps by comparing ticket categories to existing KB article coverage.
halo_project_budget_status
Pro · Read-only
Check project budget status by comparing budgeted hours/cost against actual time logged on project tickets.
halo_recurring_issue_detector
Pro · Read-only
Detect recurring issues by grouping tickets by client and category, then filtering for groups that meet a minimum occurrence threshold.
halo_revenue_leakage_scan
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_scope_creep_detector
Pro · Read-only
Detect scope creep by comparing ticket categories against contract scope definitions.
halo_ticket_backlog_analysis
Pro · Read-only
Analyze the open ticket backlog with age distribution buckets, per-agent breakdown, priority distribution, and top clients by backlog size.
halo_ticket_handoff_analysis
Pro · Read-only
Analyze ticket handoffs (reassignments, transfers, escalations) to identify tickets that bounce between agents.
halo_ticket_similarity_search
Pro · Read-only
Find tickets similar to a given ticket based on summary text matching.
halo_ticket_triage_assist
Pro · Read-only
AI-assisted triage for a ticket.
halo_time_entry_anomaly_scan
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_unbilled_time_report
Pro · Read-only
Find billable time entries that haven't been invoiced yet.

Premium Analytics

ToolWhat it does
halo_agreement_profitability_analysis
Pro · Read-only
Analyze a single agreement's profitability by comparing revenue to hours worked.
halo_client_health_score
Pro · Read-only
Composite client health score based on ticket volume, resolution rates, SLA compliance, and CSAT.
halo_effective_hourly_rate
Pro · Read-only
Calculate effective hourly rate across all billable work compared to a target rate.
halo_escalation_analysis
Pro · Read-only
Analyze escalation patterns including frequency by ticket type and agent.
halo_monthly_recurring_revenue
Pro · Read-only
Calculate current MRR from recurring invoices with optional client breakdown and historical trend.
halo_qbr_data_pack
Pro · Read-only
Comprehensive quarterly business review data pack for a client.
halo_unprofitable_agreements_report
Pro · Read-only
Identify agreements with negative profitability over a period.

Ticket Filters

ToolWhat it does
halo_list_high_priority_tickets
Free · Read-only
List open tickets with high priority (default priority ID 1 = Critical).
halo_list_my_tickets
Free · Read-only
List tickets assigned to the current authenticated agent.
halo_list_open_tickets
Free · Read-only
List all open/active tickets.
halo_list_overdue_sla_tickets
Free · Read-only
List open tickets with overdue SLA targets.
halo_list_past_due_tickets
Free · Read-only
List open tickets that have breached their SLA target.
halo_list_tickets_by_client
Free · Read-only
List all tickets for a specific client.
halo_list_unassigned_tickets
Free · Read-only
List open tickets with no agent assigned.

Address Book

ToolWhat it does
halo_create_address_book_entry
Pro · Write
Create a new address book entry.
halo_delete_address_book_entry
Pro · Destructive
Delete an address book entry by numeric ID.
halo_get_address_book_entry
Free · Read-only
Retrieve a single address book entry by numeric ID.
halo_list_address_book
Free · Read-only
List address book entries with optional search and pagination.
halo_update_address_book_entry
Pro · Write
Update an existing address book entry's fields such as name, email, or phone.

Roles

ToolWhat it does
halo_create_role
Pro · Write
Create a new role.
halo_delete_role
Pro · Destructive
Delete a role by numeric ID.
halo_get_role
Free · Read-only
Retrieve a single role by numeric ID.
halo_list_roles
Free · Read-only
List roles with pagination.
halo_update_role
Pro · Write
Update an existing role's fields such as name, description, or permissions.

Tags

ToolWhat it does
halo_create_tag
Pro · Write
Create a new tag.
halo_delete_tag
Pro · Destructive
Delete a tag by numeric ID.
halo_get_tag
Free · Read-only
Retrieve a single tag by numeric ID.
halo_list_tags
Free · Read-only
List tags with optional search and pagination.

Notifications

ToolWhat it does
halo_create_notification
Pro · Write
Create a new notification.
halo_get_notification
Free · Read-only
Retrieve a single notification by numeric ID.
halo_list_notifications
Free · Read-only
List notifications with optional filters and pagination.
halo_send_notification_message
Pro · Write
Send a notification message to one or more agents.

Canned Text

ToolWhat it does
halo_create_canned_text
Pro · Write
Create a new canned text (quick reply template).
halo_delete_canned_text
Pro · Destructive
Delete a canned text template by numeric ID.
halo_get_canned_text
Free · Read-only
Retrieve a single canned text template by numeric ID.
halo_list_canned_text
Free · Read-only
List canned text (quick reply templates) with optional filters and pagination.
halo_update_canned_text
Pro · Write
Update an existing canned text template's fields such as name, content, or team assignment.

Webhooks

ToolWhat it does
halo_create_webhook
Pro · Write
Create a new webhook subscription.
halo_delete_webhook
Pro · Destructive
Delete a webhook by numeric ID.
halo_get_webhook
Free · Read-only
Retrieve a single webhook by numeric ID.
halo_list_webhook_events
Free · Read-only
List webhook event delivery history with optional webhook filter and pagination.
halo_list_webhooks
Free · Read-only
List configured webhooks with pagination.
halo_update_webhook
Pro · Write
Update an existing webhook's fields such as name, URL, events, or enabled status.

Automation

ToolWhat it does
halo_create_automation_rule
Pro · Write
Create a new automation rule.
halo_delete_automation_rule
Pro · Destructive
Delete an automation rule by numeric ID.
halo_get_automation_rule
Free · Read-only
Retrieve a single automation rule by numeric ID.
halo_list_automation_rules
Free · Read-only
List automation rules with pagination.
halo_update_automation_rule
Pro · Write
Update an existing automation rule's fields such as name, conditions, actions, or enabled status.

Workflows

ToolWhat it does
halo_create_workflow
Pro · Write
Create a new workflow.
halo_delete_workflow
Pro · Destructive
Delete a workflow by numeric ID.
halo_get_workflow
Free · Read-only
Retrieve a single workflow by numeric ID.
halo_list_workflow_steps
Free · Read-only
List steps for a specific workflow by workflow ID.
halo_list_workflows
Free · Read-only
List workflows with pagination.
halo_update_workflow
Pro · Write
Update an existing workflow's fields such as name, description, or configuration.

Asset Groups

ToolWhat it does
halo_create_asset_group
Pro · Write
Create a new asset group.
halo_delete_asset_group
Pro · Destructive
Delete an asset group by numeric ID.
halo_get_asset_group
Free · Read-only
Retrieve a single asset group by numeric ID.
halo_list_asset_groups
Free · Read-only
List asset groups with pagination.
halo_update_asset_group
Pro · Write
Update an existing asset group's fields such as name or description.

Release Pipeline

ToolWhat it does
halo_create_release_pipeline
Pro · Write
Create a new release pipeline.
halo_delete_release_pipeline
Pro · Destructive
Delete a release pipeline by numeric ID.
halo_get_release_pipeline
Free · Read-only
Retrieve a single release pipeline by numeric ID.
halo_list_release_pipelines
Free · Read-only
List release pipelines with pagination.

Products & Components

ToolWhat it does
halo_create_product
Pro · Write
Create a new product.
halo_create_product_component
Pro · Write
Create a new product component.
halo_delete_product
Pro · Destructive
Delete a product by numeric ID.
halo_get_product
Free · Read-only
Retrieve a single product by numeric ID.
halo_list_product_components
Free · Read-only
List product components with optional product filter and pagination.
halo_list_products
Free · Read-only
List products with optional search and pagination.

Downtime

ToolWhat it does
halo_create_downtime
Pro · Write
Create a new downtime record.
halo_delete_downtime
Pro · Destructive
Delete a downtime record by numeric ID.
halo_get_downtime
Free · Read-only
Retrieve a single downtime record by numeric ID.
halo_list_downtime
Free · Read-only
List downtime records with optional filters and pagination.

Service Availability

ToolWhat it does
halo_create_service_availability
Pro · Write
Create a new service availability record.
halo_delete_service_availability
Pro · Destructive
Delete a service availability record by numeric ID.
halo_get_service_availability
Free · Read-only
Retrieve a single service availability record by numeric ID.
halo_list_service_availability
Free · Read-only
List service availability records with optional filters and pagination.

Contract Rules

ToolWhat it does
halo_create_contract_rule
Pro · Write
Create or update a contract billing rule that defines how time and items are charged.
halo_delete_contract_rule
Pro · Destructive
Delete a contract billing rule by ID.
halo_get_contract_rule
Free · Read-only
Retrieve a single contract billing rule by numeric ID.
halo_list_contract_rules
Free · Read-only
List contract billing rules that define how time and items are charged.

Contract Schedules

ToolWhat it does
halo_create_contract_schedule
Pro · Write
Create or update a contract billing schedule that defines when charges are generated.
halo_delete_contract_schedule
Pro · Destructive
Delete a contract billing schedule by ID.
halo_get_contract_schedule
Free · Read-only
Retrieve a single contract billing schedule by numeric ID.
halo_list_contract_schedules
Free · Read-only
List contract billing schedules that define when charges are generated.

Billing Templates

ToolWhat it does
halo_create_billing_template
Pro · Write
Create or update a reusable billing template for contracts.
halo_delete_billing_template
Pro · Destructive
Delete a billing template by ID.
halo_get_billing_template
Free · Read-only
Retrieve a single billing template by numeric ID.
halo_list_billing_templates
Free · Read-only
List reusable billing templates for contracts.
halo_update_billing_template_clients
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

ToolWhat it does
halo_create_budget_type
Pro · Write
Create or update a budget type for project and contract budgeting.
halo_delete_budget_type
Pro · Destructive
Delete a budget type by ID.
halo_get_budget_type
Free · Read-only
Retrieve a single budget type by numeric ID.
halo_list_budget_types
Free · Read-only
List budget types used for project and contract budgeting.

Cost Centres

ToolWhat it does
halo_create_cost_centre
Pro · Write
Create or update a cost centre for financial categorisation and reporting.
halo_delete_cost_centre
Pro · Destructive
Delete a cost centre by ID.
halo_get_cost_centre
Free · Read-only
Retrieve a single cost centre by numeric ID.
halo_list_cost_centres
Free · Read-only
List cost centres for financial categorisation and reporting.

CSP Invoices

ToolWhat it does
halo_create_csp_invoice
Pro · Write
Create or update a CSP invoice record.
halo_delete_csp_invoice
Pro · Destructive
Delete a CSP invoice by ID.
halo_get_csp_invoice
Free · Read-only
Retrieve a single CSP invoice by numeric ID.
halo_list_csp_invoices
Free · Read-only
List Microsoft Cloud Solution Provider (CSP) invoices synced from partner centre.

Custom Queries

ToolWhat it does
halo_create_custom_query
Pro · Write
Create or update a custom database query for reporting and data extraction.
halo_delete_custom_query
Pro · Destructive
Delete a custom query by ID.
halo_get_custom_query
Free · Read-only
Retrieve a single custom query by numeric ID.
halo_list_custom_queries
Free · Read-only
List custom database queries used for reporting and data extraction.

Custom Tables

ToolWhat it does
halo_create_custom_table
Pro · Write
Create or update a custom data table for extending Halo's data model.
halo_delete_custom_table
Pro · Destructive
Delete a custom table by ID.
halo_get_custom_table
Free · Read-only
Retrieve a single custom table by numeric ID.
halo_list_custom_tables
Free · Read-only
List custom data tables used for extending Halo's data model.

PDF Templates

ToolWhat it does
halo_create_pdf_template
Pro · Write
Create or update a PDF template used for generating documents like invoices, quotes, and delivery notes.
halo_delete_pdf_template
Pro · Destructive
Delete a PDF template by numeric ID.
halo_generate_document
Pro · Write
Generate a PDF document from a template.
halo_get_pdf_template
Free · Read-only
Retrieve full details for a single PDF template by numeric ID.
halo_get_pdf_template_library_item
Free · Read-only
Retrieve full details for a single item from the HaloPSA PDF template repository by numeric ID.
halo_list_pdf_template_library
Free · Read-only
Browse the HaloPSA pre-built PDF template repository.
halo_list_pdf_templates
Free · Read-only
List PDF templates used for generating invoices, quotes, delivery notes, and other documents.

Email Templates

ToolWhat it does
halo_create_email_template
Pro · Write
Create or update an email template for automated notifications and customer communications.
halo_create_email_template_variable
Pro · Write
Create a custom email template merge variable.
halo_delete_email_template
Pro · Destructive
Delete an email template by numeric ID.
halo_delete_email_template_variable
Pro · Destructive
Delete a custom email template variable by numeric ID.
halo_get_email_template
Free · Read-only
Retrieve full details for a single email template by numeric ID.
halo_get_email_template_variable
Free · Read-only
Retrieve full details for a single email template variable by numeric ID.
halo_list_email_template_variables
Free · Read-only
List all available email template merge variables.
halo_list_email_templates
Free · Read-only
List email templates used for automated notifications, ticket replies, and customer communications.
halo_preview_email_template
Free · Read-only
Render a live preview of an email template with variable substitution against real ticket data.

Email Rules

ToolWhat it does
halo_create_email_rule
Pro · Write
Create or update an email rule for inbound email processing.
halo_delete_email_rule
Pro · Destructive
Delete an email rule by numeric ID.
halo_get_email_rule
Free · Read-only
Retrieve full details for a single email rule by numeric ID.
halo_list_email_rules
Free · Read-only
List email rules that control how inbound emails are processed into tickets.

Mail Campaigns

ToolWhat it does
halo_create_campaign_email
Pro · Write
Create or update an individual email within a mail campaign.
halo_create_mail_campaign
Pro · Write
Create or update a mail campaign for bulk customer communications.
halo_delete_campaign_email
Pro · Destructive
Delete a campaign email by numeric ID.
halo_delete_mail_campaign
Pro · Destructive
Delete a mail campaign by numeric ID.
halo_get_campaign_email
Free · Read-only
Retrieve full details for a single campaign email by numeric ID.
halo_get_campaign_log
Free · Read-only
Retrieve full details for a single campaign delivery log entry by numeric ID.
halo_get_mail_campaign
Free · Read-only
Retrieve full details for a single mail campaign by numeric ID.
halo_list_campaign_emails
Free · Read-only
List individual email messages within mail campaigns.
halo_list_campaign_logs
Free · Read-only
List delivery logs for mail campaigns.
halo_list_mail_campaigns
Free · Read-only
List mail campaigns for bulk customer communications.

Integration Management

ToolWhat it does
halo_get_integration_config
Free · Read-only
Retrieve full details for a single integration configuration by numeric ID.
halo_get_integration_error
Free · Read-only
Retrieve full details for a single integration error by numeric ID.
halo_get_integration_request
Free · Read-only
Retrieve full details for a single integration request by numeric ID.
halo_list_integration_configs
Free · Read-only
List all configured integrations with their authentication status and module details.
halo_list_integration_errors
Free · Read-only
List integration sync errors with pagination.
halo_list_integration_field_mappings
Free · Read-only
List field mappings between Halo and third-party integration fields.
halo_list_integration_requests
Free · Read-only
List integration API requests (inbound and outbound) with pagination.
halo_list_integration_site_mappings
Free · Read-only
List site mappings between Halo and third-party integrations.

Integration Data

ToolWhat it does
halo_get_automate_data
Free · Read-only
Retrieve ConnectWise Automate / LabTech data (computers, monitors, scripts) from Halo's connected Automate integration.
halo_get_auvik_data
Free · Read-only
Retrieve Auvik data (networks, devices, alerts) from Halo's connected Auvik network monitoring integration.
halo_get_avalara_data
Free · Read-only
Retrieve Avalara tax data from Halo's connected tax integration.
halo_get_azure_ad_data
Free · Read-only
Retrieve Azure Active Directory / Entra ID data (users, groups, licenses) from Halo's connected Azure AD integration.
halo_get_azure_sentinel_data
Free · Read-only
Retrieve Azure Sentinel / Microsoft Sentinel data (incidents, alerts, analytics rules) from Halo's connected Sentinel integration.
halo_get_business_central_data
Free · Read-only
Retrieve Microsoft Dynamics 365 Business Central data from Halo's connected accounting integration.
halo_get_connectwise_manage_data
Free · Read-only
Retrieve ConnectWise Manage data (tickets, companies, contacts) from Halo's connected ConnectWise integration.
halo_get_datto_rmm_data
Free · Read-only
Retrieve Datto RMM data (devices, alerts, patch status) from Halo's connected Datto integration.
halo_get_domotz_data
Free · Read-only
Retrieve Domotz data (agents, devices, alerts) from Halo's connected Domotz network monitoring integration.
halo_get_exact_online_data
Free · Read-only
Retrieve Exact Online accounting data from Halo's connected integration.
halo_get_fortnox_data
Free · Read-only
Retrieve Fortnox accounting data from Halo's connected integration.
halo_get_gocardless_data
Free · Read-only
Retrieve GoCardless data from Halo's connected payments integration.
halo_get_gocardless_payments
Free · Read-only
Retrieve GoCardless payments from Halo's connected payments integration.
halo_get_intacct_data
Free · Read-only
Retrieve Sage Intacct accounting data from Halo's connected integration.
halo_get_intune_data
Free · Read-only
Retrieve Microsoft Intune data (devices, compliance policies, app deployments) from Halo's connected Intune integration.
halo_get_itglue_data
Free · Read-only
Retrieve IT Glue data (configurations, flexible assets, documents) from Halo's connected IT Glue integration.
halo_get_kaseya_vsa_data
Free · Read-only
Retrieve Kaseya VSA data (agents, machine groups, procedures) from Halo's connected Kaseya VSA integration.
halo_get_kashflow_data
Free · Read-only
Retrieve KashFlow accounting data from Halo's connected integration.
halo_get_liongard_data
Free · Read-only
Retrieve Liongard data (inspectors, metrics, timelines) from Halo's connected Liongard integration.
halo_get_microsoft_csp_data
Free · Read-only
Retrieve LIVE Microsoft Partner Center data through Halo's Microsoft CSP integration passthrough.
halo_get_myob_data
Free · Read-only
Retrieve MYOB accounting data from Halo's connected integration.
halo_get_ncentral_data
Free · Read-only
Retrieve N-able N-central data (devices, service items, tasks) from Halo's connected N-central integration.
halo_get_pax8_data
Free · Read-only
Retrieve Pax8 data (subscriptions, products, companies) from Halo's connected Pax8 distributor integration.
halo_get_prtg_data
Free · Read-only
Retrieve PRTG data (sensors, devices, alerts) from Halo's connected PRTG Network Monitor integration.
halo_get_quickbooks_data
Free · Read-only
Retrieve QuickBooks Online data (e.g. Account, Customer, Payment, Invoice, Item, Vendor) from Halo's connected QuickBooks integration.
halo_get_sage_business_cloud_data
Free · Read-only
Retrieve Sage Business Cloud accounting data from Halo's connected integration.
halo_get_sentinelone_data
Free · Read-only
Retrieve the SentinelOne integration connection details configured in Halo (returns the /SentinelOneDetails resource).
halo_get_snelstart_data
Free · Read-only
Retrieve SnelStart accounting data from Halo's connected integration.
halo_get_solarwinds_rmm_data
Free · Read-only
Retrieve SolarWinds RMM / N-able RMM data (devices, alerts, patch status) from Halo's connected SolarWinds RMM integration.
halo_get_sophos_data
Free · Read-only
Retrieve the Sophos integration connection details configured in Halo (returns the /SophosDetails resource).
halo_get_stripe_data
Free · Read-only
Retrieve Stripe data from Halo's connected payments integration.
halo_get_xero_data
Free · Read-only
Retrieve Xero data from Halo's connected Xero accounting integration.

Accounting Details

ToolWhat it does
halo_get_avalara_detail
Free · Read-only
Get a single Avalara connection detail by ID.
halo_get_business_central_detail
Free · Read-only
Get a single Business Central connection detail by ID.
halo_get_fortnox_detail
Free · Read-only
Get a single Fortnox connection detail by ID.
halo_get_kashflow_detail
Free · Read-only
Get a single KashFlow connection detail by ID.
halo_get_myob_detail
Free · Read-only
Get a single MYOB connection detail by ID.
halo_get_quickbooks_detail
Free · Read-only
Get a single QuickBooks Online connection detail by ID.
halo_get_sage_business_cloud_detail
Free · Read-only
Get a single Sage Business Cloud connection detail by ID.
halo_get_xero_detail
Free · Read-only
Get a single Xero connection detail by ID.
halo_list_avalara_details
Free · Read-only
List Avalara tax-integration connection details configured in Halo.
halo_list_business_central_details
Free · Read-only
List Microsoft Dynamics 365 Business Central connection details configured in Halo.
halo_list_fortnox_details
Free · Read-only
List Fortnox connection details configured in Halo.
halo_list_kashflow_details
Free · Read-only
List KashFlow connection details configured in Halo.
halo_list_myob_details
Free · Read-only
List MYOB connection details configured in Halo.
halo_list_quickbooks_details
Free · Read-only
List QuickBooks Online connection details configured in Halo.
halo_list_sage_business_cloud_details
Free · Read-only
List Sage Business Cloud connection details configured in Halo.
halo_list_xero_details
Free · Read-only
List Xero connection details configured in Halo.

MCP & AI

ToolWhat it does
halo_create_mcp_connection
Pro · Destructive
Create a new MCP (Model Context Protocol) connection.
halo_create_pii_detection
Pro · Destructive
Create a new PII (Personally Identifiable Information) detection rule.
halo_delete_mcp_connection
Pro · Destructive
Delete an MCP connection by numeric ID.
halo_get_mcp_connection
Free · Read-only
Retrieve a single MCP connection by numeric ID.
halo_get_pii_detection
Free · Read-only
Retrieve a single PII detection rule by numeric ID.
halo_get_virtual_agent_mcp
Free · Read-only
Retrieve the MCP (Model Context Protocol) configuration linked to a virtual agent.
halo_link_virtual_agent_mcp
Pro · Destructive
Link MCP (Model Context Protocol) capabilities to a virtual agent.
halo_list_mcp_connections
Free · Read-only
List all MCP (Model Context Protocol) connections configured in HaloPSA.
halo_list_pii_detections
Free · Read-only
List all PII (Personally Identifiable Information) detection rules configured in HaloPSA.
halo_unlink_virtual_agent_mcp
Pro · Destructive
Unlink MCP (Model Context Protocol) capabilities from a virtual agent.

Integration Diagnostics

ToolWhat it does
halo_create_integration_cursor
Pro · Destructive
Create or update an integration cursor.
halo_create_intermedia_detail
Pro · Destructive
Create or update an Intermedia connection detail.
halo_create_sftp_detail
Pro · Destructive
Create or update an SFTP connection detail.
halo_delete_integration_cursor
Pro · Destructive
Delete an integration cursor by numeric ID.
halo_delete_intermedia_detail
Pro · Destructive
Delete an Intermedia connection detail by numeric ID.
halo_delete_sftp_detail
Pro · Destructive
Delete an SFTP connection detail by numeric ID.
halo_get_cluster
Free · Read-only
Retrieve a single cluster by numeric ID.
halo_get_integration_cursor
Free · Read-only
Retrieve a single integration cursor by numeric ID.
halo_get_intermedia_detail
Free · Read-only
Retrieve a single Intermedia connection detail by numeric ID.
halo_get_periodic_history
Free · Read-only
Retrieve periodic (recurring) invoice/billing history.
halo_get_sftp_detail
Free · Read-only
Retrieve a single SFTP connection detail by numeric ID.
halo_list_clusters
Free · Read-only
List Halo clusters.
halo_list_integration_cursors
Free · Read-only
List integration cursors.
halo_list_intermedia_details
Free · Read-only
List configured Intermedia (Unite / cloud PBX) connection details used by Halo's telephony integration.
halo_list_sftp_details
Free · Read-only
List configured SFTP connection details used by Halo integrations and imports.

Invoice & Order Extras

ToolWhat it does
halo_create_invoice_status
Pro · Destructive
Create a new invoice status.
halo_delete_invoice_status
Pro · Destructive
Delete an invoice status by numeric ID.
halo_expire_client_prepay
Pro · Destructive
Expire one or more client prepay balances.
halo_get_invoice_status
Free · Read-only
Retrieve a single invoice status by numeric ID.
halo_list_invoice_statuses
Free · Read-only
List all invoice statuses configured in HaloPSA.
halo_register_invoice_view
Pro · Write
Record that a user or contact has viewed an invoice.
halo_register_kb_article_view
Pro · Write
Record that a user or contact has viewed a knowledge base article.
halo_register_purchase_order_view
Pro · Write
Record that a user or contact has viewed a purchase order.
halo_register_sales_order_view
Pro · Write
Record that a user or contact has viewed a sales order.
halo_review_expense
Pro · Destructive
Mark one or more expenses as reviewed.
halo_update_invoice_lines
Pro · Destructive
Update one or more invoice line items in bulk.

CRM & Service Extras

ToolWhat it does
halo_create_crm_note_reply
Pro · Write
Create a reply against a CRM note.
halo_create_service
Pro · Write
Create a new service in the service catalog/service-status surface.
halo_delete_crm_note_reply
Pro · Destructive
Delete a CRM note reply by numeric ID.
halo_delete_service
Pro · Destructive
Delete a service from the service catalog by numeric ID.
halo_get_crm_note_reply
Free · Read-only
Retrieve a single CRM note reply by numeric ID.
halo_get_security_question_call
Free · Read-only
Retrieve the security question to verify a caller for a given call/ticket by numeric ID.
halo_list_crm_note_replies
Free · Read-only
List replies left against CRM notes.
halo_list_milestones
Free · Read-only
List project milestones.
halo_list_users_onbehalf
Free · Read-only
List the users the current agent can act on behalf of.
halo_unsubscribe_service
Pro · Destructive
Unsubscribe the current user/agent from a service so they stop receiving status notifications.
halo_validate_security_question
Pro · Write
Validate a user's answer to a security question.
halo_validate_security_question_call
Pro · Write
Validate a caller's answer to a security question for a call/ticket.

Integration Data (Extended)

ToolWhat it does
halo_get_atera_data
Free · Read-only
Retrieve Atera data from Halo's connected Atera integration.
halo_get_autotask_data
Free · Read-only
Retrieve Autotask data from Halo's connected Autotask integration.
halo_get_barracuda_data
Free · Read-only
Retrieve Barracuda data from Halo's connected Barracuda integration.
halo_get_connectwise_control_data
Free · Read-only
Retrieve ConnectWise Control data from Halo's connected ConnectWise Control integration.
halo_get_connectwise_rmm_data
Free · Read-only
Retrieve ConnectWise RMM data from Halo's connected ConnectWise RMM integration.
halo_get_datto_commerce_data
Free · Read-only
Retrieve Datto Commerce data from Halo's connected Datto Commerce integration.
halo_get_device42_data
Free · Read-only
Retrieve Device42 data from Halo's connected Device42 integration.
halo_get_devops_data
Free · Read-only
Retrieve Azure DevOps data from Halo's connected Azure DevOps integration.
halo_get_dynamics_crm_data
Free · Read-only
Retrieve Dynamics CRM data from Halo's connected Dynamics CRM integration.
halo_get_freshdesk_data
Free · Read-only
Retrieve Freshdesk data from Halo's connected Freshdesk integration.
halo_get_google_calendars_data
Free · Read-only
Retrieve Google Calendars data from Halo's connected Google Calendars integration.
halo_get_google_workplace_data
Free · Read-only
Retrieve Google Workplace data from Halo's connected Google Workplace integration.
halo_get_gotoassist_data
Free · Read-only
Retrieve GoToAssist data from Halo's connected GoToAssist integration.
halo_get_hubspot_data
Free · Read-only
Retrieve HubSpot data from Halo's connected HubSpot integration.
halo_get_jamf_data
Free · Read-only
Retrieve Jamf data from Halo's connected Jamf integration.
halo_get_jira_data
Free · Read-only
Retrieve Jira data from Halo's connected Jira integration.
halo_get_jira_service_management_data
Free · Read-only
Retrieve Jira Service Management data from Halo's connected Jira Service Management integration.
halo_get_lansweeper_data
Free · Read-only
Retrieve Lansweeper data from Halo's connected Lansweeper integration.
halo_get_logicmonitor_data
Free · Read-only
Retrieve LogicMonitor data from Halo's connected LogicMonitor integration.
halo_get_meraki_data
Free · Read-only
Retrieve Meraki data from Halo's connected Meraki integration.
halo_get_ninja_rmm_data
Free · Read-only
Retrieve NinjaRMM data from Halo's connected NinjaRMM integration.
halo_get_okta_data
Free · Read-only
Retrieve Okta data from Halo's connected Okta integration.
halo_get_pagerduty_data
Free · Read-only
Retrieve PagerDuty data from Halo's connected PagerDuty integration.
halo_get_passportal_data
Free · Read-only
Retrieve Passportal data from Halo's connected Passportal integration.
halo_get_qualys_data
Free · Read-only
Retrieve Qualys data from Halo's connected Qualys integration.
halo_get_salesforce_data
Free · Read-only
Retrieve Salesforce data from Halo's connected Salesforce integration.
halo_get_servicenow_data
Free · Read-only
Retrieve ServiceNow data from Halo's connected ServiceNow integration.
halo_get_servicenow_integration_data
Free · Read-only
Retrieve ServiceNow Integration data from Halo's connected ServiceNow Integration integration.
halo_get_shopify_data
Free · Read-only
Retrieve Shopify data from Halo's connected Shopify integration.
halo_get_slack_data
Free · Read-only
Retrieve Slack data from Halo's connected Slack integration.
halo_get_snow_data
Free · Read-only
Retrieve Snow data from Halo's connected Snow integration.
halo_get_splashtop_data
Free · Read-only
Retrieve Splashtop data from Halo's connected Splashtop integration.
halo_get_splunk_oncall_data
Free · Read-only
Retrieve Splunk On-Call data from Halo's connected Splunk On-Call integration.
halo_get_syncro_data
Free · Read-only
Retrieve Syncro data from Halo's connected Syncro integration.
halo_get_tanium_data
Free · Read-only
Retrieve Tanium data from Halo's connected Tanium integration.
halo_get_zabbix_data
Free · Read-only
Retrieve Zabbix data from Halo's connected Zabbix integration.

Integration Sync

ToolWhat it does
halo_adjust_csp_quantity
Pro · Destructive
Change the seat quantity of a Microsoft CSP licence via Halo's connected Microsoft Partner Center integration.
halo_adjust_pax8_quantity
Pro · Destructive
Change the seat quantity of a Pax8 subscription licence via Halo's connected Pax8 integration.
halo_clear_csp_licence_cache
Pro · Write
Clear Halo's cached Microsoft CSP licence-key lookups, forcing a fresh fetch from Microsoft Partner Center on the next read.
halo_import_business_central
Pro · Destructive
Trigger an import sync against the connected Microsoft Dynamics 365 Business Central accounting integration.
halo_import_exact_online
Pro · Destructive
Trigger an import sync against the connected Exact Online accounting integration.
halo_import_fortnox
Pro · Destructive
Trigger an import sync against the connected Fortnox accounting integration.
halo_import_intacct
Pro · Destructive
Trigger an import sync against the connected Sage Intacct accounting integration.
halo_import_kashflow
Pro · Destructive
Trigger an import sync against the connected KashFlow accounting integration.
halo_import_myob
Pro · Destructive
Trigger an import sync against the connected MYOB accounting integration.
halo_import_quickbooks_online
Pro · Destructive
Trigger an import sync against the connected QuickBooks Online accounting integration.
halo_import_sage_business_cloud
Pro · Destructive
Trigger an import sync against the connected Sage Business Cloud accounting integration.
halo_import_snelstart
Pro · Destructive
Trigger an import sync against the connected SnelStart accounting integration.
halo_import_xero
Pro · Destructive
Trigger an import sync against the connected Xero accounting integration.
halo_send_xero_invoice
Pro · Destructive
Push an invoice to the connected Xero accounting integration.
halo_stripe_create_payment_intent
Pro · Destructive
Create a Stripe PaymentIntent via Halo's connected Stripe payments integration.
halo_stripe_create_portal_session
Pro · Destructive
Create a Stripe customer billing portal session via Halo's connected Stripe payments integration.
halo_stripe_create_setup_intent
Pro · Destructive
Create a Stripe SetupIntent via Halo's connected Stripe payments integration.
halo_stripe_create_webhook
Pro · Destructive
Create a Stripe webhook endpoint via Halo's connected Stripe payments integration.
halo_stripe_update_invoice_payment
Pro · Destructive
Update an invoice payment record in Stripe via Halo's connected Stripe payments integration.

Standard Request Templates

ToolWhat it does
halo_create_template
Pro · Write
Create a new standard request template.
halo_delete_template
Pro · Destructive
Delete a standard request template by numeric ID.
halo_get_template
Free · Read-only
Retrieve full details for a single standard request template by numeric ID.
halo_list_templates
Free · Read-only
List standard request templates (pre-configured ticket blueprints) with pagination.

Call Scripts

ToolWhat it does
halo_get_call_script
Free · Read-only
Retrieve full details for a single call script by numeric ID.
halo_list_call_scripts
Free · Read-only
List all call scripts configured in the system.

Live Chat

ToolWhat it does
halo_get_chat
Free · Read-only
Retrieve full details for a single live chat session by numeric ID.
halo_get_chat_profile
Free · Read-only
Retrieve full details for a single chat profile by numeric ID.
halo_list_chat_messages
Free · Read-only
List messages in a live chat session.
halo_list_chat_profiles
Free · Read-only
List all live chat profiles configured in the system.
halo_list_chats
Free · Read-only
List live chat sessions with optional filtering.
halo_send_chat_message
Pro · Write
Send a message in a live chat session.

Remote Sessions

ToolWhat it does
halo_create_remote_session
Pro · Write
Create a new remote support session.
halo_get_remote_session
Free · Read-only
Retrieve full details for a single remote support session by numeric ID.
halo_list_remote_session_teams
Free · Read-only
List teams configured for remote support sessions.
halo_list_remote_sessions
Free · Read-only
List remote support sessions with optional filtering by agent or client.

Approval Processes

ToolWhat it does
halo_create_approval_process
Pro · Write
Create a new approval process.
halo_create_approval_rule
Pro · Write
Create a new approval rule that defines conditions for triggering approvals.
halo_get_approval_process
Free · Read-only
Retrieve full details for a single approval process by numeric ID.
halo_list_approval_processes
Free · Read-only
List all approval processes configured in the system.
halo_list_approval_rules
Free · Read-only
List approval rules that define when and how approvals are triggered.

Saved Views

ToolWhat it does
halo_get_view
Free · Read-only
Retrieve full details for a single saved view by numeric ID.
halo_list_view_columns
Free · Read-only
List available column definitions that can be used in saved views.
halo_list_view_filters
Free · Read-only
List available filter definitions that can be used in saved views.
halo_list_views
Free · Read-only
List saved views configured in the system.

PowerShell Scripts

ToolWhat it does
halo_create_script
Pro · Write
Create a new PowerShell script in the Halo script library.
halo_get_script
Free · Read-only
Retrieve full details for a single PowerShell script by numeric ID.
halo_list_script_executions
Free · Read-only
List PowerShell script execution history.
halo_list_scripts
Free · Read-only
List PowerShell scripts stored in the Halo script library.

Call Logs

ToolWhat it does
halo_create_call_log
Pro · Write
Create a new telephone call log entry.
halo_list_call_logs
Free · Read-only
List telephone call logs recorded in the system.
ToolWhat it does
halo_create_external_link
Pro · Write
Create a new external link on a Halo entity.
halo_generate_external_link
Pro · Write
Generate a shareable external link (portal link or guest access URL) for a Halo entity.
halo_list_external_links
Free · Read-only
List external links associated with Halo entities.

FAQ Lists

ToolWhat it does
halo_get_faq_list
Free · Read-only
Retrieve full details for a single FAQ list by numeric ID.
halo_list_faq_lists
Free · Read-only
List FAQ lists (frequently asked questions collections) configured in the system.
ToolWhat it does
halo_list_popup_notes
Free · Read-only
List popup notes configured for clients, sites, or users.
halo_mark_popup_read
Pro · Write
Mark a popup note as read/acknowledged for the current agent.
ToolWhat it does
halo_create_secure_link
Pro · Write
Create a new secure secret link for sharing sensitive information.
halo_list_secure_links
Free · Read-only
List secure secret links (one-time-use password/secret sharing URLs).
halo_validate_secure_link
Free · Read-only
Validate a secure secret link token and retrieve the secret if valid.

Cross-Domain

ToolWhat it does
halo_bulk_status_summary
Pro · Read-only
Quick counts of open items across all domains: open tickets, active contracts, active assets, pending approvals, and open opportunities.
halo_client_financial_summary
Pro · Read-only
For a client: total invoiced revenue, total hours logged, active contracts with values, prepay balance, and recent billing lines.
halo_entity_relationship_map
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_queue_health_dashboard
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_technician_dashboard
Pro · Read-only
For a given agent: their open tickets by priority, today's timesheets, upcoming appointments, and SLA breach warnings.
halo_weekly_operations_report
Pro · Read-only
Weekly operations snapshot: new tickets created, tickets closed, total time logged, SLA breaches, and contracts expiring soon.

Integration Config: A-E

ToolWhat it does
halo_create_addigy_details
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_create_adobe_acrobat_details
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_create_adobe_commerce_details
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_create_amazon_seller_details
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_create_armis_details
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_create_arrow_sphere_details
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_create_assetbots_details
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_create_avalara_details
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_create_aws_details
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_create_business_central_details
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_create_confluence_details
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_create_datto_commerce_details
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_create_datto_rmm_details
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_create_dynamics365_crm_details
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_create_dynatrace_details
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_create_eracent_details
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_delete_addigy_details
Pro · Destructive
Delete an Addigy integration connection-detail record by numeric ID.
halo_delete_adobe_acrobat_details
Pro · Destructive
Delete an Adobe Acrobat integration connection-detail record by numeric ID.
halo_delete_adobe_commerce_details
Pro · Destructive
Delete an Adobe Commerce integration connection-detail record by numeric ID.
halo_delete_amazon_seller_details
Pro · Destructive
Delete an Amazon Seller integration connection-detail record by numeric ID.
halo_delete_armis_details
Pro · Destructive
Delete an Armis integration connection-detail record by numeric ID.
halo_delete_arrow_sphere_details
Pro · Destructive
Delete an ArrowSphere integration connection-detail record by numeric ID.
halo_delete_assetbots_details
Pro · Destructive
Delete an Assetbots integration connection-detail record by numeric ID.
halo_delete_avalara_details
Pro · Destructive
Delete an Avalara tax-integration connection-detail record by numeric ID.
halo_delete_aws_details
Pro · Destructive
Delete an AWS integration connection-detail record by numeric ID.
halo_delete_business_central_details
Pro · Destructive
Delete a Microsoft Dynamics 365 Business Central connection-detail record by numeric ID.
halo_delete_confluence_details
Pro · Destructive
Delete a Confluence integration connection-detail record by numeric ID.
halo_delete_datto_commerce_details
Pro · Destructive
Delete a Datto Commerce integration connection-detail record by numeric ID.
halo_delete_datto_rmm_details
Pro · Destructive
Delete a Datto RMM integration connection-detail record by numeric ID.
halo_delete_dynamics365_crm_details
Pro · Destructive
Delete a Microsoft Dynamics 365 CRM integration connection-detail record by numeric ID.
halo_delete_dynatrace_details
Pro · Destructive
Delete a Dynatrace integration connection-detail record by numeric ID.
halo_delete_eracent_details
Pro · Destructive
Delete an Eracent integration connection-detail record by numeric ID.
halo_get_addigy_details
Free · Read-only
Retrieve a single Addigy integration connection-detail record by numeric ID.
halo_get_adobe_acrobat_details
Free · Read-only
Retrieve a single Adobe Acrobat integration connection-detail record by numeric ID.
halo_get_adobe_commerce_details
Free · Read-only
Retrieve a single Adobe Commerce integration connection-detail record by numeric ID.
halo_get_amazon_seller_details
Free · Read-only
Retrieve a single Amazon Seller integration connection-detail record by numeric ID.
halo_get_armis_details
Free · Read-only
Retrieve a single Armis integration connection-detail record by numeric ID.
halo_get_arrow_sphere_details
Free · Read-only
Retrieve a single ArrowSphere integration connection-detail record by numeric ID.
halo_get_assetbots_details
Free · Read-only
Retrieve a single Assetbots integration connection-detail record by numeric ID.
halo_get_aws_details
Free · Read-only
Retrieve a single AWS integration connection-detail record by numeric ID.
halo_get_confluence_details
Free · Read-only
Retrieve a single Confluence integration connection-detail record by numeric ID.
halo_get_datto_commerce_details
Free · Read-only
Retrieve a single Datto Commerce integration connection-detail record by numeric ID.
halo_get_datto_rmm_details
Free · Read-only
Retrieve a single Datto RMM integration connection-detail record by numeric ID.
halo_get_dynamics365_crm_details
Free · Read-only
Retrieve a single Microsoft Dynamics 365 CRM integration connection-detail record by numeric ID.
halo_get_dynatrace_details
Free · Read-only
Retrieve a single Dynatrace integration connection-detail record by numeric ID.
halo_get_eracent_details
Free · Read-only
Retrieve a single Eracent integration connection-detail record by numeric ID.
halo_list_addigy_details
Free · Read-only
List Addigy integration connection-detail records configured in HaloPSA.
halo_list_adobe_acrobat_details
Free · Read-only
List Adobe Acrobat integration connection-detail records configured in HaloPSA.
halo_list_adobe_commerce_details
Free · Read-only
List Adobe Commerce integration connection-detail records configured in HaloPSA.
halo_list_amazon_seller_details
Free · Read-only
List Amazon Seller integration connection-detail records configured in HaloPSA.
halo_list_armis_details
Free · Read-only
List Armis integration connection-detail records configured in HaloPSA.
halo_list_arrow_sphere_details
Free · Read-only
List ArrowSphere integration connection-detail records configured in HaloPSA.
halo_list_assetbots_details
Free · Read-only
List Assetbots integration connection-detail records configured in HaloPSA.
halo_list_aws_details
Free · Read-only
List AWS integration connection-detail records configured in HaloPSA.
halo_list_confluence_details
Free · Read-only
List Confluence integration connection-detail records configured in HaloPSA.
halo_list_datto_commerce_details
Free · Read-only
List Datto Commerce integration connection-detail records configured in HaloPSA.
halo_list_datto_rmm_details
Free · Read-only
List Datto RMM integration connection-detail records configured in HaloPSA.
halo_list_dynamics365_crm_details
Free · Read-only
List Microsoft Dynamics 365 CRM integration connection-detail records configured in HaloPSA.
halo_list_dynatrace_details
Free · Read-only
List Dynatrace integration connection-detail records configured in HaloPSA.
halo_list_eracent_details
Free · Read-only
List Eracent integration connection-detail records configured in HaloPSA.

Integration Config: E-M

ToolWhat it does
halo_create_exact_details
Pro · Write
Create or update an Exact Online integration connection detail (upsert — include an id in the body to update).
halo_create_facebook_details
Pro · Write
Create or update a Facebook integration connection detail (upsert — include an id in the body to update).
halo_create_forecast_details
Pro · Write
Create or update a Forecast integration connection detail (upsert — include an id in the body to update).
halo_create_forethought_details
Pro · Write
Create or update a Forethought integration connection detail (upsert — include an id in the body to update).
halo_create_fortnox_details
Pro · Write
Create or update a Fortnox integration connection detail (upsert — include an id in the body to update).
halo_create_google_business_details
Pro · Write
Create or update a Google Business Messages integration connection detail (upsert — include an id in the body to update).
halo_create_gworkspace_details
Pro · Write
Create or update a Google Workspace integration connection detail (upsert — include an id in the body to update).
halo_create_ingram_micro_details
Pro · Write
Create or update an Ingram Micro integration connection detail (upsert — include an id in the body to update).
halo_create_ingram_micro_reseller_details
Pro · Write
Create or update an Ingram Micro Reseller integration connection detail (upsert — include an id in the body to update).
halo_create_jamf_details
Pro · Write
Create or update a Jamf integration connection detail (upsert — include an id in the body to update).
halo_create_jira_details
Pro · Write
Create or update a Jira integration connection detail (upsert — include an id in the body to update).
halo_create_kandji_details
Pro · Write
Create or update a Kandji integration connection detail (upsert — include an id in the body to update).
halo_create_kaseya_vsax_details
Pro · Write
Create or update a Kaseya VSA X integration connection detail (upsert — include an id in the body to update).
halo_create_kashflow_details
Pro · Write
Create or update a KashFlow integration connection detail (upsert — include an id in the body to update).
halo_create_manage_engine_details
Pro · Write
Create or update a ManageEngine integration connection detail (upsert — include an id in the body to update).
halo_create_mattermost_details
Pro · Write
Create or update a Mattermost integration connection detail (upsert — include an id in the body to update).
halo_delete_exact_details
Pro · Destructive
Delete an Exact Online integration connection detail by numeric ID.
halo_delete_facebook_details
Pro · Destructive
Delete a Facebook integration connection detail by numeric ID.
halo_delete_forecast_details
Pro · Destructive
Delete a Forecast integration connection detail by numeric ID.
halo_delete_forethought_details
Pro · Destructive
Delete a Forethought integration connection detail by numeric ID.
halo_delete_fortnox_details
Pro · Destructive
Delete a Fortnox integration connection detail by numeric ID.
halo_delete_google_business_details
Pro · Destructive
Delete a Google Business Messages integration connection detail by numeric ID.
halo_delete_gworkspace_details
Pro · Destructive
Delete a Google Workspace integration connection detail by numeric ID.
halo_delete_ingram_micro_details
Pro · Destructive
Delete an Ingram Micro integration connection detail by numeric ID.
halo_delete_ingram_micro_reseller_details
Pro · Destructive
Delete an Ingram Micro Reseller integration connection detail by numeric ID.
halo_delete_jamf_details
Pro · Destructive
Delete a Jamf integration connection detail by numeric ID.
halo_delete_jira_details
Pro · Destructive
Delete a Jira integration connection detail by numeric ID.
halo_delete_kandji_details
Pro · Destructive
Delete a Kandji integration connection detail by numeric ID.
halo_delete_kaseya_vsax_details
Pro · Destructive
Delete a Kaseya VSA X integration connection detail by numeric ID.
halo_delete_kashflow_details
Pro · Destructive
Delete a KashFlow integration connection detail by numeric ID.
halo_delete_manage_engine_details
Pro · Destructive
Delete a ManageEngine integration connection detail by numeric ID.
halo_delete_mattermost_details
Pro · Destructive
Delete a Mattermost integration connection detail by numeric ID.
halo_get_exact_details
Free · Read-only
Retrieve a single Exact Online integration connection detail by numeric ID.
halo_get_facebook_details
Free · Read-only
Retrieve a single Facebook integration connection detail by numeric ID.
halo_get_forecast_details
Free · Read-only
Retrieve a single Forecast integration connection detail by numeric ID.
halo_get_forethought_details
Free · Read-only
Retrieve a single Forethought integration connection detail by numeric ID.
halo_get_google_business_details
Free · Read-only
Retrieve a single Google Business Messages integration connection detail by numeric ID.
halo_get_gworkspace_details
Free · Read-only
Retrieve a single Google Workspace integration connection detail by numeric ID.
halo_get_ingram_micro_details
Free · Read-only
Retrieve a single Ingram Micro integration connection detail by numeric ID.
halo_get_ingram_micro_reseller_details
Free · Read-only
Retrieve a single Ingram Micro Reseller integration connection detail by numeric ID.
halo_get_jamf_details
Free · Read-only
Retrieve a single Jamf integration connection detail by numeric ID.
halo_get_jira_details
Free · Read-only
Retrieve a single Jira integration connection detail by numeric ID.
halo_get_kandji_details
Free · Read-only
Retrieve a single Kandji integration connection detail by numeric ID.
halo_get_kaseya_vsax_details
Free · Read-only
Retrieve a single Kaseya VSA X integration connection detail by numeric ID.
halo_get_manage_engine_details
Free · Read-only
Retrieve a single ManageEngine integration connection detail by numeric ID.
halo_get_mattermost_details
Free · Read-only
Retrieve a single Mattermost integration connection detail by numeric ID.
halo_list_exact_details
Free · Read-only
List Exact Online integration connection details configured in HaloPSA.
halo_list_facebook_details
Free · Read-only
List Facebook integration connection details configured in HaloPSA.
halo_list_forecast_details
Free · Read-only
List Forecast integration connection details configured in HaloPSA.
halo_list_forethought_details
Free · Read-only
List Forethought integration connection details configured in HaloPSA.
halo_list_google_business_details
Free · Read-only
List Google Business Messages integration connection details configured in HaloPSA.
halo_list_gworkspace_details
Free · Read-only
List Google Workspace integration connection details configured in HaloPSA.
halo_list_ingram_micro_details
Free · Read-only
List Ingram Micro integration connection details configured in HaloPSA.
halo_list_ingram_micro_reseller_details
Free · Read-only
List Ingram Micro Reseller integration connection details configured in HaloPSA.
halo_list_jamf_details
Free · Read-only
List Jamf integration connection details configured in HaloPSA.
halo_list_jira_details
Free · Read-only
List Jira integration connection details configured in HaloPSA.
halo_list_kandji_details
Free · Read-only
List Kandji integration connection details configured in HaloPSA.
halo_list_kaseya_vsax_details
Free · Read-only
List Kaseya VSA X integration connection details configured in HaloPSA.
halo_list_manage_engine_details
Free · Read-only
List ManageEngine integration connection details configured in HaloPSA.
halo_list_mattermost_channel_details
Free · Read-only
List Mattermost channel details available for the configured Mattermost integration in HaloPSA.
halo_list_mattermost_details
Free · Read-only
List Mattermost integration connection details configured in HaloPSA.

Integration Config: M-S

ToolWhat it does
halo_create_myob_details
Pro · Write
Create or update a MYOB integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_ncentral_details
Pro · Write
Create or update an N-central integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_pax8_details
Pro · Write
Create or update a Pax8 integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_prtg_details
Pro · Write
Create or update a PRTG integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_quickbooks_details
Pro · Write
Create or update a QuickBooks integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_raynet_details
Pro · Write
Create or update a Raynet integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_sage_business_cloud_details
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_create_sailpoint_details
Pro · Write
Create or update a SailPoint integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_seatgeek_details
Pro · Write
Create or update a SeatGeek integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_sentinelone_details
Pro · Write
Create or update a SentinelOne integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_shopify_details
Pro · Write
Create or update a Shopify integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_slack_details
Pro · Write
Create or update a Slack integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_snipeit_details
Pro · Write
Create or update a Snipe-IT integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_snow_details
Pro · Write
Create or update a Snow integration detail record (upsert — include an "id" in the body to update an existing record).
halo_create_sophos_details
Pro · Write
Create or update a Sophos integration detail record (upsert — include an "id" in the body to update an existing record).
halo_delete_myob_details
Pro · Destructive
Delete a MYOB integration detail record by numeric ID.
halo_delete_ncentral_details
Pro · Destructive
Delete an N-central integration detail record by numeric ID.
halo_delete_pax8_details
Pro · Destructive
Delete a Pax8 integration detail record by numeric ID.
halo_delete_prtg_details
Pro · Destructive
Delete a PRTG integration detail record by numeric ID.
halo_delete_quickbooks_details
Pro · Destructive
Delete a QuickBooks integration detail record by numeric ID.
halo_delete_raynet_details
Pro · Destructive
Delete a Raynet integration detail record by numeric ID.
halo_delete_sage_business_cloud_details
Pro · Destructive
Delete a Sage Business Cloud integration detail record by numeric ID.
halo_delete_sailpoint_details
Pro · Destructive
Delete a SailPoint integration detail record by numeric ID.
halo_delete_seatgeek_details
Pro · Destructive
Delete a SeatGeek integration detail record by numeric ID.
halo_delete_sentinelone_details
Pro · Destructive
Delete a SentinelOne integration detail record by numeric ID.
halo_delete_shopify_details
Pro · Destructive
Delete a Shopify integration detail record by numeric ID.
halo_delete_slack_details
Pro · Destructive
Delete a Slack integration detail record by numeric ID.
halo_delete_snipeit_details
Pro · Destructive
Delete a Snipe-IT integration detail record by numeric ID.
halo_delete_snow_details
Pro · Destructive
Delete a Snow integration detail record by numeric ID.
halo_delete_sophos_details
Pro · Destructive
Delete a Sophos integration detail record by numeric ID.
halo_get_ncentral_details
Free · Read-only
Retrieve a single N-central integration detail record by numeric ID.
halo_get_pax8_details
Free · Read-only
Retrieve a single Pax8 integration detail record by numeric ID.
halo_get_prtg_details
Free · Read-only
Retrieve a single PRTG integration detail record by numeric ID.
halo_get_raynet_details
Free · Read-only
Retrieve a single Raynet integration detail record by numeric ID.
halo_get_sailpoint_details
Free · Read-only
Retrieve a single SailPoint integration detail record by numeric ID.
halo_get_seatgeek_details
Free · Read-only
Retrieve a single SeatGeek integration detail record by numeric ID.
halo_get_sentinelone_details
Free · Read-only
Retrieve a single SentinelOne integration detail record by numeric ID.
halo_get_service_request_details
Free · Read-only
Retrieve a single service request detail record by numeric ID.
halo_get_shopify_details
Free · Read-only
Retrieve a single Shopify integration detail record by numeric ID.
halo_get_slack_details
Free · Read-only
Retrieve a single Slack integration detail record by numeric ID.
halo_get_snipeit_details
Free · Read-only
Retrieve a single Snipe-IT integration detail record by numeric ID.
halo_get_snow_details
Free · Read-only
Retrieve a single Snow integration detail record by numeric ID.
halo_get_sophos_details
Free · Read-only
Retrieve a single Sophos integration detail record by numeric ID.
halo_list_ncentral_details
Free · Read-only
List all N-central integration detail records configured in HaloPSA.
halo_list_pax8_details
Free · Read-only
List all Pax8 integration detail records configured in HaloPSA.
halo_list_prtg_details
Free · Read-only
List all PRTG integration detail records configured in HaloPSA.
halo_list_raynet_details
Free · Read-only
List all Raynet integration detail records configured in HaloPSA.
halo_list_sailpoint_details
Free · Read-only
List all SailPoint integration detail records configured in HaloPSA.
halo_list_seatgeek_details
Free · Read-only
List all SeatGeek integration detail records configured in HaloPSA.
halo_list_service_request_details
Free · Read-only
List all service request detail records configured in HaloPSA.
halo_list_shopify_details
Free · Read-only
List all Shopify integration detail records configured in HaloPSA.
halo_list_slack_details
Free · Read-only
List all Slack integration detail records configured in HaloPSA.
halo_list_snipeit_details
Free · Read-only
List all Snipe-IT integration detail records configured in HaloPSA.
halo_list_snow_details
Free · Read-only
List all Snow integration detail records configured in HaloPSA.
halo_uninstall_slack_details
Pro · Destructive
Uninstall the Slack integration (POST /SlackDetails/Uninstall).

Integration Config: S-X

ToolWhat it does
halo_create_streamone_ion_details
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_create_synnex_details
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_create_tanium_details
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_create_techdata_reseller_details
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_create_tenable_details
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_create_twilio_whatsapp_details
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_create_twitter_details
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_create_virima_details
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_create_vmworkspace_details
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_create_wordpress_details
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_create_wordpress_org_details
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_create_xero_details
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_delete_streamone_ion_details
Pro · Destructive
Delete a StreamOne Ion integration connection-detail record by numeric ID.
halo_delete_synnex_details
Pro · Destructive
Delete a Synnex integration connection-detail record by numeric ID.
halo_delete_tanium_details
Pro · Destructive
Delete a Tanium integration connection-detail record by numeric ID.
halo_delete_techdata_reseller_details
Pro · Destructive
Delete a TechData Reseller integration connection-detail record by numeric ID.
halo_delete_tenable_details
Pro · Destructive
Delete a Tenable integration connection-detail record by numeric ID.
halo_delete_twilio_whatsapp_details
Pro · Destructive
Delete a Twilio WhatsApp integration connection-detail record by numeric ID.
halo_delete_twitter_details
Pro · Destructive
Delete a Twitter integration connection-detail record by numeric ID.
halo_delete_virima_details
Pro · Destructive
Delete a Virima integration connection-detail record by numeric ID.
halo_delete_vmworkspace_details
Pro · Destructive
Delete a VMware Workspace integration connection-detail record by numeric ID.
halo_delete_wordpress_details
Pro · Destructive
Delete a WordPress integration connection-detail record by numeric ID.
halo_delete_wordpress_org_details
Pro · Destructive
Delete a WordPress Org integration connection-detail record by numeric ID.
halo_delete_xero_details
Pro · Destructive
Delete a Xero accounting-integration connection-detail record by numeric ID.
halo_get_streamone_ion_details
Free · Read-only
Retrieve a single StreamOne Ion integration connection-detail record by numeric ID.
halo_get_synnex_details
Free · Read-only
Retrieve a single Synnex integration connection-detail record by numeric ID.
halo_get_tanium_details
Free · Read-only
Retrieve a single Tanium integration connection-detail record by numeric ID.
halo_get_techdata_reseller_details
Free · Read-only
Retrieve a single TechData Reseller integration connection-detail record by numeric ID.
halo_get_tenable_details
Free · Read-only
Retrieve a single Tenable integration connection-detail record by numeric ID.
halo_get_twilio_whatsapp_details
Free · Read-only
Retrieve a single Twilio WhatsApp integration connection-detail record by numeric ID.
halo_get_twitter_details
Free · Read-only
Retrieve a single Twitter integration connection-detail record by numeric ID.
halo_get_virima_details
Free · Read-only
Retrieve a single Virima integration connection-detail record by numeric ID.
halo_get_vmworkspace_details
Free · Read-only
Retrieve a single VMware Workspace integration connection-detail record by numeric ID.
halo_get_wordpress_details
Free · Read-only
Retrieve a single WordPress integration connection-detail record by numeric ID.
halo_get_wordpress_org_details
Free · Read-only
Retrieve a single WordPress Org integration connection-detail record by numeric ID.
halo_list_streamone_ion_details
Free · Read-only
List StreamOne Ion integration connection-detail records configured in HaloPSA.
halo_list_synnex_details
Free · Read-only
List Synnex integration connection-detail records configured in HaloPSA.
halo_list_tanium_details
Free · Read-only
List Tanium integration connection-detail records configured in HaloPSA.
halo_list_techdata_reseller_details
Free · Read-only
List TechData Reseller integration connection-detail records configured in HaloPSA.
halo_list_tenable_details
Free · Read-only
List Tenable integration connection-detail records configured in HaloPSA.
halo_list_twilio_details
Free · Read-only
List Twilio integration connection-detail records configured in HaloPSA.
halo_list_twilio_whatsapp_details
Free · Read-only
List Twilio WhatsApp integration connection-detail records configured in HaloPSA.
halo_list_twitter_details
Free · Read-only
List Twitter integration connection-detail records configured in HaloPSA.
halo_list_virima_details
Free · Read-only
List Virima integration connection-detail records configured in HaloPSA.
halo_list_vmworkspace_details
Free · Read-only
List VMware Workspace integration connection-detail records configured in HaloPSA.
halo_list_wordpress_details
Free · Read-only
List WordPress integration connection-detail records configured in HaloPSA.
halo_list_wordpress_org_details
Free · Read-only
List WordPress Org integration connection-detail records configured in HaloPSA.

Integration Connectors

ToolWhat it does
halo_create_action_halo_integration
Pro · Write
Create a Halo action via the HaloIntegration/CreateAction inbound-integration endpoint.
halo_create_azure_ad_connection
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_create_azure_delta
Pro · Write
Create or update an Azure Delta record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_azure_dev_ops
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_create_config_commit
Pro · Write
Create or update a configuration-commit record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_connected_instance
Pro · Write
Create or update a connected-instance record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_csv_template
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_create_import_csv
Pro · Write
Create or update a CSV import record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_incoming_event
Pro · Write
Create or update an incoming-event record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_incoming_webhook
Pro · Write
Create or update an incoming-webhook record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_integration_configuration
Pro · Write
Create or update an integration-configuration record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_integration_delta
Pro · Write
Create or update an integration-delta record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_integration_error
Pro · Write
Create or update an integration-error record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_integration_export
Pro · Write
Create or update an integration-export record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_ticket_halo_integration
Pro · Write
Create a Halo ticket via the HaloIntegration/CreateTicket inbound-integration endpoint.
halo_delete_azure_ad_connection
Pro · Destructive
Delete an Azure AD (Entra ID) connection record by numeric ID.
halo_delete_azure_delta
Pro · Destructive
Delete an Azure Delta record by numeric ID.
halo_delete_azure_dev_ops
Pro · Destructive
Delete an Azure DevOps integration connection-detail record by numeric ID.
halo_delete_config_commit
Pro · Destructive
Delete a configuration-commit record by numeric ID.
halo_delete_connected_instance
Pro · Destructive
Delete a connected-instance record by numeric ID.
halo_delete_csv_template
Pro · Destructive
Delete a CSV import-template record by numeric ID.
halo_delete_import_csv
Pro · Destructive
Delete a CSV import record by numeric ID.
halo_delete_incoming_event
Pro · Destructive
Delete an incoming-event record by numeric ID.
halo_delete_incoming_webhook
Pro · Destructive
Delete an incoming-webhook record by numeric ID.
halo_delete_integration_delta
Pro · Destructive
Delete an integration-delta record by numeric ID.
halo_delete_integration_error
Pro · Destructive
Delete an integration-error record by numeric ID.
halo_delete_integration_export
Pro · Destructive
Delete an integration-export record by numeric ID.
halo_get_azure_ad_connection
Free · Read-only
Retrieve a single Azure AD (Entra ID) connection record by numeric ID.
halo_get_azure_delta
Free · Read-only
Retrieve a single Azure Delta record by numeric ID.
halo_get_azure_dev_ops
Free · Read-only
Retrieve a single Azure DevOps integration connection-detail record by numeric ID.
halo_get_config_commit
Free · Read-only
Retrieve a single configuration-commit record by numeric ID.
halo_get_connected_instance
Free · Read-only
Retrieve a single connected-instance record by numeric ID.
halo_get_csv_template
Free · Read-only
Retrieve a single CSV import-template record by numeric ID.
halo_get_halo_integration
Free · Read-only
Retrieve HaloIntegration inbound-integration data via the HaloIntegration/Get endpoint.
halo_get_import_csv
Free · Read-only
Retrieve a single CSV import record by numeric ID.
halo_get_incoming_event
Free · Read-only
Retrieve a single incoming-event record by numeric ID.
halo_get_incoming_webhook
Free · Read-only
Retrieve a single incoming-webhook record by numeric ID.
halo_get_integration_delta
Free · Read-only
Retrieve a single integration-delta record by numeric ID.
halo_list_azure_ad_connection
Free · Read-only
List Azure AD (Entra ID) connection records configured in HaloPSA.
halo_list_azure_ad_mapping
Free · Read-only
List Azure AD (Entra ID) field-mapping records configured in HaloPSA.
halo_list_azure_delta
Free · Read-only
List Azure Delta records configured in HaloPSA.
halo_list_azure_dev_ops
Free · Read-only
List Azure DevOps integration connection-detail records configured in HaloPSA.
halo_list_config_commit
Free · Read-only
List configuration-commit records in HaloPSA.
halo_list_connected_instance
Free · Read-only
List connected-instance records in HaloPSA.
halo_list_csv_template
Free · Read-only
List CSV import-template records in HaloPSA.
halo_list_import_csv
Free · Read-only
List CSV import records in HaloPSA.
halo_list_incoming_event
Free · Read-only
List incoming-event records in HaloPSA.
halo_list_incoming_webhook
Free · Read-only
List incoming-webhook records in HaloPSA.
halo_list_integration_delta
Free · Read-only
List integration-delta records in HaloPSA.
halo_list_integration_export
Free · Read-only
List integration-export records in HaloPSA.
halo_process_incoming_event
Pro · Destructive
Process pending incoming events via the IncomingEvent/Process endpoint.
halo_process_incoming_webhook
Pro · Destructive
Process queued incoming webhook attempts via the IncomingWebhook/Process endpoint.

Integration Mappings

ToolWhat it does
halo_create_integration_field_data
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_create_integration_request
Pro · Write
Create or update an integration request record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_microsoft_subscription_mapping
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_create_microsoft_teams_mapping
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_create_outbound_integration
Pro · Write
Create or update an outbound (custom) integration (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_outbound_integration_method
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_create_slack_chat_app
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_create_sql_import
Pro · Write
Create or update a SQL import configuration (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_webhook_event
Pro · Write
Create or update a webhook event record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_delete_integration_field_data
Pro · Destructive
Delete an integration field-data mapping record by numeric ID.
halo_delete_integration_request
Pro · Destructive
Delete an integration request record by numeric ID.
halo_delete_microsoft_subscription_mapping
Pro · Destructive
Delete a Microsoft subscription mapping record by numeric ID.
halo_delete_microsoft_teams_mapping
Pro · Destructive
Delete a Microsoft Teams mapping record by numeric ID.
halo_delete_outbound_integration
Pro · Destructive
Delete an outbound (custom) integration by numeric ID.
halo_delete_outbound_integration_method
Pro · Destructive
Delete an outbound (custom) integration method by numeric ID.
halo_delete_slack_chat_app
Pro · Destructive
Delete a Slack chat app record by numeric ID.
halo_delete_sql_import
Pro · Destructive
Delete a SQL import configuration by numeric ID.
halo_get_integration_field_data
Free · Read-only
Retrieve a single integration field-data mapping record by numeric ID.
halo_get_integration_runbook_variable_group
Free · Read-only
Retrieve a single integration runbook variable group by numeric ID.
halo_get_microsoft_subscription_mapping
Free · Read-only
Retrieve a single Microsoft subscription mapping record by numeric ID.
halo_get_microsoft_teams_mapping
Free · Read-only
Retrieve a single Microsoft Teams mapping record by numeric ID.
halo_get_outbound_integration
Free · Read-only
Retrieve a single outbound (custom) integration by numeric ID.
halo_get_outbound_integration_method
Free · Read-only
Retrieve a single outbound (custom) integration method by numeric ID.
halo_get_outbound_integration_repository
Free · Read-only
Retrieve a single outbound (custom) integration repository entry by numeric ID.
halo_get_slack_chat_app
Free · Read-only
Retrieve a single Slack chat app record by numeric ID.
halo_get_sql_import
Free · Read-only
Retrieve a single SQL import configuration by numeric ID.
halo_get_webhook_event
Free · Read-only
Retrieve a single webhook event record by its GUID.
halo_get_webhook_repository
Free · Read-only
Retrieve a single webhook repository entry by its GUID.
halo_get_xtype_mapping
Free · Read-only
Retrieve a single asset-type (XType) mapping record by numeric ID.
halo_list_integration_field_data
Free · Read-only
List integration field-data mapping records configured in HaloPSA.
halo_list_integration_runbook_variable_group
Free · Read-only
List integration runbook variable groups configured in HaloPSA.
halo_list_microsoft_subscription_mapping
Free · Read-only
List Microsoft subscription mapping records configured in HaloPSA.
halo_list_microsoft_teams_mapping
Free · Read-only
List Microsoft Teams mapping records configured in HaloPSA.
halo_list_object_mapping_profile
Free · Read-only
List object-mapping profiles configured in HaloPSA.
halo_list_outbound_integration
Free · Read-only
List outbound (custom) integrations configured in HaloPSA.
halo_list_outbound_integration_method
Free · Read-only
List outbound (custom) integration methods configured in HaloPSA.
halo_list_outbound_integration_method_value
Free · Read-only
List outbound (custom) integration method values configured in HaloPSA.
halo_list_outbound_integration_repository
Free · Read-only
List the outbound (custom) integration repository entries available in HaloPSA.
halo_list_pagerduty_mapping
Free · Read-only
List PagerDuty mapping records configured in HaloPSA.
halo_list_sailpoint_role_mapping
Free · Read-only
List SailPoint role mapping records configured in HaloPSA.
halo_list_sailpoint_user_mapping
Free · Read-only
List SailPoint user mapping records configured in HaloPSA.
halo_list_slack_chat_app
Free · Read-only
List Slack chat app records configured in HaloPSA.
halo_list_sql_import
Free · Read-only
List SQL import configurations defined in HaloPSA.
halo_list_webhook_repository
Free · Read-only
List the webhook repository entries available in HaloPSA.
halo_list_xtype_mapping
Free · Read-only
List asset-type (XType) mapping records configured in HaloPSA.
halo_list_xtype_role
Free · Read-only
List asset-type (XType) role records configured in HaloPSA.

Custom Fields & Types

ToolWhat it does
halo_add_field_to_all
Pro · Write
Add an existing ASSET-TYPE field to all field groups via the Field/AddFieldToAll action.
halo_create_field
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_create_field_group
Pro · Write
Create or update a field group (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_field_info
Pro · Write
Create or update a CUSTOM FIELD definition (POST /FieldInfo; HaloPSA POST is an upsert, so include an "id" to update).
halo_create_screen_layout
Pro · Write
Create or update a screen layout (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_section_detail
Pro · Write
Create or update an agent team / section (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_style_profile
Pro · Write
Create or update a style profile (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_toutcome
Pro · Write
Create or update a ticket action outcome (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_tree
Pro · Write
Create or update a top-level tree node (TopLevel) (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_tstatus
Pro · Write
Create or update a ticket status (HaloPSA POST is an upsert — include an "id" field to update).
halo_create_xtype
Pro · Write
Create or update an asset type (HaloPSA POST is an upsert — include an "id" field to update).
halo_delete_field
Pro · Destructive
Delete an ASSET-TYPE field definition by numeric ID (DELETE /Field/{id}).
halo_delete_field_group
Pro · Destructive
Delete a field group by numeric ID.
halo_delete_field_info
Pro · Destructive
Delete a CUSTOM FIELD definition by numeric ID (DELETE /FieldInfo/{id}).
halo_delete_screen_layout
Pro · Destructive
Delete a screen layout by numeric ID.
halo_delete_section_detail
Pro · Destructive
Delete an agent team / section by numeric ID.
halo_delete_style_profile
Pro · Destructive
Delete a style profile by numeric ID.
halo_delete_toutcome
Pro · Destructive
Delete a ticket action outcome by numeric ID.
halo_delete_tree
Pro · Destructive
Delete a top-level tree node (TopLevel) by numeric ID.
halo_delete_tstatus
Pro · Destructive
Delete a ticket status by numeric ID.
halo_delete_xtype
Pro · Destructive
Delete an asset type by numeric ID.
halo_get_category_detail
Free · Read-only
Retrieve a single category definition by numeric ID from the HaloPSA Category configuration.
halo_get_field_group
Free · Read-only
Retrieve a single field group by numeric ID.
halo_get_screen_layout
Free · Read-only
Retrieve a single screen layout by numeric ID.
halo_get_section_detail
Free · Read-only
Retrieve a single agent team / section by numeric ID from the HaloPSA Team configuration.
halo_get_section_detail_tree
Free · Read-only
Retrieve the agent team (section) hierarchy as a tree via the Team/Tree endpoint.
halo_get_style_profile
Free · Read-only
Retrieve a single style profile by numeric ID.
halo_get_toutcome
Free · Read-only
Retrieve a single ticket action outcome by numeric ID from the HaloPSA Outcome configuration.
halo_get_tree
Free · Read-only
Retrieve a single top-level tree node (TopLevel) by numeric ID.
halo_get_tstatus
Free · Read-only
Retrieve a single ticket status by numeric ID from the HaloPSA Status configuration.
halo_get_xtype
Free · Read-only
Retrieve a single asset type by numeric ID from the HaloPSA AssetType configuration.
halo_list_criteria_group
Free · Read-only
List criteria groups configured in HaloPSA — the reusable condition sets referenced by rules, automations and views.
halo_list_field_group
Free · Read-only
List field groups configured in HaloPSA — the containers that organise custom fields into sections on forms.
halo_list_halo_field
Free · Read-only
List the built-in HaloField catalog — the standard (system) field definitions available across HaloPSA.
halo_list_screen_layout
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_list_style_profile
Free · Read-only
List style profiles configured in HaloPSA — the branding/appearance profiles that control colours and styling of portals and emails.
halo_list_tree
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_list_type_info
Free · Read-only
List asset type info (AssetTypeInfo) — a lightweight summary of the asset types configured in HaloPSA.

Ticket Structure

ToolWhat it does
halo_area_new_accounts_id
Pro · Write
Allocate/return the next new account ID for a HaloPSA Client (Area) via the /Client/NewAccountsId endpoint.
halo_area_payment_method_update
Pro · Write
Update the stored payment method for a HaloPSA Client (Area) via the /Client/PaymentMethodUpdate endpoint.
halo_create_autoassign
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_create_confirm_closure
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_create_journey
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_create_qualification
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_create_request_type
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_create_request_type_group
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_create_setup_tab
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_create_tabname
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_create_ticket_area
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_create_workflow_target
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_delete_area
Pro · Destructive
Delete a HaloPSA Client (Area) record by numeric ID via the /Client/{id} endpoint.
halo_delete_area_note
Pro · Destructive
Delete an Area (Client) CRM note by numeric ID via the /CRMNote/{id} endpoint.
halo_delete_autoassign
Pro · Destructive
Delete a ticket auto-assign rule by numeric ID via the /TicketRules/{id} endpoint.
halo_delete_confirm_closure
Pro · Destructive
Delete a confirm-closure rule by numeric ID via the /ConfirmClosure/{id} endpoint.
halo_delete_journey
Pro · Destructive
Delete a journey by numeric ID via the /Journey/{id} endpoint.
halo_delete_qualification
Pro · Destructive
Delete a qualification by numeric ID via the /Qualification/{id} endpoint.
halo_delete_request_type
Pro · Destructive
Delete a ticket request type by numeric ID via the /TicketType/{id} endpoint.
halo_delete_request_type_group
Pro · Destructive
Delete a ticket request-type group by numeric ID via the /TicketTypeGroup/{id} endpoint.
halo_delete_tabname
Pro · Destructive
Delete a tab name by numeric ID via the /Tabs/{id} endpoint.
halo_delete_ticket_area
Pro · Destructive
Delete a ticket-area record by numeric ID via the /TicketArea/{id} endpoint.
halo_delete_workflow_target
Pro · Destructive
Delete a workflow target by numeric ID via the /WorkflowTarget/{id} endpoint.
halo_get_area_me
Free · Read-only
Retrieve the HaloPSA Client (Area) record associated with the currently authenticated user via the /Client/me endpoint.
halo_get_area_note
Free · Read-only
Retrieve a single Area (Client) CRM note by numeric ID via the /CRMNote/{id} endpoint.
halo_get_area_request_type
Free · Read-only
Retrieve a single Area↔request-type link by numeric ID via the /AreaRequestType/{id} endpoint.
halo_get_autoassign
Free · Read-only
Retrieve a single ticket auto-assign rule by numeric ID via the /TicketRules/{id} endpoint.
halo_get_confirm_closure
Free · Read-only
Retrieve a single confirm-closure rule by numeric ID via the /ConfirmClosure/{id} endpoint.
halo_get_journey
Free · Read-only
Retrieve a single journey by numeric ID via the /Journey/{id} endpoint.
halo_get_qualification
Free · Read-only
Retrieve a single qualification by numeric ID via the /Qualification/{id} endpoint.
halo_get_request_type
Free · Read-only
Retrieve a single ticket request type by numeric ID via the /TicketType/{id} endpoint.
halo_get_request_type_group
Free · Read-only
Retrieve a single ticket request-type group by numeric ID via the /TicketTypeGroup/{id} endpoint.
halo_get_setup_tab
Free · Read-only
Retrieve a single setup tab by numeric ID via the /SetupTab/{id} endpoint.
halo_get_setup_tab_group
Free · Read-only
Retrieve a single setup-tab group by numeric ID via the /SetupTabGroup/{id} endpoint.
halo_get_tabname
Free · Read-only
Retrieve a single tab name by numeric ID via the /Tabs/{id} endpoint.
halo_get_ticket_area
Free · Read-only
Retrieve a single ticket-area record by numeric ID via the /TicketArea/{id} endpoint.
halo_get_workflow_target
Free · Read-only
Retrieve a single workflow target by numeric ID via the /WorkflowTarget/{id} endpoint.
halo_list_area_azure_tenant
Free · Read-only
List the Azure-tenant links associated with HaloPSA Areas (Clients).
halo_list_area_item
Free · Read-only
List Area recurring-item records via the /RecurringItem endpoint.
halo_list_autoassign
Free · Read-only
List ticket auto-assign rules via the /TicketRules endpoint.
halo_list_confirm_closure
Free · Read-only
List confirm-closure rules via the /ConfirmClosure endpoint.
halo_list_journey
Free · Read-only
List journeys via the /Journey endpoint.
halo_list_qualification
Free · Read-only
List qualifications via the /Qualification endpoint.
halo_list_request_type_group
Free · Read-only
List ticket request-type groups via the /TicketTypeGroup endpoint.
halo_list_setup_tab
Free · Read-only
List setup tabs via the /SetupTab endpoint.
halo_list_setup_tab_group
Free · Read-only
List setup-tab groups via the /SetupTabGroup endpoint.
halo_list_tabname
Free · Read-only
List tab names via the /Tabs endpoint.
halo_list_workflow_target
Free · Read-only
List workflow targets via the /WorkflowTarget endpoint.

Mailbox & Email Config

ToolWhat it does
halo_add_to_ticket_incoming_email
Pro · Destructive
Ingest an incoming email onto a ticket via the incomingemail/AddToTicket endpoint.
halo_azure_mail
Pro · Destructive
Invoke the Mail/Azure endpoint, which connects/authorises an Azure (Microsoft 365) mailbox for HaloPSA mail processing.
halo_create_email_store
Pro · Write
Create or update an email-store record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_formatted_email
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_create_incoming_email
Pro · Write
Create or update an incoming-email record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_mailbox
Pro · Write
Create or update a mailbox configuration (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_mailbox_credential
Pro · Write
Create or update a mailbox-credential record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_outgoing_email
Pro · Write
Create or update an outgoing-email record (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_sales_mailbox
Pro · Write
Create or update a sales-mailbox configuration (HaloPSA POST is an upsert — include an "id" field to update an existing record).
halo_create_sales_mailbox_detail
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_delete_email_store
Pro · Destructive
Delete an email-store record by numeric ID.
halo_delete_formatted_email
Pro · Destructive
Delete a formatted (templated) email record by numeric ID.
halo_delete_incoming_email
Pro · Destructive
Delete an incoming-email record by numeric ID.
halo_delete_mailbox
Pro · Destructive
Delete a mailbox configuration by numeric ID.
halo_delete_mailbox_credential
Pro · Destructive
Delete a mailbox-credential record by numeric ID.
halo_delete_outgoing
Pro · Destructive
Delete an outgoing-mail server configuration by numeric ID.
halo_delete_outgoing_email
Pro · Destructive
Delete an outgoing-email record by numeric ID.
halo_delete_sales_mailbox
Pro · Destructive
Delete a sales-mailbox configuration by numeric ID.
halo_get_email_store
Free · Read-only
Retrieve a single email-store record by numeric ID.
halo_get_formatted_email
Free · Read-only
Retrieve a single formatted (templated) email record by numeric ID.
halo_get_incoming_email
Free · Read-only
Retrieve a single incoming-email record by numeric ID.
halo_get_mailbox
Free · Read-only
Retrieve a single mailbox configuration by numeric ID.
halo_get_mailbox_credential
Free · Read-only
Retrieve a single mailbox-credential record by numeric ID.
halo_get_outgoing
Free · Read-only
Retrieve a single outgoing-mail server configuration by numeric ID.
halo_get_sales_mailbox
Free · Read-only
Retrieve a single sales-mailbox configuration by numeric ID.
halo_integrator_azure_mail
Pro · Destructive
Invoke the Mail/Integrator/Azure endpoint, which runs the Azure mail-integrator connect/process action for HaloPSA mailbox ingestion.
halo_integrator_google_mail
Pro · Destructive
Invoke the Mail/Integrator/Google endpoint, which runs the Google (Gmail/Workspace) mail-integrator connect/process action for HaloPSA mailbox ingestion.
halo_integrator_imap_mail
Pro · Destructive
Invoke the Mail/Integrator/IMAP endpoint, which runs the IMAP mail-integrator connect/process action for HaloPSA mailbox ingestion.
halo_integrator_pop3_mail
Pro · Destructive
Invoke the Mail/Integrator/Pop3 endpoint, which runs the POP3 mail-integrator connect/process action for HaloPSA mailbox ingestion.
halo_list_email_address_book
Free · Read-only
List the email address book (users/contacts available as email recipients) configured in HaloPSA.
halo_list_email_store
Free · Read-only
List email-store records in HaloPSA (stored/queued email items).
halo_list_formatted_email
Free · Read-only
List formatted (templated) email records in HaloPSA.
halo_list_incoming_email
Free · Read-only
List incoming-email records in HaloPSA (emails received into the system).
halo_list_mailbox
Free · Read-only
List mailbox configurations in HaloPSA (the mailboxes HaloPSA polls for inbound email).
halo_list_mailbox_credential
Free · Read-only
List mailbox-credential records in HaloPSA (the stored auth credentials used to connect to mailboxes).
halo_list_mailbox_outlook_contacts
Free · Read-only
List the Outlook contacts associated with a HaloPSA mailbox via the Mailbox/{id}/OutlookContacts endpoint.
halo_list_outgoing
Free · Read-only
List outgoing-mail server configurations in HaloPSA (the SMTP/send profiles HaloPSA uses to send email).
halo_list_outgoing_email
Free · Read-only
List outgoing-email records in HaloPSA (emails sent/queued for sending by the system).
halo_list_sales_mailbox
Free · Read-only
List sales-mailbox configurations in HaloPSA (mailboxes used for CRM/sales lead ingestion).
halo_list_sales_mailbox_detail
Free · Read-only
List sales-mailbox detail records in HaloPSA (the detailed per-mailbox sales configuration entries).
halo_process_mail
Pro · Destructive
Invoke the Mail/ProcessMail endpoint, which processes the specified queued mailbox items in HaloPSA (creating/updating tickets and firing notifications).
halo_process_outgoing
Pro · Destructive
Act on queued outgoing mail items by ID (POST /Outgoing).

Notifications & Distribution

ToolWhat it does
halo_create_address_store
Pro · Write
Create or update an AddressStore record (POST /Address).
halo_create_distribution_list
Pro · Write
Create or update a distribution list (POST /DistributionLists).
halo_create_distribution_list_log
Pro · Write
Create or update a distribution list log entry (POST /DistributionListsLog).
halo_create_esc_msg
Pro · Write
Create or update an escalation/notification message (POST /Notifications).
halo_create_event_rule
Pro · Write
Create or update an event rule (POST /EventRule).
halo_create_marketing_open
Pro · Write
Create or update a marketing open record (POST /MO).
halo_create_marketing_unsubscribe
Pro · Write
Create or update a marketing unsubscribe record (POST /MarketingUnsubscribe).
halo_create_unsub_email_service_users
Pro · Write
Create or update an unsubscribed email service user record (POST /UnsubServiceEmails).
halo_delete_address_store
Pro · Destructive
Delete an AddressStore record by numeric ID (DELETE /Address/{id}).
halo_delete_distribution_list
Pro · Destructive
Delete a distribution list by numeric ID (DELETE /DistributionLists/{id}).
halo_delete_distribution_list_log
Pro · Destructive
Delete a distribution list log entry by numeric ID (DELETE /DistributionListsLog/{id}).
halo_delete_esc_msg
Pro · Destructive
Delete an escalation/notification message by ID (DELETE /Notifications/{id}).
halo_delete_event
Pro · Destructive
Delete an event definition by numeric ID (DELETE /Event/{id}).
halo_delete_event_rule
Pro · Destructive
Delete an event rule by numeric ID (DELETE /EventRule/{id}).
halo_delete_marketing_open
Pro · Destructive
Delete a marketing open record by numeric ID (DELETE /MO/{id}).
halo_delete_marketing_unsubscribe
Pro · Destructive
Delete a marketing unsubscribe record by numeric ID (DELETE /MarketingUnsubscribe/{id}).
halo_delete_notification_content
Pro · Destructive
Delete a notification content record by numeric ID (DELETE /NotificationMessage/{id}).
halo_delete_teams_chat_message
Pro · Destructive
Delete an external (Teams) chat message record by numeric ID (DELETE /ExternalChatMessage/{id}).
halo_delete_unsub_email_service_users
Pro · Destructive
Delete an unsubscribed email service user record by numeric ID (DELETE /UnsubServiceEmails/{id}).
halo_get_address_store
Free · Read-only
Retrieve a single AddressStore record by numeric ID (GET /Address/{id}).
halo_get_distribution_list
Free · Read-only
Retrieve a single distribution list by numeric ID (GET /DistributionLists/{id}).
halo_get_distribution_list_log
Free · Read-only
Retrieve a single distribution list log entry by numeric ID (GET /DistributionListsLog/{id}).
halo_get_esc_msg
Free · Read-only
Retrieve a single escalation/notification message by ID (GET /Notifications/{id}).
halo_get_event
Free · Read-only
Retrieve a single event by numeric ID (GET /Event/{id}).
halo_get_event_rule
Free · Read-only
Retrieve a single event rule by numeric ID (GET /EventRule/{id}).
halo_get_marketing_open
Free · Read-only
Retrieve a single marketing open record by numeric ID (GET /MO/{id}).
halo_get_marketing_unsubscribe
Free · Read-only
Retrieve a single marketing unsubscribe record by numeric ID (GET /MarketingUnsubscribe/{id}).
halo_get_notification_content
Free · Read-only
Retrieve a single notification content record by numeric ID (GET /NotificationMessage/{id}).
halo_get_teams_chat_message
Free · Read-only
Retrieve a single external (Teams) chat message by numeric ID (GET /ExternalChatMessage/{id}).
halo_get_unsub_email_service_users
Free · Read-only
Retrieve a single unsubscribed email service user record by numeric ID (GET /UnsubServiceEmails/{id}).
halo_list_address_store
Free · Read-only
List AddressStore records (GET /Address) — the marketing/distribution address book HaloPSA uses for bulk email.
halo_list_distribution_list
Free · Read-only
List distribution lists (GET /DistributionLists) — the recipient groups HaloPSA uses for bulk/marketing email.
halo_list_distribution_list_log
Free · Read-only
List distribution list log entries (GET /DistributionListsLog) — the send/activity history for HaloPSA distribution lists.
halo_list_esc_msg
Free · Read-only
List escalation/notification messages (GET /Notifications) — the EscMsg records that drive HaloPSA escalation notifications.
halo_list_event
Free · Read-only
List configured events (GET /Event) — the event definitions HaloPSA uses to trigger notifications and automation.
halo_list_event_rule
Free · Read-only
List event rules (GET /EventRule) — the conditions/criteria that gate HaloPSA event firing.
halo_list_marketing_open
Free · Read-only
List marketing open records (GET /MO) — the email-open tracking records for HaloPSA marketing campaigns.
halo_list_marketing_unsubscribe
Free · Read-only
List marketing unsubscribe records (GET /MarketingUnsubscribe) — the opt-out list for HaloPSA marketing email.
halo_list_notification_content
Free · Read-only
List notification content records (GET /NotificationMessage) — the rendered notification message bodies HaloPSA has generated.
halo_list_teams_chat_message
Free · Read-only
List external (Microsoft Teams) chat messages (GET /ExternalChatMessage) tracked by HaloPSA.
halo_list_unsub_email_service_users
Free · Read-only
List unsubscribed email service users (GET /UnsubServiceEmails) — the service users who have opted out of HaloPSA email.
halo_marketing_open_b
Free · Read-only
Undocumented HaloPSA endpoint (/MO/b) — exact semantics are not in the API spec; passes through raw.
halo_marketing_open_r
Free · Read-only
Undocumented HaloPSA endpoint (/MO/r) — exact semantics are not in the API spec; passes through raw.
halo_process_esc_msg
Pro · Destructive
Trigger processing of pending HaloPSA escalation/notification messages (POST /Notifications/process).
halo_process_event
Pro · Destructive
Act on event records by ID (POST /Event).
halo_send_teams_chat_message
Pro · Destructive
Send an external (Microsoft Teams) chat message via HaloPSA (POST /ExternalChatMessage).

Instance & System Setup

ToolWhat it does
halo_create_audit
Pro · Write
Create an audit-log entry.
halo_create_contract_schedule_plan
Pro · Write
Create or update a contract schedule plan (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_dashboard_link
Pro · Write
Create or update a dashboard link (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_halo_news
Pro · Write
Create or update a Halo news/announcement item (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_organisation
Pro · Write
Create or update an organisation (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_publish_profile
Pro · Write
Create or update a publish profile (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_release_note_group
Pro · Write
Create or update a release note group (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_view_list_group
Pro · Write
Create or update a view list group (HaloPSA POST is an upsert — include an 'id' field to update).
halo_delete_audit
Pro · Destructive
Delete an audit-log entry by numeric ID.
halo_delete_company
Pro · Destructive
Delete a company/supplier record by numeric ID (HaloPSA models companies under the Supplier resource).
halo_delete_contract_schedule_plan
Pro · Destructive
Delete a contract schedule plan by numeric ID.
halo_delete_dashboard_link
Pro · Destructive
Delete a dashboard link by numeric ID.
halo_delete_halo_news
Pro · Destructive
Delete a Halo news/announcement item by numeric ID.
halo_delete_nhserver_config
Pro · Destructive
Delete an NH server configuration record by numeric ID.
halo_delete_organisation
Pro · Destructive
Delete an organisation by numeric ID.
halo_delete_publish_profile
Pro · Destructive
Delete a publish profile by numeric ID.
halo_delete_release_note_group
Pro · Destructive
Delete a release note group by numeric ID.
halo_delete_view_list_group
Pro · Destructive
Delete a view list group by numeric ID.
halo_get_contract_schedule_plan
Free · Read-only
Retrieve a single contract schedule plan by numeric ID.
halo_get_dashboard_link
Free · Read-only
Retrieve a single dashboard link by numeric ID.
halo_get_dashboard_link_filter_values
Free · Read-only
Retrieve the available filter values for dashboard links.
halo_get_dashboard_links_repository
Free · Read-only
Retrieve a single dashboard links repository entry by numeric ID.
halo_get_halo_news
Free · Read-only
Retrieve a single Halo news/announcement item by numeric ID.
halo_get_instance
Free · Read-only
Retrieve a single HaloPSA instance configuration record by numeric ID.
halo_get_module_setup
Free · Read-only
Retrieve a single module/feature setup record by numeric ID (HaloPSA models module setup under the Features resource).
halo_get_nhserver_config
Free · Read-only
Retrieve a single NH server configuration record by numeric ID.
halo_get_organisation
Free · Read-only
Retrieve a single organisation by numeric ID.
halo_get_publish_profile
Free · Read-only
Retrieve a single publish profile by numeric ID.
halo_get_release_note_group
Free · Read-only
Retrieve a single release note group by numeric ID.
halo_get_report_repository
Free · Read-only
Retrieve a single report repository entry (AnalyzerProfile) by numeric ID.
halo_get_view_list_group
Free · Read-only
Retrieve a single view list group by numeric ID.
halo_list_contract_schedule_plan
Free · Read-only
List contract schedule plans with pagination.
halo_list_dashboard_link
Free · Read-only
List dashboard links with pagination.
halo_list_dashboard_links_repository
Free · Read-only
List the dashboard links repository (shared/template dashboard links) with pagination.
halo_list_halo_news
Free · Read-only
List Halo news/announcement items with pagination.
halo_list_instance
Free · Read-only
List HaloPSA instance configuration records with pagination.
halo_list_module_setup
Free · Read-only
List module/feature setup records with pagination (HaloPSA models module setup under the Features resource).
halo_list_nhserver_config
Free · Read-only
List NH server configuration records with pagination.
halo_list_organisation
Free · Read-only
List organisations with pagination.
halo_list_publish_profile
Free · Read-only
List publish profiles with pagination.
halo_list_release_note_group
Free · Read-only
List release note groups with pagination.
halo_list_report_repository
Free · Read-only
List the report repository (shared/template report AnalyzerProfiles) with pagination.
halo_list_report_repository_categories
Free · Read-only
List the report categories available in the report repository.
halo_list_tenant
Free · Read-only
List tenant configuration records with pagination.
halo_list_user_change
Free · Read-only
List user change records with pagination.
halo_list_view_list_group
Free · Read-only
List view list groups with pagination.
halo_mark_halo_news_read
Pro · Write
Mark Halo news/announcement item(s) as read for the current user.
halo_update_instance
Pro · Write
Update HaloPSA instance configuration (POST is an upsert — include the 'id' field to target an existing instance record).
halo_update_module_setup
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_update_nhserver_config
Pro · Write
Update NH server configuration (POST is an upsert — include the 'id' field to target an existing record).
halo_update_tenant
Pro · Write
Update tenant configuration (POST is an upsert — include the 'id' field to target an existing tenant record).

Agents, Roles & Security

ToolWhat it does
halo_create_audit_password_field
Pro · Write
Create a new audit password field.
halo_create_certificate
Pro · Destructive
Create a new certificate.
halo_create_custom_button
Pro · Write
Create a new custom button.
halo_create_custom_button_audit
Pro · Write
Create a custom button audit record (logs a custom-button invocation/change).
halo_create_identity_application
Pro · Write
Create a new identity/OAuth application registration.
halo_create_identity_application_federated_credentials
Pro · Write
Add federated credentials to an identity/OAuth application.
halo_create_key_vault
Pro · Destructive
Create a new key vault entry (stored secret/credential).
halo_create_ldap_connection
Pro · Destructive
Create a new LDAP/Active Directory connection.
halo_create_policy
Pro · Destructive
Create a new policy (HaloPSA models policies under the Priority resource).
halo_create_security_question
Pro · Write
Create a new security question.
halo_create_sso_application
Pro · Destructive
Create a new single sign-on (SSO/SAML) application.
halo_create_user_role
Pro · Write
Create a new user role.
halo_delete_certificate
Pro · Destructive
Delete a certificate by numeric ID.
halo_delete_custom_button
Pro · Destructive
Delete a custom button by numeric ID.
halo_delete_identity_application
Pro · Destructive
Delete an identity/OAuth application by numeric ID.
halo_delete_key_vault
Pro · Destructive
Delete a key vault entry by numeric ID.
halo_delete_ldap_connection
Pro · Destructive
Delete an LDAP/Active Directory connection by numeric ID.
halo_delete_policy
Pro · Destructive
Delete a policy by numeric ID (HaloPSA models policies under the Priority resource).
halo_delete_security_question
Pro · Destructive
Delete a security question by numeric ID.
halo_delete_sso_application
Pro · Destructive
Delete a single sign-on (SSO/SAML) application by numeric ID.
halo_delete_user_role
Pro · Destructive
Delete a user role by numeric ID.
halo_get_agent_image
Free · Read-only
Retrieve an agent's image/avatar by numeric agent ID.
halo_get_audit_password_field
Free · Read-only
Retrieve a single audit password field by numeric ID.
halo_get_certificate
Free · Read-only
Retrieve a single certificate by numeric ID.
halo_get_custom_button
Free · Read-only
Retrieve a single custom button by numeric ID.
halo_get_identity_application
Free · Read-only
Retrieve a single identity/OAuth application by numeric ID.
halo_get_key_vault
Free · Read-only
Retrieve a single key vault entry by numeric ID.
halo_get_ldap_connection
Free · Read-only
Retrieve a single LDAP/Active Directory connection by numeric ID.
halo_get_policy
Free · Read-only
Retrieve a single policy by numeric ID (HaloPSA models policies under the Priority resource).
halo_get_security_question
Free · Read-only
Retrieve a single security question by numeric ID.
halo_get_sso_application
Free · Read-only
Retrieve a single single sign-on (SSO/SAML) application by numeric ID.
halo_get_team_image
Free · Read-only
Retrieve a team's image/avatar by numeric team ID.
halo_get_user_role
Free · Read-only
Retrieve a single user role by numeric ID.
halo_list_audit_password_field
Free · Read-only
List audit password fields (password-field audit configuration) with pagination.
halo_list_certificate
Free · Read-only
List certificates with pagination.
halo_list_custom_button
Free · Read-only
List custom buttons with pagination.
halo_list_identity_application
Free · Read-only
List identity/OAuth applications (the NHD identity application registrations) with pagination.
halo_list_key_vault
Free · Read-only
List key vault entries (stored secrets/credentials configuration) with pagination.
halo_list_ldap_connection
Free · Read-only
List LDAP/Active Directory connections with pagination.
halo_list_licence_role
Free · Read-only
List software licence roles (from the SoftwareLicenceRole resource) with pagination.
halo_list_security_question
Free · Read-only
List security questions with pagination.
halo_list_security_question_validate
Free · Read-only
List the security-question validation configuration with pagination.
halo_list_service_restriction
Free · Read-only
List service restrictions with pagination.
halo_list_sso_application
Free · Read-only
List single sign-on (SSO/SAML) applications with pagination.
halo_list_user_role
Free · Read-only
List user roles with pagination.

Lookups & Reference

ToolWhat it does
halo_clear_lookup_cache
Pro · Write
Clear the server-side lookup cache (POST /Lookup/ClearCache).
halo_create_currency
Pro · Write
Create or update a currency (POST /Currency).
halo_create_holidays
Pro · Write
Create or update a holiday / holiday-set entry (POST /Holiday).
halo_create_language_pack
Pro · Write
Create or update a language pack (POST /Languages).
halo_create_license_info
Pro · Write
Create or update HaloPSA licence information (POST /LicenseInfo).
halo_create_lookup
Pro · Write
Create or update a lookup value (POST /Lookup).
halo_create_release_type
Pro · Write
Create or update a release type (POST /ReleaseType).
halo_create_service_category
Pro · Write
Create or update a service category (POST /ServiceCategory).
halo_create_tax
Pro · Write
Create or update a tax (POST /Tax).
halo_create_tax_rule
Pro · Write
Create or update a tax rule (POST /TaxRule).
halo_create_translation
Pro · Write
Create or update a custom language-pack translation override (POST /Translation).
halo_create_workdays
Pro · Write
Create or update a workday / work-pattern entry (POST /Workday).
halo_delete_currency
Pro · Destructive
Delete a currency by numeric ID (DELETE /Currency/{id}).
halo_delete_holidays
Pro · Destructive
Delete a holiday entry by numeric ID (DELETE /Holiday/{id}).
halo_delete_language_pack
Pro · Destructive
Delete a language pack by numeric ID (DELETE /Languages/{id}).
halo_delete_lookup
Pro · Destructive
Delete a lookup value by numeric ID (DELETE /Lookup/{id}).
halo_delete_release_type
Pro · Destructive
Delete a release type by numeric ID (DELETE /ReleaseType/{id}).
halo_delete_service_category
Pro · Destructive
Delete a service category by numeric ID (DELETE /ServiceCategory/{id}).
halo_delete_tax
Pro · Destructive
Delete a tax by numeric ID (DELETE /Tax/{id}).
halo_delete_tax_rule
Pro · Destructive
Delete a tax rule by numeric ID (DELETE /TaxRule/{id}).
halo_delete_workdays
Pro · Destructive
Delete a workday / work-pattern entry by numeric ID (DELETE /Workday/{id}).
halo_get_charge_rate
Free · Read-only
Retrieve a single charge rate by numeric ID (GET /ChargeRate/{id}).
halo_get_currency
Free · Read-only
Retrieve a single currency by numeric ID (GET /Currency/{id}).
halo_get_holidays
Free · Read-only
Retrieve a single holiday entry by numeric ID (GET /Holiday/{id}).
halo_get_language_pack
Free · Read-only
Retrieve a single language pack by numeric ID (GET /Languages/{id}).
halo_get_license_info_password
Free · Read-only
Retrieve the licence-info password value (GET /LicenseInfo/password).
halo_get_lookup
Free · Read-only
Retrieve a single lookup value by numeric ID (GET /Lookup/{id}).
halo_get_release_type
Free · Read-only
Retrieve a single release type by numeric ID (GET /ReleaseType/{id}).
halo_get_resource_type
Free · Read-only
Retrieve a single resource type by numeric ID (GET /ResourceType/{id}).
halo_get_service_category
Free · Read-only
Retrieve a single service category by numeric ID (GET /ServiceCategory/{id}).
halo_get_tax
Free · Read-only
Retrieve a single tax by numeric ID (GET /Tax/{id}).
halo_get_tax_rule
Free · Read-only
Retrieve a single tax rule by numeric ID (GET /TaxRule/{id}).
halo_get_workdays
Free · Read-only
Retrieve a single workday / work-pattern entry by numeric ID (GET /Workday/{id}).
halo_list_language_pack
Free · Read-only
List the language packs configured in HaloPSA (GET /Languages).
halo_list_license_info
Free · Read-only
List HaloPSA licence information (GET /LicenseInfo).
halo_list_resource_type
Free · Read-only
List resource types (GET /ResourceType).
halo_list_translation
Free · Read-only
List custom language-pack translations (GET /Translation).

SLA, Workflow & Approvals

ToolWhat it does
halo_create_fault_approval
Pro · Write
Create or update a ticket approval record (POST /TicketApproval).
halo_create_schedule
Pro · Write
Create or update a schedule (POST /Schedule).
halo_create_sla
Pro · Write
Create or update an SLA (POST /SLA).
halo_delete_approval_process
Pro · Destructive
Delete an approval process by numeric ID (DELETE /ApprovalProcess/{id}).
halo_delete_approval_process_rule
Pro · Destructive
Delete an approval process rule by numeric ID (DELETE /ApprovalProcessRule/{id}).
halo_delete_fault_approval
Pro · Destructive
Delete a ticket (fault) approval by its composite key (DELETE /TicketApproval/{id}&{seq}).
halo_delete_sla
Pro · Destructive
Delete an SLA by numeric ID (DELETE /SLA/{id}).
halo_get_approval_process_rule
Free · Read-only
Retrieve a single approval process rule by numeric ID (GET /ApprovalProcessRule/{id}).
halo_get_fault_approval
Free · Read-only
Retrieve a single ticket (fault) approval by numeric ID (GET /TicketApproval/{id}).
halo_get_schedule
Free · Read-only
Retrieve a single schedule by numeric ID (GET /Schedule/{id}).
halo_get_schedule_occurrence
Free · Read-only
Retrieve a single schedule occurrence by numeric ID (GET /ScheduleOccurrence/{id}).
halo_list_schedule_occurrence
Free · Read-only
List schedule occurrences (GET /ScheduleOccurrence).
halo_process_schedule_occurrences
Pro · Destructive
Act on schedule occurrences by ID (POST /ScheduleOccurrence).

Views & Canned Text

ToolWhat it does
halo_create_view_columns
Pro · Write
Create or update a view columns definition (POST /ViewColumns).
halo_create_view_filter
Pro · Write
Create or update a view filter (POST /ViewFilter).
halo_create_view_list
Pro · Write
Create or update a view list (POST /ViewLists).
halo_delete_view_columns
Pro · Destructive
Delete a view columns definition by numeric ID (DELETE /ViewColumns/{id}).
halo_delete_view_filter
Pro · Destructive
Delete a view filter by numeric ID (DELETE /ViewFilter/{id}).
halo_delete_view_list
Pro · Destructive
Delete a view list by numeric ID (DELETE /ViewLists/{id}).
halo_favourite_canned_text
Pro · Write
Mark a canned text (predefined reply snippet) as a favourite for quick access (POST /CannedText/favourite).
halo_get_view_columns
Free · Read-only
Retrieve a single view columns definition by numeric ID (GET /ViewColumns/{id}).
halo_get_view_filter
Free · Read-only
Retrieve a single view filter by numeric ID (GET /ViewFilter/{id}).

Integration Data Actions

ToolWhat it does
halo_export_integration_lansweeper
Pro · Destructive
Start an outbound export to Lansweeper via HaloPSA's connected integration (passthrough to POST /IntegrationData/Export/Lansweeper).
halo_format_integration_json_array
Free · Read-only
Format / normalize a JSON array using HaloPSA's IntegrationData helper (passthrough to POST /IntegrationData/FormatJsonArray).
halo_get_integration_amazon_seller
Free · Read-only
Retrieve Amazon Seller data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/AmazonSeller).
halo_get_integration_arrowsphere
Free · Read-only
Retrieve ArrowSphere data from HaloPSA's connected distributor integration (passthrough to GET /IntegrationData/Get/ArrowSphere).
halo_get_integration_azure_ad_delta
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_get_integration_beyondtrust_code
Free · Read-only
Retrieve BeyondTrust authorization/session code data from HaloPSA's connected BeyondTrust integration (passthrough to GET /IntegrationData/Get/BeyondTrust/Code).
halo_get_integration_bigpanda_device_list
Free · Read-only
Retrieve the BigPanda device list from HaloPSA's connected BigPanda integration (passthrough to GET /IntegrationData/BigPanda/GetDeviceList).
halo_get_integration_cloud_marketplace
Free · Read-only
Retrieve Cloud Marketplace data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/CloudMarketplace).
halo_get_integration_confluence
Free · Read-only
Retrieve Confluence data (spaces, pages) from HaloPSA's connected Confluence integration (passthrough to GET /IntegrationData/Get/Confluence).
halo_get_integration_datagate
Free · Read-only
Retrieve Datagate telecom billing data from HaloPSA's connected Datagate integration (passthrough to GET /IntegrationData/Get/Datagate).
halo_get_integration_deleted_mail
Free · Read-only
Retrieve deleted-mail data from HaloPSA's connected mailbox integration (passthrough to GET /IntegrationData/Get/DeletedMail).
halo_get_integration_dicker_data
Free · Read-only
Retrieve Dicker Data distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/DickerData).
halo_get_integration_dynatrace
Free · Read-only
Retrieve Dynatrace monitoring data from HaloPSA's connected Dynatrace integration (passthrough to GET /IntegrationData/Get/Dynatrace).
halo_get_integration_etilize
Free · Read-only
Retrieve Etilize product-catalog data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Etilize).
halo_get_integration_exchange_calendars
Free · Read-only
Retrieve Microsoft Exchange calendar data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/ExchangeCalendars).
halo_get_integration_exchange_calendars_ews
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_get_integration_facebook
Free · Read-only
Retrieve Facebook data (pages, messages) from HaloPSA's connected Facebook integration (passthrough to GET /IntegrationData/Get/Facebook).
halo_get_integration_giacom
Free · Read-only
Retrieve Giacom cloud-marketplace data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Giacom).
halo_get_integration_google_business
Free · Read-only
Retrieve Google Business Profile data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/GoogleBusiness).
halo_get_integration_halo_link
Free · Read-only
Retrieve HaloLink (Halo-to-Halo linked instance) data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/HaloLink).
halo_get_integration_holiday_api
Free · Read-only
Retrieve public-holiday data from HaloPSA's connected Holiday API integration (passthrough to GET /IntegrationData/Get/HolidayAPI).
halo_get_integration_icinga
Free · Read-only
Retrieve Icinga monitoring data (hosts, services, alerts) from HaloPSA's connected Icinga integration (passthrough to GET /IntegrationData/Get/Icinga).
halo_get_integration_ingram_micro
Free · Read-only
Retrieve Ingram Micro distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/IngramMicro).
halo_get_integration_interact
Free · Read-only
Retrieve Interact intranet data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Interact).
halo_get_integration_inty
Free · Read-only
Retrieve intY (CASCADE cloud-marketplace) data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/intY).
halo_get_integration_logmein
Free · Read-only
Retrieve LogMeIn remote-access data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/LogMeIn).
halo_get_integration_mail
Free · Read-only
Retrieve mail data from HaloPSA's connected mailbox integration (passthrough to GET /IntegrationData/Get/Mail).
halo_get_integration_mattermost
Free · Read-only
Retrieve Mattermost data (teams, channels) from HaloPSA's connected Mattermost integration (passthrough to GET /IntegrationData/Get/Mattermost).
halo_get_integration_microsoft_skus
Free · Read-only
Retrieve the Microsoft SKU / subscribed-license catalog from HaloPSA's connected Microsoft integration (passthrough to GET /IntegrationData/Get/MicrosoftSkus).
halo_get_integration_new_relic
Free · Read-only
Retrieve New Relic observability data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/NewRelic).
halo_get_integration_prometheus
Free · Read-only
Retrieve Prometheus monitoring data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Prometheus).
halo_get_integration_quoter
Free · Read-only
Retrieve Quoter quoting data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Quoter).
halo_get_integration_rhipe
Free · Read-only
Retrieve Rhipe (Pax8 EMEA) subscription data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Rhipe).
halo_get_integration_sales_mailbox
Free · Read-only
Retrieve sales-mailbox data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/SalesMailbox).
halo_get_integration_sales_mailbox_by_id
Free · Read-only
Retrieve a single sales mailbox by numeric ID from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/SalesMailbox/{id}).
halo_get_integration_saml_sp_metadata
Free · Read-only
Retrieve this HaloPSA instance's SAML Service Provider (SP) metadata (passthrough to GET /IntegrationData/SAML/SP/Metadata).
halo_get_integration_sherweb
Free · Read-only
Retrieve Sherweb distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Sherweb).
halo_get_integration_shopify_verify
Free · Read-only
Verify / retrieve Shopify connection data from HaloPSA's connected Shopify integration (passthrough to GET /IntegrationData/Get/ShopifyVerify).
halo_get_integration_snipeit
Free · Read-only
Retrieve Snipe-IT asset-management data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/SnipeIT).
halo_get_integration_streamone_ion
Free · Read-only
Retrieve TD SYNNEX StreamOne Ion data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/StreamOneIon).
halo_get_integration_synnex
Free · Read-only
Retrieve TD SYNNEX distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Synnex).
halo_get_integration_techdata
Free · Read-only
Retrieve Tech Data distributor data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/TechData).
halo_get_integration_twitter
Free · Read-only
Retrieve Twitter / X data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Twitter).
halo_get_integration_vm_workspace
Free · Read-only
Retrieve VMware Workspace ONE data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/VMWorkspace).
halo_get_integration_wordpress_com
Free · Read-only
Retrieve WordPress.com data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/WordpressCom).
halo_get_integration_wordpress_org
Free · Read-only
Retrieve self-hosted WordPress.org data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/WordpressOrg).
halo_get_integration_xensam
Free · Read-only
Retrieve Xensam software-asset-management data from HaloPSA's connected integration (passthrough to GET /IntegrationData/Get/Xensam).
halo_import_integration_beyondtrust
Pro · Destructive
Import data from BeyondTrust into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/BeyondTrust).
halo_import_integration_devops
Pro · Destructive
Import work items from Azure DevOps into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/DevOps).
halo_import_integration_exchange_calendars_ews
Pro · Destructive
Import Exchange calendar data via EWS into HaloPSA (passthrough to POST /IntegrationData/Import/ExchangeCalendars/EWS).
halo_import_integration_ingram_micro_subscriptions
Pro · Destructive
Import subscriptions from Ingram Micro into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/IngramMicro/Subscriptions).
halo_import_integration_jira
Pro · Destructive
Import issues from Jira into HaloPSA via the connected integration (passthrough to POST /IntegrationData/Import/Jira).
halo_link_integration_devops
Pro · Destructive
Link a HaloPSA record to an Azure DevOps work item via the connected integration (passthrough to POST /IntegrationData/Link/DevOps).
halo_link_integration_jira
Pro · Destructive
Link a HaloPSA record to a Jira issue via the connected integration (passthrough to POST /IntegrationData/Link/Jira).
halo_move_integration_mail
Pro · Destructive
Move a mail item in the connected mailbox via HaloPSA's integration (passthrough to POST /IntegrationData/Move/Mail).
halo_post_integration_confluence_create_webhook
Pro · Destructive
Create a webhook in Confluence via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Confluence/create-webhook).
halo_post_integration_google_calendars
Pro · Destructive
Post / write Google Calendar data via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/GoogleCalendars).
halo_post_integration_liongard_customer
Pro · Destructive
Post / write a customer to Liongard via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Liongard/Customer).
halo_post_integration_liongard_metrics
Pro · Destructive
Post / write metrics to Liongard via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Liongard/Metrics).
halo_post_integration_mattermost_create_webhook
Pro · Destructive
Create a webhook in Mattermost via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Mattermost/create-webhook).
halo_post_integration_mattermost_delete_webhook
Pro · Destructive
Delete a webhook in Mattermost via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Mattermost/delete-webhook).
halo_post_integration_mattermost_send_webhook
Pro · Destructive
Send a message through a Mattermost webhook via HaloPSA's connected integration (passthrough to POST /IntegrationData/Post/Mattermost/send-webhook).
halo_post_integration_microsoft_teams_manifest
Pro · Write
Generate the Microsoft Teams app manifest for the HaloPSA Teams integration (passthrough to POST /IntegrationData/MicrosoftTeams/Manifest; request schema TeamsManifestCreate).
halo_post_integration_openai
Pro · Destructive
Send a request to OpenAI via HaloPSA's connected OpenAI integration (passthrough to POST /IntegrationData/Post/OpenAi).
halo_post_integration_saml_idp_metadata
Pro · Destructive
Submit SAML Identity Provider (IdP) metadata to configure single sign-on in HaloPSA (passthrough to POST /IntegrationData/SAML/IdP/Metadata).
halo_search_integration_devops
Free · Read-only
Search Azure DevOps work items via HaloPSA's connected Azure DevOps integration (passthrough to GET /IntegrationData/Search/DevOps).
halo_search_integration_jira
Free · Read-only
Search Jira issues via HaloPSA's connected Jira integration (passthrough to GET /IntegrationData/Search/Jira).
halo_unlink_integration_devops
Pro · Destructive
Remove the link between a HaloPSA record and an Azure DevOps work item (passthrough to POST /IntegrationData/Unlink/DevOps).
halo_unlink_integration_halo_link
Pro · Destructive
Remove a HaloLink (Halo-to-Halo linked instance) linkage (passthrough to POST /IntegrationData/Unlink/HaloLink).
halo_unlink_integration_jira
Pro · Destructive
Remove the link between a HaloPSA record and a Jira issue (passthrough to POST /IntegrationData/Unlink/Jira).
halo_validate_integration_jira
Free · Read-only
Validate the HaloPSA Jira integration connection (passthrough to GET /IntegrationData/Validate/Jira).

KB, Projects & Collaboration

ToolWhat it does
halo_approve_client_contract
Pro · Write
Approve (or record an approval decision on) a client contract.
halo_book_appointment
Pro · Write
Book an appointment against an available slot.
halo_bookmark_report
Pro · Write
Bookmark (favourite) a saved report so it surfaces in the reporting shortcuts.
halo_create_chat
Pro · Write
Create or update a live chat session header (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_chat_flow
Pro · Write
Create or update a chatbot conversation flow (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_chat_matching_data
Pro · Write
Create or update chatbot matching data (intent/keyword matching used to route conversations).
halo_create_chat_profile
Pro · Write
Create or update a chat profile (a chatbot channel/behaviour configuration).
halo_create_faq
Pro · Write
Create or update a FAQ list (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_mcp_server
Pro · Write
Create or update the HaloPSA instance's MCP (Model Context Protocol) server configuration (POST api/mcp — upsert).
halo_create_project_setup_lines
Pro · Write
Create or update project setup lines (the task/phase template lines that seed a project).
halo_create_report
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_create_supplier_contract
Pro · Write
Create or update a supplier contract (HaloPSA POST is an upsert — include an 'id' field to update).
halo_create_virtual_agent
Pro · Write
Create or update an AI virtual agent (HaloPSA POST is an upsert — include an 'id' field to update).
halo_delete_appointment
Pro · Destructive
Delete a calendar appointment by numeric ID.
halo_delete_chat_profile
Pro · Destructive
Delete a chat profile by numeric ID.
halo_delete_client_contract
Pro · Destructive
Delete a client contract (ClientContract / contract header) by numeric ID.
halo_delete_external_link
Pro · Destructive
Delete an external link by numeric ID.
halo_delete_faq
Pro · Destructive
Delete a FAQ list by numeric ID.
halo_delete_kb_article
Pro · Destructive
Delete a knowledge base article by numeric ID.
halo_delete_mcp_server
Pro · Destructive
Delete the HaloPSA instance's MCP (Model Context Protocol) server configuration (DELETE api/mcp).
halo_delete_project
Pro · Destructive
Delete a project by numeric ID.
halo_delete_release
Pro · Destructive
Delete a release by numeric ID.
halo_delete_release_component
Pro · Destructive
Delete a release (product) component by numeric ID.
halo_delete_remote_session
Pro · Destructive
Delete a remote support session record by numeric ID.
halo_delete_report
Pro · Destructive
Delete a saved report / analyzer profile by numeric ID.
halo_delete_secure_link
Pro · Destructive
Delete a secure secret link by numeric ID.
halo_delete_supplier_contract
Pro · Destructive
Delete a supplier contract by numeric ID.
halo_delete_virtual_agent
Pro · Destructive
Delete an AI virtual agent by its UUID/GUID.
halo_generate_appointments
Pro · Write
Generate recurring / scheduled appointments from their definitions.
halo_get_downtime_calendar
Free · Read-only
Retrieve the downtime calendar — scheduled/recorded downtime events rendered for a calendar view (GET api/Downtime/DowntimeCalendar).
halo_get_external_link
Free · Read-only
Retrieve a single external link by numeric ID (GET api/ExternalLink/{id}).
halo_get_kb_article_anon
Free · Read-only
Retrieve a single anonymously-accessible (self-service portal) knowledge base article by its slug (GET api/KBArticleAnon/{slug}).
halo_get_mcp_server
Free · Read-only
Retrieve the HaloPSA instance's MCP (Model Context Protocol) server configuration (GET api/mcp).
halo_get_release_component
Free · Read-only
Retrieve a single release (product) component by numeric ID (GET api/ProductComponent/{id}).
halo_get_secure_link
Free · Read-only
Retrieve a single secure secret link by numeric ID (GET api/SecureSecretLink/{id}).
halo_get_virtual_agent
Free · Read-only
Retrieve a single AI virtual agent by its UUID/GUID (GET api/VirtualAgent/{id}).
halo_list_kb_articles_anon
Free · Read-only
List anonymously-accessible (self-service portal) knowledge base articles with pagination (GET api/KBArticleAnon).
halo_list_release_branches
Free · Read-only
List release (product) branches with pagination (GET api/ProductBranch).
halo_list_virtual_agents
Free · Read-only
List AI virtual agents configured in HaloPSA with pagination (GET api/VirtualAgent).
halo_next_ref_client_contract
Pro · Write
Get the next auto-generated reference for a client contract.
halo_next_ref_supplier_contract
Pro · Write
Get the next auto-generated reference for a supplier contract.
halo_print_report
Pro · Write
Produce a printable rendering of a saved report.
halo_query_projects_view
Pro · Write
Query projects against a server-side view/filter definition.
halo_run_automation_runbook
Pro · Destructive
Execute an automation runbook by its numeric runbook ID.
halo_send_chat_typing_indicator
Pro · Destructive
Send an 'is typing' presence signal into a live chat conversation.
halo_vote_kb_article
Pro · Write
Record a helpful/not-helpful vote on a knowledge base article.

Scripts & Automation

ToolWhat it does
halo_create_call_script
Pro · Write
Create or update a call script (an agent-facing scripted question/answer flow used when logging a ticket).
halo_create_powershell_script_criteria
Pro · Write
Create or update PowerShell script criteria (targeting rules for a script).
halo_create_powershell_script_processing
Pro · Destructive
Create a PowerShell script processing record — this queues/dispatches a PowerShell script for execution against its targets.
halo_delete_call_script
Pro · Destructive
Delete a call script by numeric ID.
halo_delete_powershell_script
Pro · Destructive
Delete a PowerShell script by numeric ID.
halo_delete_powershell_script_criteria
Pro · Destructive
Delete a PowerShell script criteria record by numeric ID.
halo_delete_powershell_script_processing
Pro · Destructive
Delete a PowerShell script processing record by numeric ID.
halo_get_powershell_script_criteria
Free · Read-only
Retrieve a single PowerShell script criteria record by numeric ID.
halo_get_powershell_script_processing
Free · Read-only
Retrieve a single PowerShell script processing record by numeric ID.
halo_list_powershell_script_criteria
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

ToolWhat it does
halo_complete_attachment_presigned_upload
Pro · Write
Register a completed direct-to-S3 attachment upload (api/Attachment/PresignedURLUploadComplete).
halo_create_ai_suggestion
Pro · Write
Create or update an AI suggestion rule.
halo_create_ticket_object
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_create_timesheet_event
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_create_todo_group
Pro · Write
Create or update a to-do group (checklist template).
halo_create_transcription
Pro · Write
Create or update a stored transcription record.
halo_delete_ai_suggestion
Pro · Destructive
Delete an AI suggestion rule by numeric ID.
halo_delete_cab_meeting
Pro · Destructive
Delete a CAB (Change Advisory Board) meeting by numeric ID.
halo_delete_service_status
Pro · Destructive
Delete a service status record by numeric ID.
halo_delete_ticket
Pro · Destructive
Delete a ticket by numeric ID.
halo_delete_timesheet_event
Pro · Destructive
Delete a timesheet event by numeric ID.
halo_delete_todo_group
Pro · Destructive
Delete a to-do group (checklist template) by numeric ID.
halo_delete_transcription
Pro · Destructive
Delete a stored transcription by numeric ID.
halo_get_ai_suggestion
Free · Read-only
Retrieve a single AI suggestion rule by numeric ID.
halo_get_attachment_image
Free · Read-only
Retrieve an inline attachment image using a HaloPSA-issued access token (api/Attachment/image).
halo_get_attachment_nhserver
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_get_attachment_presigned_url
Pro · Write
Request an S3 presigned upload URL for a large attachment (api/Attachment/GetS3PresignedURL).
halo_get_call_log
Free · Read-only
Retrieve a single telephony call log entry by numeric ID.
halo_get_change_calendar
Free · Read-only
Retrieve the change management calendar — the scheduled change windows and change requests plotted against dates.
halo_get_service_status
Free · Read-only
Retrieve a single service status record by numeric ID.
halo_get_service_status_subscription
Free · Read-only
Retrieve the status-notification subscription for a service by its numeric service ID.
halo_get_tickets_sales_mailbox
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_get_tickets_zapier
Free · Read-only
Retrieve the Zapier ticket feed — the trimmed ticket payload HaloPSA exposes for Zapier polling triggers.
halo_get_timesheet_event
Free · Read-only
Retrieve a single timesheet event by numeric ID.
halo_get_timesheet_forecasting
Free · Read-only
Retrieve the timesheet forecasting view — HaloPSA's projection of upcoming agent capacity and committed work, used for resource planning.
halo_get_timesheet_grid
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_get_todo_group
Free · Read-only
Retrieve a single to-do group (checklist template) by numeric ID.
halo_get_transcription
Free · Read-only
Retrieve a single transcription by numeric ID.
halo_list_ai_suggestions
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_list_todo_groups
Free · Read-only
List to-do groups — the reusable checklist templates that seed per-ticket to-do items.
halo_list_transcriptions
Free · Read-only
List stored transcriptions — the speech-to-text results HaloPSA produces for recorded calls and audio attachments.
halo_process_ticket_children
Pro · Write
Cascade a parent ticket's update down to its child tickets (api/Tickets/processchildren).
halo_query_tickets_view
Pro · Write
Query tickets against a server-side view/filter definition.
halo_set_ticket_billable_project
Pro · Write
Mark a ticket's linked project as billable (api/Tickets/SetBillableProject).
halo_subscribe_service_status
Pro · Write
Subscribe to (or unsubscribe from) status notifications for a service.
halo_upload_attachment_document
Pro · Write
Upload a document attachment via the document-specific endpoint (api/Attachment/document).

Billing Extras

ToolWhat it does
halo_add_recurring_invoice_lines
Pro · Write
Add lines to a recurring invoice template (POSTs api/RecurringInvoice/Lines).
halo_create_consignment
Pro · Write
Create or update a stock consignment (HaloPSA POST is an upsert — include an 'id' field to update an existing consignment).
halo_create_csp_consumption_data
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_create_invoice_change
Pro · Write
Create or update an invoice change record (HaloPSA POST is an upsert — include an 'id' field to update an existing record).
halo_delete_consignment
Pro · Destructive
Delete a stock consignment by numeric ID.
halo_delete_csp_consumption_data
Pro · Destructive
Delete a single Microsoft CSP consumption record by numeric ID.
halo_delete_csp_consumption_parent
Pro · Destructive
Delete a Microsoft CSP consumption PARENT record and the consumption rows grouped beneath it (DELETEs api/CSPConsumptionData/Parent/{id}).
halo_delete_invoice
Pro · Destructive
Delete an invoice by numeric ID.
halo_delete_invoice_payment
Pro · Destructive
Delete an invoice payment by numeric ID.
halo_delete_prepay_entry
Pro · Destructive
Delete a client pre-pay history entry by numeric ID.
halo_delete_purchase_order
Pro · Destructive
Delete a supplier purchase order by numeric ID.
halo_delete_quotation
Pro · Destructive
Delete a quotation by numeric ID.
halo_delete_recurring_invoice
Pro · Destructive
Delete a recurring invoice template by ID.
halo_delete_sales_order
Pro · Destructive
Delete a sales order by numeric ID.
halo_get_consignment
Free · Read-only
Retrieve a single stock consignment by numeric ID.
halo_get_csp_consumption_data
Free · Read-only
Retrieve a single Microsoft CSP consumption record by numeric ID.
halo_get_invoice_payment
Free · Read-only
Retrieve a single invoice payment by numeric ID.
halo_get_prepay_entry
Free · Read-only
Retrieve a single client pre-pay history entry by numeric ID.
halo_list_consignments
Free · Read-only
List stock consignment headers — the dispatch/return documents that move stock out against a sales order.
halo_list_csp_consumption_data
Free · Read-only
List Microsoft CSP consumption (metered usage) records imported for billing.
halo_list_invoice_changes
Free · Read-only
List invoice change records — the audit trail of amendments made to invoices and invoice lines.
halo_list_invoice_detail_lines
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_list_invoice_prorata_details
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_list_sales_order_lines
Free · Read-only
List sales order line records from api/OrderLine — a flat feed of order lines across sales orders.
halo_manage_csp_consumption_data
Pro · Write
Run a bulk manage operation over Microsoft CSP consumption data (POSTs api/CSPConsumptionData/manage).
halo_manage_csp_subscription_pricing
Pro · Write
Apply a bulk pricing change to Microsoft CSP subscriptions (POSTs api/CSPSubscriptionPricing/manage).

Assets & Stock Extras

ToolWhat it does
halo_assign_item_accounts_id
Pro · Write
Allocate a new accounting-system ID for a catalogue item (POSTs api/Item/NewAccountsId).
halo_create_asset_change
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_create_database_lookup
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_create_database_lookup_confirmation
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_create_item_stock
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_delete_asset
Pro · Destructive
Delete an asset (device / configuration item) by numeric ID.
halo_delete_database_lookup
Pro · Destructive
Delete a database (parts) lookup definition by numeric ID.
halo_delete_item
Pro · Destructive
Delete a catalogue item (product/part) by numeric ID.
halo_delete_item_account_link
Pro · Destructive
Delete an item-to-accounting-code link by numeric ID.
halo_delete_item_stock
Pro · Destructive
Delete an item stock record by numeric ID.
halo_delete_software_licence
Pro · Destructive
Delete a software licence record by numeric ID.
halo_get_database_lookup
Free · Read-only
Retrieve a single database (parts) lookup definition by numeric ID.
halo_get_database_lookup_confirmation
Free · Read-only
Retrieve a single database (parts) lookup confirmation by numeric ID.
halo_get_item_account_link
Free · Read-only
Retrieve a single item-to-accounting-code link by numeric ID.
halo_get_item_stock
Free · Read-only
Retrieve a single item stock record by numeric ID.
halo_get_item_stock_history_entry
Free · Read-only
Retrieve a single item stock history entry by numeric ID.
halo_get_item_supplier_link
Free · Read-only
Retrieve a single item-to-supplier link by numeric ID.
halo_get_stock_trace
Free · Read-only
Retrieve a single stock trace record by numeric ID.
halo_list_database_lookups
Free · Read-only
List configured database (parts) lookups — the SQL-backed lookups that resolve external part, price or reference data into HaloPSA fields.
halo_list_licence_changes
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_migrate_item_account_links
Pro · Destructive
Bulk-migrate item accounting-code links from one accounting configuration to another (POSTs api/ItemAccountsLink/Migrate).
halo_run_database_lookup
Pro · Write
Execute a configured database (parts) lookup and return the matched values (POSTs api/DatabaseLookup/run).

CRM Extras

ToolWhat it does
halo_create_contact_group
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_create_ecommerce_order
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_create_feedback
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_delete_contact_group
Pro · Destructive
Delete a contact group by numeric ID.
halo_delete_contact_group_contact
Pro · Destructive
Remove a contact from a contact group by deleting the membership record ID.
halo_delete_ecommerce_order
Pro · Destructive
Delete an e-commerce order by numeric ID.
halo_delete_feedback
Pro · Destructive
Delete a customer satisfaction (CSAT) feedback record by numeric ID.
halo_delete_opportunity
Pro · Destructive
Delete a sales opportunity by numeric ID.
halo_delete_site
Pro · Destructive
Delete a client site by numeric ID.
halo_delete_user
Pro · Destructive
Delete an end user / contact by numeric ID.
halo_get_contact_group
Free · Read-only
Retrieve a single contact group by numeric ID.
halo_get_contact_group_contact
Free · Read-only
Retrieve a single contact-group membership record by numeric ID.
halo_get_current_user
Free · Read-only
Retrieve the user record for the identity the current API credentials authenticate as (api/Users/me).
halo_get_ecommerce_order
Free · Read-only
Retrieve a single e-commerce order by numeric ID.
halo_get_feedback
Free · Read-only
Retrieve a single customer satisfaction (CSAT) feedback record by numeric ID.
halo_get_feedback_message
Free · Read-only
Retrieve the configured feedback (CSAT survey) message shown to customers when they are asked to rate a ticket.
halo_list_contact_group_contacts
Free · Read-only
List contact-group membership records — the rows linking contacts (users) to contact groups.
halo_list_ecommerce_orders
Free · Read-only
List e-commerce orders imported from a connected shop (Shopify, Adobe Commerce, Amazon and similar).
halo_list_site_stock_bins
Free · Read-only
List the sites that act as stock bins / stock locations (api/Site/StockBins).
halo_register_opportunity_view
Pro · Write
Register that an opportunity has been viewed (POSTs api/Opportunities/View).