API Reference

The BlueHive API is organized around REST. All requests and responses use JSON. Explore the endpoints below to view parameters, schemas, and example requests.

Base URL: https://api.bluehive.comFormat: JSONAuth: API Key

API Endpoints

Explore the BlueHive API by resource. Each group contains related endpoints.

Health & Status

Service health monitoring endpoints. Use these to verify API availability and check the current version.

2 endpointsView

Healthcare Providers

Search and look up healthcare providers in the BlueHive network. Find clinics by location, services offered, and availability.

1 endpointView

Provider Directory

Search for healthcare providers by location, services, and availability. Find nearby clinics with pricing information.

1 endpointView

Fax Services

Send and manage faxes programmatically. Send documents, check delivery status, and list available fax providers.

5 endpointsView

Incoming Fax

Manage incoming faxes received via webhook. List, retrieve content, reprocess, and monitor incoming fax processing.

7 endpointsView

Fax Management

Search, retrieve, and manage fax documents. View fax metadata, audit logs, content, and trigger processing workflows.

9 endpointsView

Other

1 endpointView

Employers

Manage employer accounts, profiles, and configurations. Create new employers, retrieve employer details, and manage employer-level settings.

8 endpointsView

Orders

Order management for drug tests, physicals, and other occupational health services. Create orders, check status, and retrieve results.

10 endpointsView

Employees

Employee management endpoints. Create, update, and retrieve employee records associated with employer accounts.

7 endpointsView

HL7

Process and send HL7 messages for EHR interoperability. Accept inbound HL7 messages, send lab results, and replay messages.

3 endpointsView

Integrations

Manage brand integrations with third-party systems. Check integration status and configuration.

2 endpointsView

Services

Manage occupational health services. Create, update, search, and configure service offerings with pricing.

6 endpointsView

Brands

Search and manage brand configurations. Brands define white-label settings, logos, colors, and provider networks.

1 endpointView

HL7 Systems

Register and manage HL7 system integrations. Configure outbound interfaces, manage routing priorities, and monitor system activity.

9 endpointsView

Email Triggers

Trigger transactional email notifications for order lifecycle events — acceptance, rejection, results upload, and more.

9 endpointsView
Chat with Bea