Skip to main content
HaloPSA logo
  • Category: customer support
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 85
  • Triggers: 0
  • Slug: HALOPSA
  • Version: 00000000_00

Tools

Slug: HALOPSA_CREATE_TICKETCreate one HaloPSA ticket from a summary and optional details and routing IDs; sends the provider-required one-item array body.

Input Parameters

string
Detailed plain-text description of the issue or request.
integer
Site ID from List Sites.
string
required
Short ticket subject or summary.
integer
Team ID from List Teams.
integer
End-user ID from List Users.
integer
Assigned agent ID from List Agents.
integer
Customer ID from List Customers.
integer
Numeric priorityid from List Priorities, not that record’s UUID id.
integer
Ticket type ID from List Ticket Types; omit to use the tenant default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_AGENTRequest deletion of one HaloPSA agent by numeric ID. Use only for an agent that is confirmed safe to remove; this action does not create or verify a disposable replacement.

Input Parameters

integer
required
Numeric ID of the HaloPSA agent to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_APPOINTMENTDelete one HaloPSA appointment by numeric ID. HaloPSA also deletes its linked Exchange event unless ignore_exchange_delete is true.

Input Parameters

integer
required
Numeric ID of the appointment to delete.
boolean
Delete in HaloPSA without also deleting the linked Exchange event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_ASSETDelete one HaloPSA asset by numeric ID.

Input Parameters

integer
required
Numeric ID of the asset to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_ATTACHMENTDelete one HaloPSA attachment by numeric ID.

Input Parameters

integer
required
Numeric ID of the attachment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_CLIENT_CONTRACTDelete one HaloPSA client contract by numeric ID.

Input Parameters

integer
required
Numeric ID of the client contract to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_CUSTOMERDelete one HaloPSA customer by numeric ID. Success is reported only after HaloPSA returns the endpoint’s documented HTTP 200 status.

Input Parameters

integer
required
Numeric ID of the customer to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_INVOICEDelete one HaloPSA invoice by numeric ID. Set bypass_accounts_sync to true to delete it in HaloPSA without synchronizing the deletion to the connected accounts system.

Input Parameters

integer
required
Numeric ID of the invoice to delete.
boolean
Delete without synchronizing the deletion to the connected accounts system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_ITEMDelete one HaloPSA inventory or service item by numeric ID. Use only for an item that is confirmed safe to remove.

Input Parameters

integer
required
Numeric ID of the HaloPSA item to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_KNOWLEDGE_BASE_ARTICLEDelete one HaloPSA knowledge-base article by numeric ID. Use only for an article that is confirmed safe to remove.

Input Parameters

integer
required
Numeric ID of the HaloPSA knowledge-base article to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_OPPORTUNITYDelete one HaloPSA sales opportunity by numeric ID.

Input Parameters

string
Reason for deleting the opportunity.
integer
required
Numeric ID of the HaloPSA opportunity to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_PROJECTDelete one HaloPSA project by numeric ID.

Input Parameters

string
Reason for deleting the project.
integer
required
Numeric ID of the project to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_QUOTATIONDelete one HaloPSA quotation by numeric ID.

Input Parameters

integer
required
Numeric ID of the HaloPSA quotation to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_REPORTDelete one HaloPSA report definition by numeric ID.

Input Parameters

integer
required
Numeric ID of the report definition to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_SITEDelete one HaloPSA customer site by numeric ID.

Input Parameters

integer
required
Numeric ID of the site to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_STATUSDelete one HaloPSA ticket-status configuration record by numeric ID. Use only for a status that is confirmed safe to remove.

Input Parameters

integer
required
Numeric ID of the HaloPSA ticket status to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_SUPPLIERDelete one HaloPSA supplier by numeric ID. Use only for a supplier that is confirmed safe to remove.

Input Parameters

integer
required
Numeric ID of the HaloPSA supplier to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_TEAMDelete one HaloPSA team by numeric ID. This changes tenant-level team configuration.

