Halo Service Solutions API Documentation

This is the complete API documentation for connecting to the Halo Service Solutions API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Halo Service Solutions: Manage Halo tickets, customers, sites, and users. Keep reading to get started.

Quickstart

Before you run your first Halo Service Solutions request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Halo Service Solutions connection — create or choose one in Connections. Note its connectionId.

Every Halo Service Solutions action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/haloServiceSolutions/actions/{actionSlug}/run

You need a MindCloud API Key and a Halo Service Solutions connection. Then call an action such as Get Current Agent:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/haloServiceSolutions/actions/get-current-agent/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Halo Service Solutions account. See Halo Service Solutions API Authentication for the full flow and how to get your connection credentials.

Halo Service Solutions actions

All 41 published actions for this Halo Service Solutions version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Action
• POSTCreate Agent
• POSTCreate Appointment
• POSTCreate Asset
• POSTCreate Client
• POSTCreate Invoice
• POSTCreate Project
• POSTCreate Purchase Order
• POSTCreate Quotation
• POSTCreate Sales Order
• POSTCreate Site
• POSTCreate Ticket
• POSTCreate User
• GETGet Action
• GETGet Agent
• GETGet Appointment
• GETGet Asset
• GETGet Client
• GETGet Current Agent
• GETGet Invoice
• GETGet Project
• GETGet Purchase Order
• GETGet Quotation
• GETGet Sales Order
• GETGet Site
• GETGet Ticket
• GETGet User
• GETList Actions
• GETList Agents
• GETList Appointments
• GETList Assets
• GETList Clients
• GETList Invoices
• GETList Projects
• GETList Purchase Orders
• GETList Quotations
• GETList Sales Orders
• GETList Sites
• GETList Tickets
• GETList Users
• GETView Tickets

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear