Runs API

Read service runs (jobs) from HoneyRuns via REST API

Overview

The HoneyRuns Runs API lets you read service runs — appointments, work orders, and their outcomes — for your company. Use it to sync HoneyRuns data into external tools like Zapier, Dispatch, or your own systems.

Base URL: https://api.honeyruns.com

Full endpoint reference → /reference Every endpoint, parameter, field, and response shape is documented in the interactive API Reference, generated directly from the API's OpenAPI spec. This guide covers concepts; the reference is the source of truth.

Authentication

All requests require an API key passed as a Bearer token:

Authorization: Bearer YOUR_API_KEY

API keys are provisioned by HoneyRuns staff. Contact [email protected] to request one.

Quickstart

List recently completed runs:

curl https://api.honeyruns.com/api/v1/runs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -G \
  --data-urlencode "status=completed" \
  --data-urlencode "limit=20"

Fetch a single run by ID:

curl https://api.honeyruns.com/api/v1/runs/run_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Responses follow the standard envelope — { "success": true, "data": ..., "meta": ... } on success and { "success": false, "error": { "code", "message" } } on failure. See the API Reference for the complete schema of every field.

Polling with updated_since

For Zapier or other polling integrations, use updated_since to fetch only new or changed runs since your last poll:

# On each poll, pass the timestamp of your last successful fetch
curl "https://api.honeyruns.com/api/v1/runs?updated_since=2024-03-15T10:00:00Z" \
  -H "Authorization: Bearer YOUR_API_KEY"

Store the updated_at of the most recent run returned, and use it as updated_since on the next poll. The same pattern works for the Vehicles API.

---

Questions? Email [email protected]