Input Parameters

integer
required
Numeric ID of the HaloPSA team to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_TICKETDelete one HaloPSA ticket by numeric ID, optionally recording a reason. The ticket is removed from active ticket results.

Input Parameters

string
Optional reason to record for deleting the ticket.
integer
required
Numeric ID of the ticket to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_TICKET_ACTIONDelete one HaloPSA ticket action by numeric action ID and its parent ticket ID. HaloPSA may reject deletion for protected action types; the provider’s reason is returned.

Input Parameters

integer
required
Numeric ID of the ticket action to delete.
integer
required
Numeric ID of the ticket that contains the action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_TICKET_TYPEDelete one HaloPSA ticket-type configuration record by numeric ID. This does not create or verify a disposable replacement.

Input Parameters

integer
required
Numeric ID of the HaloPSA ticket type to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_DELETE_USERDelete one HaloPSA end user by numeric ID.

Input Parameters

integer
required
Numeric ID of the HaloPSA end user to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_AGENTReturn one HaloPSA agent by numeric ID. Optional flags can request expanded configuration, signature, holiday-allowance, cache, or client-context data; the response preserves additional provider fields.

Input Parameters

integer
required
Numeric ID of the HaloPSA agent to return.
boolean
Use HaloPSA’s cached agent data when available.
boolean
Request HaloPSA’s agent-configuration projection.
boolean
Include extra agent objects in the response.
string
HaloPSA client ID override value for the agent lookup.
boolean
Request the agent’s holiday allowance fields from HaloPSA.
boolean
Request the agent’s HTML designer signature from HaloPSA.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_APPOINTMENTReturn one HaloPSA appointment by numeric ID, optionally with extra detail objects.

Input Parameters

integer
required
Numeric HaloPSA appointment ID.
boolean
Include extra appointment objects in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_ASSETReturn one HaloPSA asset by numeric ID, optionally including activity, allowed statuses, details, diagram data, and hierarchy data.

Input Parameters

integer
required
Numeric HaloPSA asset ID.
integer
Asset type ID used to resolve type-specific fields.
boolean
Include additional asset detail objects.
boolean
Include activity details in the response.
boolean
Include asset hierarchy details.
boolean
Include asset diagram details.
boolean
Include the asset’s allowed statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_ATTACHMENTDownload one HaloPSA attachment by numeric ID.

Input Parameters

integer
required
Numeric HaloPSA attachment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_CLIENT_CONTRACTReturn one HaloPSA client contract by numeric ID, with optional expanded billing, asset, user, schedule, and period details.

Input Parameters

integer
required
Numeric HaloPSA client contract ID.
boolean
Include expanded contract objects and billing details.
boolean
Include contract and pre-pay period details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_CURRENT_AGENTReturn a compact identity for the HaloPSA agent authorized by the current connection, without claims or access-control records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_CUSTOMERReturn one HaloPSA customer by numeric ID, with optional expanded, activity, ticket-type, period, and pre-pay data.

Input Parameters

string
Filter customer permissions by domain; HaloPSA documents ‘opps’ for opportunities.
integer
required
Numeric HaloPSA customer ID.
boolean
Include pre-pay information.
integer
Ticket type ID used when resolving customer details.
boolean
Include expanded customer objects.
boolean
Include pre-pay periods.
boolean
Include customer ticket activity.
boolean
Include ticket types that the customer can log.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_INVOICEReturn one HaloPSA invoice by numeric ID, optionally with extra detail objects.

Input Parameters

integer
required
Numeric HaloPSA invoice ID.
boolean
Include extra invoice objects in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_ITEMReturn one HaloPSA inventory or service item by numeric ID, optionally with expanded details and tenant-specific accounting data; additional provider fields are preserved.

Input Parameters

