HaloPSA logo

HaloPSA

Create, inspect, list, and delete HaloPSA tickets, with customer, site, user, agent, asset, and ticket-routing lookups.

85 actions Integration catalog
Request access
Connect HaloPSA once you're in Boring.
01 · WHAT THE AGENT CAN DO

Actions

Every capability is a discrete, logged action the agent calls by name — scoped to what you authorize and recorded in the run trace.

Create TicketHALOPSA_CREATE_TICKET
Create one HaloPSA ticket from a summary and optional details and routing IDs; sends the provider-required one-item array body.
Delete AgentHALOPSA_DELETE_AGENT
Request 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.
Delete AppointmentHALOPSA_DELETE_APPOINTMENT
Delete one HaloPSA appointment by numeric ID. HaloPSA also deletes its linked Exchange event unless ignore_exchange_delete is true.
Delete AssetHALOPSA_DELETE_ASSET
Delete one HaloPSA asset by numeric ID.
Delete AttachmentHALOPSA_DELETE_ATTACHMENT
Delete one HaloPSA attachment by numeric ID.
Delete Client ContractHALOPSA_DELETE_CLIENT_CONTRACT
Delete one HaloPSA client contract by numeric ID.
Delete CustomerHALOPSA_DELETE_CUSTOMER
Delete one HaloPSA customer by numeric ID. Success is reported only after HaloPSA returns the endpoint's documented HTTP 200 status.
Delete InvoiceHALOPSA_DELETE_INVOICE
Delete 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.
Delete ItemHALOPSA_DELETE_ITEM
Delete one HaloPSA inventory or service item by numeric ID. Use only for an item that is confirmed safe to remove.
Delete Knowledge Base ArticleHALOPSA_DELETE_KNOWLEDGE_BASE_ARTICLE
Delete one HaloPSA knowledge-base article by numeric ID. Use only for an article that is confirmed safe to remove.
Delete OpportunityHALOPSA_DELETE_OPPORTUNITY
Delete one HaloPSA sales opportunity by numeric ID.
Delete ProjectHALOPSA_DELETE_PROJECT
Delete one HaloPSA project by numeric ID.
Delete QuotationHALOPSA_DELETE_QUOTATION
Delete one HaloPSA quotation by numeric ID.
Delete ReportHALOPSA_DELETE_REPORT
Delete one HaloPSA report definition by numeric ID.
Delete SiteHALOPSA_DELETE_SITE
Delete one HaloPSA customer site by numeric ID.
Delete StatusHALOPSA_DELETE_STATUS
Delete one HaloPSA ticket-status configuration record by numeric ID. Use only for a status that is confirmed safe to remove.
Delete SupplierHALOPSA_DELETE_SUPPLIER
Delete one HaloPSA supplier by numeric ID. Use only for a supplier that is confirmed safe to remove.
Delete TeamHALOPSA_DELETE_TEAM
Delete one HaloPSA team by numeric ID. This changes tenant-level team configuration.
Delete TicketHALOPSA_DELETE_TICKET
Delete one HaloPSA ticket by numeric ID, optionally recording a reason. The ticket is removed from active ticket results.
Delete Ticket ActionHALOPSA_DELETE_TICKET_ACTION
Delete 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.
Delete Ticket TypeHALOPSA_DELETE_TICKET_TYPE
Delete one HaloPSA ticket-type configuration record by numeric ID. This does not create or verify a disposable replacement.
Delete UserHALOPSA_DELETE_USER
Delete one HaloPSA end user by numeric ID.
Get AgentHALOPSA_GET_AGENT
Return 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.
Get AppointmentHALOPSA_GET_APPOINTMENT
Return one HaloPSA appointment by numeric ID, optionally with extra detail objects.
Get AssetHALOPSA_GET_ASSET
Return one HaloPSA asset by numeric ID, optionally including activity, allowed statuses, details, diagram data, and hierarchy data.
Get AttachmentHALOPSA_GET_ATTACHMENT
Download one HaloPSA attachment by numeric ID.
Get Client ContractHALOPSA_GET_CLIENT_CONTRACT
Return one HaloPSA client contract by numeric ID, with optional expanded billing, asset, user, schedule, and period details.
Get Current AgentHALOPSA_GET_CURRENT_AGENT
Return a compact identity for the HaloPSA agent authorized by the current connection, without claims or access-control records.
Get CustomerHALOPSA_GET_CUSTOMER
Return one HaloPSA customer by numeric ID, with optional expanded, activity, ticket-type, period, and pre-pay data.
Get InvoiceHALOPSA_GET_INVOICE
Return one HaloPSA invoice by numeric ID, optionally with extra detail objects.
Get ItemHALOPSA_GET_ITEM
Return one HaloPSA inventory or service item by numeric ID, optionally with expanded details and tenant-specific accounting data; additional provider fields are preserved.
Get Knowledge Base ArticleHALOPSA_GET_KNOWLEDGE_BASE_ARTICLE
Return one HaloPSA knowledge-base article by numeric ID, optionally with expanded details and language or organisation context.
Get OpportunityHALOPSA_GET_OPPORTUNITY
Return one HaloPSA sales opportunity by numeric ID, optionally with extra provider detail objects.
Get ProjectHALOPSA_GET_PROJECT
Return one HaloPSA project by numeric ID, optionally with expanded details.
Get QuotationHALOPSA_GET_QUOTATION
Return one HaloPSA quotation by numeric ID, optionally with expanded details or portal-view context.
Get ReportHALOPSA_GET_REPORT
Return one HaloPSA report definition by numeric ID. Optionally include definition details or load report data with the documented report context.
Get SiteHALOPSA_GET_SITE
Return one HaloPSA customer site by numeric ID, with optional customer, permission, activity, detail, setup, and ticket-type context.
Get StatusHALOPSA_GET_STATUS
Return one HaloPSA ticket-status configuration record by numeric ID, optionally including its detailed configuration.
Get SupplierHALOPSA_GET_SUPPLIER
Return one HaloPSA supplier by numeric ID, optionally including expanded details; additional provider fields are preserved.
Get TeamHALOPSA_GET_TEAM
Return one HaloPSA team by numeric ID, optionally including agent details and expanded team objects.
Get TicketHALOPSA_GET_TICKET
Return one HaloPSA ticket by numeric ID, with core assignment and classification fields and optional expanded details and most recent action.
Get Ticket ActionHALOPSA_GET_TICKET_ACTION
Get one HaloPSA ticket action by numeric action ID, optionally providing its ticket ID and requesting expanded details.
Get Ticket TypeHALOPSA_GET_TICKET_TYPE
Return 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.
Get UserHALOPSA_GET_USER
Return one HaloPSA end user by numeric ID, with optional customer, site, ticket-type, opportunity, supplier, activity, billing, asset, and detail context.
List AgentsHALOPSA_LIST_AGENTS
Return compact HaloPSA agent records for assignment lookup, optionally filtered by name, email address, telephone number, or team ID.
List AppointmentsHALOPSA_LIST_APPOINTMENTS
Return one page of HaloPSA appointments, optionally filtered by customer, ticket, date range, or search text.
List AssetsHALOPSA_LIST_ASSETS
Return one page of HaloPSA assets, optionally filtered by customer, site, user, asset type, search text, and active state.
List AttachmentsHALOPSA_LIST_ATTACHMENTS
List HaloPSA attachment metadata, optionally for one ticket.
List Client ContractsHALOPSA_LIST_CLIENT_CONTRACTS
Return one page of HaloPSA client contracts, optionally filtered by customer, site, search text, and active state.
List CustomersHALOPSA_LIST_CUSTOMERS
Return one page of HaloPSA customers, optionally filtered by name and active state.
List InvoicesHALOPSA_LIST_INVOICES
Return one page of HaloPSA invoices, optionally filtered by date, customer, site, ticket, user, or search text.
List ItemsHALOPSA_LIST_ITEMS
Return one page of HaloPSA inventory and service items with the provider's documented status, asset, supplier, accounting, stock, search, and ordering filters.
List Knowledge Base ArticlesHALOPSA_LIST_KNOWLEDGE_BASE_ARTICLES
Return one page of HaloPSA knowledge-base articles using the provider's documented status, access, relationship, language, search, and ordering filters.
List OpportunitiesHALOPSA_LIST_OPPORTUNITIES
Return one page of HaloPSA sales opportunities, optionally filtered by customer, assignment, status, date range, or search text.
List PrioritiesHALOPSA_LIST_PRIORITIES
Return HaloPSA policy-priority mappings used to classify tickets, optionally filtered by SLA policy ID.
List ProjectsHALOPSA_LIST_PROJECTS
Return one page of HaloPSA projects. HaloPSA represents projects as ticket-like records in a tickets array.
List QuotationsHALOPSA_LIST_QUOTATIONS
Return HaloPSA quotations with customer, state, approval, processing, text, attachment, ordering, and page filters.
List ReportsHALOPSA_LIST_REPORTS
Return one page of HaloPSA report definitions with the provider's documented access, chart, customer, publication, ordering, group, search, and type filters.
List SitesHALOPSA_LIST_SITES
Return one page of HaloPSA customer sites, optionally filtered by customer, name, and active state.
List StatusesHALOPSA_LIST_STATUSES
Return HaloPSA ticket statuses, optionally constrained to a ticket type or a specific ticket's valid context.
Showing the first 60 of 85 actions.