# Halo Cloud API for Integrators

**Canonical:** https://apis.io/apis/best-practice/halo-cloud-integrator-api/  
**Provider:** Best Practice Software — https://apis.io/providers/best-practice/  
**Base URL:** https://api.haloconnect.io  
**Documentation:** https://docs.haloconnect.io/api-reference/integrator-openapi.html

Halo Cloud API for Integrators is one of 3 APIs that [Best Practice Software](https://apis.io/providers/best-practice/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include FHIR, Healthcare, Interoperability, and SQL Passthrough. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

The integrator-facing Halo Cloud API from Best Practice's Halo Connect platform. Lets approved partners query Bp Premier practice data by four means - Sites (retrieve site metadata and onboarding info), SQL Passthrough (execute SQL against the practice database), FHIR (search practice data as HL7 FHIR R4 resources), and Registered Queries (recurring SQL). OpenAPI 3.1.1, authenticated with an Azure API Management subscription key (Ocp-Apim-Subscription-Key header); every call requires an active pairing with the target site.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/best-practice/refs/heads/main/openapi/haloconnect-integrator-openapi.json
- **APIReference** — https://docs.haloconnect.io/api-reference/integrator-openapi.html
- **Documentation** — https://docs.haloconnect.io/halo-cloud/overview/
- **GettingStarted** — https://docs.haloconnect.io/halo-cloud/getting-started/
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/best-practice/refs/heads/main/apis.yml

## Other Best Practice Software APIs (2)

- [Halo Cloud API for Desktop Applications](https://apis.io/apis/best-practice/halo-cloud-desktop-api/)
- [FHIR API for Bp Premier](https://apis.io/apis/best-practice/fhir-api-bp-premier/)

## Tags

FHIR, Healthcare, Interoperability, SQL Passthrough

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/best-practice/halo-cloud-integrator-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/best-practice/.