Fax Management

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

9 endpoints

Guide

Advanced fax management for searching, viewing, and processing fax documents. This includes QR code scanning, page-level metadata editing, PDF splitting, and audit logging. Used by operations teams to manage the fax processing pipeline.

Searching Faxes

The search endpoint supports rich filtering including status, brand, date ranges, and partial ID matching. Results include full page data, QR code scan results, and split information.

Search faxes by status

Find error faxes that need attention

# Find faxes in error status
curl "https://api.bluehive.com/v1/fax?status=error&pageSize=25" \
  -H "Authorization: ApiKey YOUR_API_KEY"

# Search by brand and date range
curl "https://api.bluehive.com/v1/fax?brandId=BRAND123&since=2026-03-01T00:00:00Z&until=2026-03-09T00:00:00Z" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Fax Processing Pipeline

The processing pipeline has three separate steps that can be triggered individually:

Scan — Scan QR codes on each page to extract order data
Split — Split the multi-page fax PDF into individual documents per order item
Process — Upload split documents as results to matched order items and forward via HL7

Faxes progress through statuses: received → queued → processing → completed (or error). Each step can be retried independently if errors occur.