GET API Reference

Integrate Hermon data into your databases, spreadsheets, or third-party reporting tools using our read-only GET endpoints.

Overview

Hermon exposes read-only HTTP GET endpoints to fetch information about your leads, contracts, payments, appointments, and opt-ins. All responses are returned as structured JSON data matching the Hermon platform schema.

How It Works

Query workspace records using standard GET requests authenticated via your secret API key:

✦

Deduplicated Contacts

Hermon automatically links opt-ins, appointments, contracts, and payments to a single unified Lead record.
✦

Advanced Filtering

Query records dynamically using filters like status, lead UUID, program UUID, assigned closer/setter, or dates.
✦

Aggregated Metrics

The Payments endpoint returns real-time totals, group statistics, and transactional summaries categorized by currency.
✦

Full Playground Examples

Every reference page includes ready-to-copy code snippets in cURL, JavaScript, Python, PHP, and Go.

Endpoint Base

Method

GET

Base URL

https://api.hermon.io/api/external

Rate Limit

300 req/min per org

GEThttps://api.hermon.io/api/external

Authentication

To authenticate, obtain an API Key from the Hermon dashboard (Settings → Integrations → API Keys) and include it as the x-api-key header in every HTTP request.

x-api-key:sk_live_abc123...
Keep your API key secure. Never expose it in client-side scripts, frontend single page apps (SPAs), or public repositories.

Standard Pagination

List endpoints are paginated. You can pass page and limit as query parameters to control results returned:

GET/api/external/leads?page=1&limit=10

Paginated responses include a metadata envelope:

json
{
  "status": "success",
  "message": "Leads fetched successfully",
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 147,
    "totalPages": 15,
    "hasNext": true,
    "hasPrev": false
  }
}

HTTP Responses

Hermon API uses standard HTTP response codes to indicate request outcomes:

Request Succeeded

200 OK

The request was successful. List endpoints return paginated collections under a data array, while details endpoints return a single resource object.

Authentication Failed

401 Unauthorized

The x-api-key header was missing, invalid, or revoked. Ensure you have copied your key correctly from the workspace settings dashboard.

Too Many Requests

429 Rate Limited

The organization has exceeded 300 requests per minute (shared by all of its API keys). Wait the number of seconds in the Retry-After header, then retry. The opt-in submit endpoint is limited separately to 5 requests per second per API key, and repeated invalid keys from one IP are briefly blocked.

Quick Actions