• Skip to primary navigation
  • Skip to main content
  • Skip to footer
  • Skip to custom navigation
HaloPSA

HaloPSA

  • Features
  • Pricing
  • Integrations
  • Resources
    • Demo On Demand
    • Roadmap
    • ITIL Alignment
    • Guides
    • HaloPSA Academy
    • Onboarding Partners
    • Distributors
  • Compare Us
    • ConnectWise
    • Datto Autotask
  • Solutions
    • I Need To…
      • Run My Business More Effectively

        Find out which customers and services are profitable and gain the confidence to act on this data.

      • Improve My Customer Experience

        Make all interactions as smooth as possible with a fully thought out end to end experience for your customers.

      • Streamline My Sales Process

        Remove unnecessary processes from your sales and account management and let them focus on their customer relationships.

      • Gain Control Of My Projects

        Visualise your workload and forecast your required budgets to ensure you can deliver on your projects.

    • We Are A…
      • Managed Service Provider
      • Telecommunications Provider
      • Cloud Solution Provider
      • Software Company
      • Consultancy Firm
    • Case Studies
      • nGeneration
      • Centrality
      • Commercial Managed IT
  • Start trial
  • Book demo

HaloPSA Guides

Documentation to assist with the setup and configuration of the HaloPSA platform

Guides > Searching Entities in Halo

Searching Entities in Halo


Entity Specific Searching


Within each module in Halo, you will find a 'search bar' in the top LHS or the module in question:



This search box will return a filtered list of the module-specific entity, based on your search criteria. 


Some custom fields are searchable - if you have created a custom field & have the below option enabled:


Then you can search for records based on the contents of said custom field. 


Searchable parameters per module:

Entity/ModuleSearchable Fields

Agreements

  • Agreement Reference
  • Customer
  • Site (If Site is selected against the Agreement)
  • Note
  • Status
  • Contract Type
  • Fixed/Prepay

Items

  • Name
  • Internal Reference
  • External Reference
  • Long Description
  • SKU
  • Item ID
  • Accounts ID
  • Product Category 

Quotations

  • Quote Reference
  • Title
  • End-User of Quote
  • Site
  • Client

Sales Orders

  • Sales Order ID
  • Title
  • End-User
  • Site
  • Client
Users
  • Username
  • Frist Name
  • Last Name
  • Email Address
  • Email Address 2
  • Email Address 3
  • "Other Fields" (Network login, Department, Job Title, Reports To etc..)
  • Phone Numbers (Home Phone, Mobile, Fax)

Advanced Searching


Halo also allows for searching against specific parameters against certain entities. In the front-end, you can simply click the filter icon and enter into the search bar that appears below:



You can also use perform this type of searching within the API, via including an 'advanced_search' query parameter. Endpoints that accept the 'advanced_search' parameter include:


  • Clients
  • Attachments (when using table view)
  • Agreements
  • Assets
  • Ticket Lists
  • Invoices
  • Products
  • Sales Orders
  • Sites
  • Users

The format of the API call is a URL Encoded array, accepting 3 parameters: 'filter_name', 'filter_type' and 'filter_value'. The filter_type parameter is an integer, where each integer represents an operation (=, <, > etc..). The integer value to operation relationships are described below:


Filter_Type IntegerOperation

0

in

1

not in

2=
3<>
4like
5not like
6=
7>
8>=
9<
10<=

An example of an API call made to the clients endpoint, filtering by clients for a specific Top Level, would look like: .../api/client?advanced_search=%5B%7B%22filter_name%22%3A%22toplevel_name%22%2C%22filter_type%22%3A4%2C%22filter_value%22%3A%22managed%22%7D%5D

Popular Guides

  • Asset Import - CSV/XLS/Spreadsheet Method
  • Call Management
  • Creating a New Application for API Connections
  • Creating Agents and Editing Agent Details
  • Departments and Teams
  • Halo Integrator
  • Importing Data
  • Multiple New Portals with different branding for one customer [Hosted]
  • NHServer Deprecation User Guide
  • Organisation Basics
  • Organising Teams of Agents
  • Step-by-Step Configuration Walk Through

Footer

Products

Company

  • Contact us
  • Events
  • Channel Partners
  • Technology Partners
  • Distributors
  • Referral Program

HaloPSA

  • Features
  • Integrations
  • Mobile Apps
  • Blog
  • Pricing

Key Features

  • Service Desk
  • Sales CRM
  • Billable Time Tracking
  • Reporting
  • Contracts
  • Billing
  • Stock Management
  • Projects

Compare PSA

  • ConnectWise
  • Datto Autotask
  • Accelo
  • Harmony PSA
  • Naverisk
  • Top Desk
  • Kaseya BMS
  • Atera
  • Freshservice

Social

  • Terms and Conditions
  • Privacy Policy
  • Security
  • GDPR
  • Modern Slavery Statement
We've moved!

Please visit our new website at USEHALO.COM/HALOPSA