API overview
The public API is served at api.<DOMAIN> and versioned under /v1.
bash
curl http://api.localhost/v1/contacts \
-H "X-API-Key: $NOTIFYZR_API_KEY"- Conventions — envelopes, errors, pagination, idempotency.
- Endpoints — the full route list.
Base URLs
| Environment | Base URL |
|---|---|
| Development | http://api.localhost |
| Self-hosted | https://api.<your-domain> |
A minimal request
Every authenticated call needs exactly one header:
X-API-Key: <your key>See Authentication for how keys are scoped and expire.
Health
GET /health is unauthenticated and returns the service's status. It is what the status page at status.<DOMAIN> probes.