API Reference

The Hermes API Gateway provides a unified REST API for all platform features.

Base URL

https://api.hermes.camie.ai

Authentication

All endpoints (except /health) require a Bearer token:

Authorization: Bearer hermes_your_api_key
# or
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

See Authentication for details.

Rate Limits

Route Map

The gateway proxies requests to the appropriate subsystem:

Lead data model

Lead imports are company-centered. A lead list contains companies, and leads are people attached to those companies:

lead_lists.id -> companies.lead_list_id
companies.id -> leads.company_id

For API-key integrations that need lead-list association, use POST /v1/leads with company_name, people, and camel-case leadListId. Hermes finds or creates the company, sets the company's lead_list_id when the company is new or currently has no list, then stores each person as a lead under that company.

The single-person personFirstName/personLastName create shape does not accept leadListId; it can only attach to an existing company via companyId.

Relevant pages:

• Create Lead List
• Add Leads
• List Leads

Response Format

All responses follow a consistent format:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "timestamp": "2026-03-14T14:15:53.984Z"
  }
}

Error Response

{
  "success": false,
  "error": "Description of what went wrong"
}

HTTP Status Codes