Everything you need to integrate
in 5 minutes

Your first API request

The REST API lets you fetch data programmatically. All requests are made over HTTPS to the base URL:

1. Get your API key

Log in to your dashboard → Integrations → REST API → copy your Public API Token.

2. Make a test request

curl -X GET https://api.ormiar.com/v1/stats \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

API keys & security

We use Bearer tokens. Pass your key in the Authorization header of every request. API access is available on the Enterprise plan only.

Authorization: Bearer YOUR_API_TOKEN

Real-time notifications

Webhooks let you instantly receive a POST on your server the moment the AI qualifies a lead or books an appointment. Set the destination URL in your dashboard → Integrations → REST API & Webhooks.

Supported events

• lead_qualified — the bot collected contact info and qualified the lead
• lead_booked — the lead was scheduled for an appointment

Example payload (lead_qualified)

{
  "event": "lead_qualified",
  "bot_id": "XXXXX",
  "client_id": "XXXXX",
  "lead_data": {
    "name": "XXXXX XXXXX",
    "phone": "+XXXXX",
    "interest": "Book a consultation"
  },
  "timestamp": "2026-05-17T14:33:00Z"
}

All platform methods

Complete list of endpoints for CRM, dashboard, and website integrations.

Data protection

• All connections are secured with TLS 1.3.
• Public API access is restricted by plan policies (Business / Enterprise).
• Rate limiting: 120 requests / min per key. If exceeded — 429 Too Many Requests.

HTTP codes