Skip to main content
The ErynoaGroup API is a RESTful API that accepts JSON request bodies and returns JSON responses. All API endpoints are served over HTTPS. This reference covers the conventions, request format, and global headers used across all endpoints.

Base URLs

Always use HTTPS. HTTP requests are redirected to HTTPS automatically.

Authentication

All requests require a valid API key passed as a Bearer token in the Authorization header:
See Authentication for details on generating keys and handling authentication errors.

Request format

  • Set Content-Type: application/json for all POST, PUT, and PATCH requests
  • Request bodies must be valid JSON
  • String values are UTF-8 encoded
  • Dates are ISO 8601 format (2024-01-15T10:30:00Z)

Response format

All responses use a consistent JSON envelope: Successful single resource:
Successful list response:
Error response:

Global request headers

Global response headers

HTTP status codes