Connecting to HaloServiceDesk

HaloServiceDesk uses API key authentication. You can find or create API keys in HaloServiceDesk under Administration > Integrations > Halo API.

Using API Key Authentication

Set the following connection properties to connect:

AuthScheme: Set this to APIKey.
APIKey: Set this to the API key from your HaloServiceDesk account.
Domain: Set this to the hostname of your HaloServiceDesk instance (e.g. yourcompany.haloservicedesk.com).

Example connection string

Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com";

Available Tables

The HaloServiceDesk API Profile provides access to service desk data across 19 tables:

Actions - Access ticket actions including notes, updates, and status changes.
Agents - Access agents (staff members) who handle tickets and actions.
Assets - Query IT assets and configuration items in the service desk inventory.
Attachments - Access file attachments linked to tickets and actions.
Clients - Query client organisations managed in HaloServiceDesk.
Contracts - Query support and billing contracts associated with clients.
Invoices - Query invoices generated for billable services and contracts.
Items - Access stock and catalogue items used in invoices and orders.
KBArticles - Access knowledge base articles with solutions and how-to guides.
Opportunities - Query sales opportunities tracked through the sales pipeline.
Priority - Access SLA-priority combinations with response and fix time targets.
Projects - Query projects and project tasks with time budgets and milestone tracking.
Sites - Query physical or logical sites associated with clients.
Status - Query ticket statuses with SLA action configuration.
Suppliers - Access supplier organisations associated with assets and contracts.
Teams - Access agent teams for ticket routing and project assignment.
TicketType - Query ticket types controlling routing and ITIL classification.
Tickets - Query support tickets with status, priority, SLA, and category details.
Users - Access end users who raise and track support tickets.

Usage Examples

Actions:

SELECT * FROM Actions WHERE TicketId = 1

Agents:

SELECT * FROM Agents

Assets:

SELECT * FROM Assets WHERE ClientId = 1

Attachments:

SELECT * FROM Attachments WHERE TicketId = 1

Clients:

SELECT * FROM Clients

Contracts:

SELECT * FROM Contracts WHERE ClientId = 1

Invoices:

SELECT * FROM Invoices WHERE ClientId = 1

Items:

SELECT * FROM Items

KBArticles:

SELECT * FROM KBArticles

Opportunities:

SELECT * FROM Opportunities WHERE ClientId = 1

Priority:

SELECT * FROM Priority

Projects:

SELECT * FROM Projects WHERE ClientId = 1

Sites:

SELECT * FROM Sites WHERE ClientId = 1

Status:

SELECT * FROM Status

Suppliers:

SELECT * FROM Suppliers

Teams:

SELECT * FROM Teams

TicketType:

SELECT * FROM TicketType

Tickets:

SELECT * FROM Tickets WHERE StatusId = 1

Users:

SELECT * FROM Users WHERE ClientId = 1

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API key used to authenticate requests to the HaloServiceDesk API.
AuthScheme	The scheme used for authentication. Currently, APIKey is the only supported authentication method. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
Domain	The subdomain of your HaloServiceDesk instance.