Skip to main content

API Reference

Complete REST API documentation for Axiom Genesis middleware services.

Overview

Axiom Genesis exposes a RESTful API through the middleware layer. All endpoints follow consistent patterns for authentication, error handling, and response formats.

Base URL

Production: https://api.axiomgenesis.com/api/v1
Development: http://localhost:3001/api/v1

Authentication

All API requests require JWT authentication via the Authorization header:

Authorization: Bearer <token>

Additionally, tenant context is required via the x-tenant-id header (encrypted) for pre-login requests, or extracted from the JWT for authenticated requests.

API Sections

SectionDescription
Consolidated API GuideComplete endpoint reference
Notification TemplatesNotification system API

Common Patterns

Response Format

All successful responses follow this structure:

{
"success": true,
"data": { ... },
"meta": {
"timestamp": "2026-05-22T10:30:00Z",
"requestId": "uuid"
}
}

Error Format

{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human-readable message",
"details": [ ... ]
}
}

Pagination

List endpoints support pagination:

GET /api/v1/entity/users?page=1&limit=20&sort=usr_created_at&order=desc

Entity API

The generic entity API (/api/v1/entity/:entity_code) provides CRUD operations for all registered entities:

MethodEndpointDescription
GET/entity/:codeList records
GET/entity/:code/:idGet single record
POST/entity/:codeCreate record
PUT/entity/:code/:idUpdate record
DELETE/entity/:code/:idSoft delete record

See the Consolidated API Guide for complete details.