How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

Halo Connect SQL Passthrough API is one of 5 APIs that Halo Connect publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SQL Passthrough. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths. It is described by OpenAPI 3.2.0, at version 26.619.10213.

Requests are made against 2 base URLs: https://api.haloconnect.io, https://api.stage.haloconnect.io.

10 operations 10 paths 0 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.619.10213
Base URL
https://api.haloconnect.io
Authentication
API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Halo Connect SQL Passthrough API declares 3 security schemes for authenticating requests. An API key is passed in the header as Ocp-Apim-Subscription-Key (SubscriptionKey). It accepts HTTP bearer tokens (JWT) (AuthorizationHeader). An API key is passed in the header as DeviceId (DeviceIdHeader).

  • SubscriptionKey — The subscription key for the API.
  • AuthorizationHeader — Bearer token for authentication.
  • DeviceIdHeader — Device ID of the device making the request.

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

SQL Passthrough 10

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 limi…

POST
/desktop/sites/{siteId}/queries/immediate
Execute immediate query
createImmediateQuery 1 param body → 200400401403404500503504
POST
/desktop/sites/{siteId}/queries/async
Submit async query
createAsyncQuery 1 param body → 201400401403404500503504
GET
/desktop/sites/{siteId}/queries/{queryId}
Get query status
getQuery 2 params → 200400401403404500
GET
/desktop/sites/{siteId}/queries/{queryId}/results/{pageNumber}
Get query result page
getResultPage 3 params → 200400401403404410500
POST
/integrator/sites/{siteId}/queries/immediate
Execute immediate query
createImmediateQuery 1 param body → 200400401403404500503504
POST
/integrator/sites/{siteId}/queries/async
Submit async query
createAsyncQuery 1 param body → 201400401403404500503504
GET
/integrator/sites/{siteId}/queries/{queryId}
Get query status
getQuery 2 params → 200400401403404500
POST
/integrator/sites/{siteId}/queries/status
Get batch query status
getQueryStatusBatch 1 param body → 200400401403404500
GET
/integrator/sites/{siteId}/queries/{queryId}/results/{pageNumber}
Get query result page
getResultPage 3 params → 200400401403404410500
GET
/integrator/sites/{siteId}/queries/{queryId}/results/{pageNumber}/stream
Stream result page
streamResultPage 3 params → 200400401403404410500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

halo-connect-sql-passthrough-api-openapi.yml Raw ↑

Other APIs Halo Connect publishes across the network.

Halo Connect FHIR API
Halo Connect Registered Queries API
Halo Connect Sites API
Halo Connect Tokens API
Where this information came from

This is an independent, third-party profile of Halo Connect SQL Passthrough API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.