integer
required
Numeric ID of the HaloPSA item to return.
string
Resolve accounting data for this Business Central company.
string
Resolve accounting data for this Xero tenant.
boolean
Include expanded item details.
integer
Resolve accounting data for this KashFlow tenant.
string
Resolve accounting data for this QuickBooks company.
integer
Resolve data for this Sage Business Cloud tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_KNOWLEDGE_BASE_ARTICLEReturn one HaloPSA knowledge-base article by numeric ID, optionally with expanded details and language or organisation context.

Input Parameters

integer
required
Numeric ID of the HaloPSA knowledge-base article to return.
string
Return content for this language code.
boolean
Include expanded article objects.
integer
Return the article in this organisation context.
string
Override the language used for returned content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_OPPORTUNITYReturn one HaloPSA sales opportunity by numeric ID, optionally with extra provider detail objects.

Input Parameters

boolean
Include extra opportunity objects in the response.
integer
required
Numeric HaloPSA opportunity ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_PROJECTReturn one HaloPSA project by numeric ID, optionally with expanded details.

Input Parameters

integer
required
Numeric HaloPSA project ID.
boolean
Include expanded project objects in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_QUOTATIONReturn one HaloPSA quotation by numeric ID, optionally with expanded details or portal-view context.

Input Parameters

integer
required
Numeric HaloPSA quotation ID.
boolean
Return the quotation using portal-view context.
boolean
Include expanded quotation details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_REPORTReturn one HaloPSA report definition by numeric ID. Optionally include definition details or load report data with the documented report context.

Input Parameters

integer
Customer ID used when loading the report.
integer
required
Numeric HaloPSA report ID.
integer
Invoice ID used as report context.
string
Customer name used when loading the report.
boolean
Execute and include the report data.
integer
Dashboard ID used when loading the report.
boolean
Include extra report definition objects.
integer
Reporting period ID used when loading the report.
boolean
Include a composite report token.
string
Provider-issued access token for a published report.
string
Published dashboard identifier used when loading the report.
boolean
Do not load the associated system report.
string
Reporting period end date used by the report.
string
Reporting period start date used by the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_SITEReturn one HaloPSA customer site by numeric ID, with optional customer, permission, activity, detail, setup, and ticket-type context.

Input Parameters

string
Filter site permissions by domain; HaloPSA documents ‘opps’ for opportunities.
integer
required
Numeric HaloPSA site ID.
boolean
Resolve the site in HaloPSA setup context.
integer
Ticket type ID used to resolve site details.
integer
Customer ID used to resolve the site.
boolean
Include expanded site objects in the response.
boolean
Include site ticket activity in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_STATUSReturn one HaloPSA ticket-status configuration record by numeric ID, optionally including its detailed configuration.

Input Parameters

integer
required
Numeric ID of the HaloPSA ticket status to return.
boolean
Include detailed status configuration fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_SUPPLIERReturn one HaloPSA supplier by numeric ID, optionally including expanded details; additional provider fields are preserved.

Input Parameters

integer
required
Numeric ID of the HaloPSA supplier to return.
boolean
Include expanded supplier details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_TEAMReturn one HaloPSA team by numeric ID, optionally including agent details and expanded team objects.

Input Parameters

integer
required
Numeric HaloPSA team ID.
boolean
Include agent details in the response.
boolean
Include extra team objects in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_TICKETReturn one HaloPSA ticket by numeric ID, with core assignment and classification fields and optional expanded details and most recent action.

Input Parameters

integer
required
Numeric HaloPSA ticket ID.
boolean
Include the ticket’s expanded detail objects when available.
boolean
Include the most recent ticket action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_TICKET_ACTIONGet one HaloPSA ticket action by numeric action ID, optionally providing its ticket ID and requesting expanded details.

Input Parameters

integer
required
Numeric action ID within its HaloPSA ticket.
integer
Ticket ID that contains the action; use it when action IDs are ticket-local.
boolean
Include extra action objects in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_TICKET_TYPEReturn one HaloPSA ticket type by numeric ID. Optional flags select the documented configuration, detail, knowledge-base, team-restriction, survey, new-ticket, and ticket-context representations.

