HaloITSM Guides
Documentation to assist with the setup and configuration of the HaloITSM platform
Guides > How to start using the Halo API
How to start using the Halo API
Go to Configuration > Integrations > Halo API - here you will see the Resource Server URL and the Authorisation Server URL as well as your tenant name (if applicable)
To start using the API you need to first create an API Application which contains a set of permissions and credentials as well as some other configuraiton options.
The most commonly used Authentication method is Client ID and Secret but you do also need to select an Agent to impersonate. The Agent selected here will also be used for permissions which are further restricted by selecting permissions on the Permissions.
Once this step is complete and saved you can also download examples that can be opened in Postman to help get started
Popular Guides
- Asset Import - CSV/XLS/Spreadsheet Method
- Call Management in Halo
- 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
- Suppliers
