Guides

Create And Download Exports

Run export jobs for audit data and download JSONL or CSV output.

Create An Export Job

curl -X POST "https://api.hyrelog.com/v1/exports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "HOT",
    "format": "JSONL",
    "filters": {
      "from": "2026-01-01T00:00:00Z",
      "to": "2026-01-31T23:59:59Z"
    }
  }'

Expected: 201 with jobId.

Check Job Status

curl "https://api.hyrelog.com/v1/exports/JOB_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

Download Export

curl -L "https://api.hyrelog.com/v1/exports/JOB_ID/download" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o hyrelog-export.jsonl

For large exports, keep the request streaming and write directly to disk.

Set Up Webhooks

Configure webhook endpoints and monitor deliveries.

Query And Filter Events

Use filters and cursor pagination to retrieve exactly the events you need.

On this page

Create An Export Job Check Job Status Download Export