CrystalQore
DevelopersAPI Reference

Fax

List inbound, outbound, and queued faxes for a tenant.

Fax

GET /api/v1/fax

Permissionfax
User headerOptional (not used to filter the list)
typeMeaning
inbox (default)Received faxes
sentOutbound faxes
queueOutbound queue

If the phone system is not linked, the API returns TENANT_NOT_CONFIGURED or PBX_NOT_CONFIGURED.

data includes faxes[] and the type you requested. Each fax has id, date, caller fields, destination, pages, status, retryCount, and sender when attribution is available.

curl -sS "https://app.crystalqore.com/api/v1/fax?type=inbox" \
  -H "X-API-Key: $CRYSTALQORE_API_KEY" \
  -H "X-Tenant-Id: $CRYSTALQORE_TENANT_ID"

On this page