Input Parameters

boolean
Include HaloPSA debug information in the response.
integer
Resolve the ticket type in the context of this ticket ID.
boolean
Request configuration for a new ticket.
boolean
Filter by ticket types that can be edited.
boolean
Request the detail-screen representation.
boolean
Include survey fields.
boolean
Include ticket-type configuration data.
integer
required
Numeric ID of the HaloPSA ticket type to return.
boolean
Filter by ticket types that can be created.
boolean
Include extra ticket-type objects.
boolean
Include knowledge-base information.
boolean
Include team restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_GET_USERReturn one HaloPSA end user by numeric ID, with optional customer, site, ticket-type, opportunity, supplier, activity, billing, asset, and detail context.

Input Parameters

string
Filter site permissions by domain; HaloPSA documents ‘opps’ for opportunities.
integer
Filter by the specified site ID.
integer
required
Numeric HaloPSA end-user ID.
boolean
Resolve the user in HaloPSA setup context.
string
Filter by the specified username.
integer
Filter by the specified customer ID.
integer
Filter by the specified supplier ID.
integer
Override the site context used to resolve the user.
boolean
Include customer pop-up records in the response.
integer
Filter by an opportunity assigned to the user.
integer
Ticket type ID used as context when resolving user details and permissions.
integer
Override the customer context used to resolve the user.
boolean
Include expanded user objects in the response.
boolean
Include the user’s ticket activity in the response.
boolean
Include assets assigned to the user.
boolean
Include billing information in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_AGENTSReturn compact HaloPSA agent records for assignment lookup, optionally filtered by name, email address, telephone number, or team ID.

Input Parameters

Filter agents by matching name, email address, or telephone number.
integer
Return agents belonging to this team ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_APPOINTMENTSReturn one page of HaloPSA appointments, optionally filtered by customer, ticket, date range, or search text.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Return appointments matching this search text.
string
Return appointments whose end date is after this value.
integer
Return appointments assigned to this customer ID.
integer
Maximum appointments in this page (1-100).
integer
Return appointments assigned to this ticket ID.
string
Return appointments whose start date is after this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_ASSETSReturn one page of HaloPSA assets, optionally filtered by customer, site, user, asset type, search text, and active state.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter assets by HaloPSA’s asset search.
integer
Return assets belonging to this site ID.
integer
Return assets assigned to this end-user ID.
integer
Maximum assets in this page (1-100).
integer
Return assets belonging to this customer ID.
integer
Return assets of this asset type ID.
boolean
Include inactive assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_ATTACHMENTSList HaloPSA attachment metadata, optionally for one ticket.

Input Parameters

integer
Return attachments belonging to this numeric ticket ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_CLIENT_CONTRACTSReturn one page of HaloPSA client contracts, optionally filtered by customer, site, search text, and active state.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter client contracts by matching search text.
integer
Return contracts associated with this site ID.
integer
Maximum contracts in this page (1-100).
integer
Return contracts belonging to this customer ID.
boolean
Include inactive client contracts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_CUSTOMERSReturn one page of HaloPSA customers, optionally filtered by name and active state.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter customers by a matching name or search text.
integer
Maximum customers in this page (1-100).
boolean
Include inactive customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_INVOICESReturn one page of HaloPSA invoices, optionally filtered by date, customer, site, ticket, user, or search text.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter invoices by HaloPSA’s invoice search.
integer
Return invoices for this site ID.
integer
Return invoices for this user ID.
string
Return invoices before this date, using HaloPSA’s date filter.
integer
Return invoices for this customer ID.
integer
Maximum invoices in this page (1-100).
integer
Return invoices assigned to this ticket ID.
string
Return invoices after this date, using HaloPSA’s date filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_ITEMSReturn one page of HaloPSA inventory and service items with the provider’s documented status, asset, supplier, accounting, stock, search, and ordering filters.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
General item search text; use this search field by default.
integer
Maximum items in this page (1-100).
string
Comma-separated asset type IDs.
integer
Filter by supplier ID.
string
Comma-separated asset group IDs.
integer
Filter by asset group ID.
string
Filter by Dynamics Business Central company ID.
integer
Filter by exact division ID.
boolean
Include active items.
boolean
Return only recurring items.
string
Filter by Xero tenant ID.
string ("true,false" | "true,true" | "false,true" | "false,false")
Two comma-separated booleans: include active items first, then include inactive items. For example, ‘true,false’ returns active items only.
HaloPSA advanced item search expression.
integer
Filter by item service ID.
integer
Provider result-count limit applied before pagination. This is distinct from page_size, which controls how many matching items are returned per page.
boolean
Include inactive items.
Second provider search input. HaloPSA publishes no semantic distinction from search, so use it only when a tenant workflow requires both clauses.
boolean
Exclude recurring items.
string
Fifth provider field to sort by; paired with fifth_order_descending.
boolean
Include items that are not in stock.
integer
Filter by stock location ID.
string
Third provider field to sort by; paired with third_order_descending.
string
Fourth provider field to sort by; paired with fourth_order_descending.
integer
Filter by KashFlow tenant ID.
string
First provider field to sort by; paired with primary_order_descending.
string
Comma-separated custom field IDs to include.
string
Filter by QuickBooks Online company ID.
boolean
Return only QuickBooks items.
string
Second provider field to sort by; paired with secondary_order_descending.
boolean
Return only Autotask service items.
boolean
Sort fifth_order_field descending when true, ascending when false.
integer
Return prices in this supplier currency ID.
boolean
Sort third_order_field descending when true, ascending when false.
boolean
Sort fourth_order_field descending when true, ascending when false.
integer
Filter by supplier customer ID.
boolean
Sort primary_order_field descending when true, ascending when false.
boolean
Sort secondary_order_field descending when true, ascending when false.
integer
Filter by Sage Business Cloud tenant ID.
integer
Filter by item service request details ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_KNOWLEDGE_BASE_ARTICLESReturn one page of HaloPSA knowledge-base articles using the provider’s documented status, access, relationship, language, search, and ordering filters.

Input Parameters

string
Filter by knowledge-base key.
integer
Provider-defined maximum number of articles to return.
string
First provider field to sort by; paired with order_descending.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter articles by matching search text.
string
Second provider field to sort by; paired with order_descending_2.
string
Third provider field to sort by; paired with order_descending_3.
string
Fourth provider field to sort by; paired with order_descending_4.
string
Fifth provider field to sort by; paired with order_descending_5.
integer
Filter articles by site ID.
integer
Filter articles by customer ID.
integer
Filter articles by device ID.
string
Comma-separated numeric FAQ-list IDs to include.
integer
Maximum articles in this page (1-100).
Filter by a related knowledge-base article ID.
string
Comma-separated provider article-type selectors. HaloPSA documents the format but does not publish a fixed value vocabulary.
string
Provider selector for articles past their next review date. HaloPSA documents this as a string but does not publish accepted values.
string
Return content for this language code.
boolean
Include active articles.
string ("true,false" | "true,true" | "false,true" | "false,false")
Two comma-separated booleans: include active articles first, then include inactive articles. For example, ‘true,false’ returns active articles only.
string
Provider-defined advanced knowledge-base search.
integer
Filter by numeric knowledge-base article type.
integer
Filter articles by organisation ID.
boolean
Include inactive articles.
boolean
Sort order descending when true, ascending when false.
string
Override the language used for returned content.
Filter by a related ticket ID.
boolean
Sort order_2 descending when true, ascending when false.
boolean
Sort order_3 descending when true, ascending when false.
boolean
Sort order_4 descending when true, ascending when false.
boolean
Sort order_5 descending when true, ascending when false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_OPPORTUNITIESReturn one page of HaloPSA sales opportunities, optionally filtered by customer, assignment, status, date range, or search text.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter opportunities using HaloPSA’s general search.
string
End of the HaloPSA date-search range.
integer
Return opportunities for this site ID.
integer
Return opportunities for this end-user ID.
integer
Return opportunities assigned to this agent ID.
integer
Return opportunities for this customer ID.
integer
Maximum opportunities in this page (1-100).
string
Start of the HaloPSA date-search range.
integer
Return opportunities in this status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_PRIORITIESReturn HaloPSA policy-priority mappings used to classify tickets, optionally filtered by SLA policy ID.

