Halo Connect

Halo Connect SQL Passthrough API

Send SQL queries to practices as immediate, async or registered queries. **Immediate queries** are small, time-sensitive queries that return a result in seconds. Response size is limited to 8MB. **Async queries** are queued for execution and results can be retrieved later. The workflow is: 1. **Submit async query** – Creates a query and returns a `queryId` on success. 2. **Get query status** – Check query status. When complete, includes pagination details. 3. **Get query result page** – Retrieve result pages using the pagination info from the status response. **Registered Queries** are also supported. See the [Registered Queries](#tag/Registered-Queries) section for more information.

Documentation GitHub OpenAPI

Operations 10

POST /desktop/sites/{siteId}/queries/immediate Execute immediate query #

POST /desktop/sites/{siteId}/queries/async Submit async query #

GET /desktop/sites/{siteId}/queries/{queryId} Get query status #

GET /desktop/sites/{siteId}/queries/{queryId}/results/{pageNumber} Get query result page #

POST /integrator/sites/{siteId}/queries/immediate Execute immediate query #

POST /integrator/sites/{siteId}/queries/async Submit async query #

GET /integrator/sites/{siteId}/queries/{queryId} Get query status #

POST /integrator/sites/{siteId}/queries/status Get batch query status #

GET /integrator/sites/{siteId}/queries/{queryId}/results/{pageNumber} Get query result page #

GET /integrator/sites/{siteId}/queries/{queryId}/results/{pageNumber}/stream Stream result page #

Documentation

📖

Documentation

https://docs.haloconnect.io/halo-cloud/overview/

📖

APIReference

https://docs.haloconnect.io/api-reference/integrator-openapi.html

📖

APIReference

https://docs.haloconnect.io/api-reference/desktop-openapi.html

📖

Documentation

https://docs.haloconnect.io/halo-cloud/fhir-api/overview/

📖

Documentation

https://docs.haloconnect.io/halo-cloud/fhir-api/capabilities/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/halo-connect/refs/heads/main/openapi/halo-connect-sql-passthrough-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/halo-connect-sql-passthrough-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Halo Connect SQL Passthrough API
  version: 26.619.10213
  license:
    name: Copyright © Halo Connect 2023
    url: http://haloconnect.io
  x-logo:
    url: https://20496383.fs1.hubspotusercontent-na1.net/hubfs/20496383/halo_logo%20(1).png
    altText: Halo Connect Logo
  description: 'Operations tagged SQL Passthrough across 2 of this provider''s published API definitions: halo-connect-desktop-openapi.json, halo-connect-integrator-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.haloconnect.io
  description: Production
- url: https://api.stage.haloconnect.io
  description: Stage
tags:


# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/halo-connect/refs/heads/main/openapi/halo-connect-sql-passthrough-api-openapi.yml