Input Parameters

integer
Return priorities for this SLA policy ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_PROJECTSReturn one page of HaloPSA projects. HaloPSA represents projects as ticket-like records in a tickets array.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter projects using HaloPSA’s general ticket search.
string
End of the date range used by HaloPSA’s date search.
integer
Return projects for this site ID.
integer
Return projects for this end-user ID.
integer
Return projects assigned to this agent ID.
integer
Return projects for this customer ID.
integer
Maximum projects in this page (1-100).
string
Start of the date range used by HaloPSA’s date search.
integer
Return projects in this status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_QUOTATIONSReturn HaloPSA quotations with customer, state, approval, processing, text, attachment, ordering, and page filters.

Input Parameters

boolean
Filter by open state.
boolean
Filter by closed state.
string
Search quotation text.
integer
Filter by numeric site ID.
integer
Filter by numeric user ID.
integer
Number of quotations requested in the provider page.
boolean
Filter by processed state.
integer
Filter by numeric ticket ID.
integer
Filter by numeric customer ID.
integer
One-based quotation page number.
integer
HaloPSA count selector. The provider does not document its exact filtering semantics.
boolean
Whether to include quotation line items in each result.
integer
HaloPSA customer-scope selector for the current customer versus all customers.
boolean
Whether HaloPSA should return its page metadata and quotation envelope.
string
Quotation field used for the fifth sorting level.
boolean
Filter by whether quotations need processing.
string
Filter by HaloPSA quotation status value.
boolean
Filter by whether quotations await approval.
string
Quotation field used for the fourth sorting level.
string
Quotation field used for primary sorting.
string
Quotation field used to break secondary-sort ties.
string
Return quotations containing an attachment of this file type.
string
Quotation field used to break primary-sort ties.
boolean
Sort the fifth field in descending order.
boolean
Sort the fourth field in descending order.
boolean
Sort the primary field in descending order.
boolean
Sort the tertiary field in descending order.
boolean
Sort the secondary field in descending order.
boolean
Return quotations awaiting the current user’s approval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_REPORTSReturn one page of HaloPSA report definitions with the provider’s documented access, chart, customer, publication, ordering, group, search, and type filters.

Input Parameters

integer
Provider-defined maximum number of reports to return.
string
Primary provider field used to order reports.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter reports by matching search text.
string
Secondary provider field used to order reports.
string
Third provider field used to order reports.
string
Fourth provider field used to order reports.
string
Fifth provider field used to order reports.
integer
Maximum reports in this page (1-100).
boolean
Return only reports that include charts.
string
Filter reports by customer name.
integer
Filter reports by HaloPSA report type ID.
integer
Filter reports by report group ID.
boolean
Sort the primary order field descending.
integer
Filter reports by HaloPSA agent restriction ID.
boolean
Include published reports.
boolean
Sort the secondary order field descending.
boolean
Sort the third order field descending.
boolean
Sort the fourth order field descending.
boolean
Sort the fifth order field descending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_SITESReturn one page of HaloPSA customer sites, optionally filtered by customer, name, and active state.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter sites by matching search text.
integer
Maximum sites in this page (1-100).
integer
Return sites belonging to this customer ID.
boolean
Include inactive sites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_STATUSESReturn HaloPSA ticket statuses, optionally constrained to a ticket type or a specific ticket’s valid context.

Input Parameters

integer
Return statuses relevant to this ticket ID.
boolean
Exclude closed statuses.
integer
Return statuses relevant to this ticket type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_SUPPLIERSReturn one page of HaloPSA suppliers with the provider’s documented status, integration, ordering, search, and top-level filters.

Input Parameters

integer
Provider-defined maximum number of suppliers to return.
string
Primary provider field used to order suppliers.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter suppliers by matching search text.
boolean
Return only supplier identifiers when supported.
string
Secondary provider field used to order suppliers.
string
Third provider field used to order suppliers.
string
Fourth provider field used to order suppliers.
string
Fifth provider field used to order suppliers.
integer
Maximum suppliers in this page (1-100).
integer
Filter suppliers by top-level group ID.
boolean
Include active suppliers.
string
Filter suppliers by Xero tenant ID.
string
HaloPSA active/inactive selector string.
boolean
Include inactive suppliers.
boolean
Sort the primary order field descending.
integer
Filter by KashFlow tenant ID.
boolean
Sort the secondary order field descending.
boolean
Sort the third order field descending.
boolean
Sort the fourth order field descending.
boolean
Sort the fifth order field descending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_TEAMSReturn HaloPSA teams available for ticket assignment, optionally limited to the current agent’s teams or a department.

Input Parameters

integer
Return teams in this department ID.
boolean
Return only teams the current agent belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_TICKET_ACTIONSList HaloPSA ticket actions, optionally filtering by occurrence date range and whether attachment details are included. Set ticket_id to retrieve actions for a ticket; HaloPSA can return an empty list when it is omitted.

Input Parameters

string
Return actions that occurred before this ISO 8601 date and time.
integer
Return actions for this ticket ID.
string
Return actions that occurred after this ISO 8601 date and time.
boolean
Include attachment details in returned actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_TICKETSReturn one page of HaloPSA tickets, optionally filtered by customer, site, user, status, assigned agent, or text search.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Text to match against tickets using HaloPSA’s general ticket search.
integer
Return tickets for this site ID.
integer
Return tickets for this end-user ID.
integer
Return tickets assigned to this agent ID.
integer
Maximum tickets in this page (1-100).
integer
Return tickets in this status.
integer
Return tickets for this customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_TICKET_TYPESReturn ticket types available for ticket classification, optionally limited to types that agents can create for a customer.

Input Parameters

integer
Limit ticket types to those available for this customer ID.
boolean
Return only ticket types the current agent can create.
boolean
Include inactive ticket types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_LIST_USERSReturn one page of HaloPSA end users, optionally filtered by customer, site, name, and active state.

Input Parameters

string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter users by matching name or search text.
integer
Return users belonging to this site ID.
integer
Maximum users in this page (1-100).
integer
Return users belonging to this customer ID.
boolean
Include inactive end users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_AGENTCreate or update HaloPSA agent profiles, team memberships, account enablement, administrator access, working hours, licensing, costs, notifications, and approval settings in one array request.

Input Parameters

array
required
Agents to create or update. An item with id updates that agent; an item without id creates an agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_APPOINTMENTCreate or update HaloPSA appointments in one array request. Each item with id updates that appointment and each item without id creates one. HaloPSA does not document a universally sufficient minimal create payload.

Input Parameters

array
required
Appointment objects to create or update. An item with id updates that appointment; an item without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_ASSETCreate or update one or more HaloPSA assets. Each item with an id updates that asset; each item without an id creates a new asset.

Input Parameters

array
required
Assets to create or update. An item with id updates that asset; an item without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_CLIENT_CONTRACTCreate or update one or more HaloPSA client contracts. Each item with an id updates that contract; each item without an id creates a contract. Creates require client_id, ref, start_date, end_date, and billingperiod.

Input Parameters

array
required
Client contracts to create or update. An item with id updates that contract; an item without id creates a contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_CUSTOMERCreate or update one or more HaloPSA customers in the endpoint’s array body. Each item with id updates that customer; each item without id creates one.

Input Parameters

array
required
Customers to create or update. An item with id updates that customer; an item without id creates a customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_INVOICECreate or update HaloPSA invoice records and their typed line items. This action does not capture payment, post or email invoices, create credit notes, or trigger accounting-system synchronization.

Input Parameters

array
required
Invoice records to create or update. A record with id updates that invoice; a record without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_ITEMCreate or update HaloPSA inventory and service items in one array request. Each item with id updates that record and each item without id creates one; mixed batches are supported and can alter inventory and accounting state.

Input Parameters

array
required
Items to create or update. An item with id updates that item; an item without id creates one. HaloPSA may reject operationally incomplete data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_KNOWLEDGE_BASE_ARTICLECreate or update one or more HaloPSA knowledge-base articles through POST /KBArticle. Each item with id updates that article; each item without id creates one. HaloPSA documents no universally sufficient create payload.

Input Parameters

array
required
KBEntry objects to create or update. An item with id updates that article; an item without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_OPPORTUNITYUpsert HaloPSA sales opportunities: each resource item with id updates that record, while each item with id omitted creates a record. HaloPSA does not document a universally sufficient minimal create payload.

Input Parameters

array
required
HaloPSA Faults objects representing sales opportunities. An item with id updates that opportunity; an item without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_PROJECTCreate or update HaloPSA project records, typed milestones, and tags. This action does not close projects, publish articles, send notifications, override record locks, or invoke provider-import and validation workflows.

Input Parameters

array
required
Project records to create or update. A record with id updates that project; a record without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_QUOTATIONCreate or update HaloPSA quotation records and typed quotation lines. This action does not send quotations, start signing or approval, create sales orders, or invoke external commerce integrations.

Input Parameters

array
required
Quotation records to create or update. A record with id updates that quotation; a record without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_REPORTCreate or update HaloPSA report definitions in one array request. Each item with id updates that report and each item without id creates one; this mutates report definitions and may expose saved SQL or report output.

Input Parameters

array
required
AnalyzerProfile report definitions to create or update. An item with id updates that report; an item without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_SITECreate or update one or more HaloPSA customer sites. Each item with an id updates that site; each item without an id creates a site. HaloPSA does not document a universally sufficient minimal create payload.

Input Parameters

array
required
Sites to create or update. An item with id updates that site; an item without id creates a site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_STATUSCreate or update HaloPSA ticket statuses in one array request. Set an item’s id to update that exact status, or omit id to create one.

Input Parameters

array
required
Statuses to create or update. Set id to update that exact status; omit id to create a new status. Only supplied fields are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_SUPPLIERCreate or update one or more HaloPSA suppliers through POST /Supplier. Each item with id updates that supplier; each item without id creates one. HaloPSA does not document a universally sufficient minimal create payload.

Input Parameters

array
required
Suppliers to create or update. An item with id updates that supplier; an item without id creates one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_TEAMCreate or update HaloPSA teams in one array request. Set an item’s id to update that exact team, or omit id to create one.

Input Parameters

array
required
Teams to create or update. Set id to update that exact team; omit id to create a new team. Only supplied fields are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_TICKET_ACTIONCreate or update ticket notes and work-log actions, optionally recording time or applying a ticket status, without sending email. Each resource with action_id updates that action; each resource without action_id creates one.

Input Parameters

array
required
Ticket actions to create or update. An item with action_id updates that action; an item without action_id creates an action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_TICKET_TYPECreate or update HaloPSA ticket types in one array request. Set an item’s id to update that exact ticket type, or omit id to create one.

Input Parameters

array
required
Ticket types to create or update. Set id to update that exact ticket type; omit id to create a new ticket type. Only supplied fields are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HALOPSA_UPSERT_USERCreate or update one or more HaloPSA end-user records without sending welcome email. Each item with an id updates that user; each item without an id creates one.

Input Parameters

array
required
Users to create or update. An item with id updates that user; an item without id creates a user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not