Total Access Docs
API Reference

API Reference

REST API endpoints for all Total Access modules.

API Reference

The Total Access REST API provides programmatic access to every module in the platform. All endpoints are served from:

  • Production Sandbox: https://developer.totalaccess.co.za/api/v1
  • Production Live: https://totalaccess.co.za/api/v1
  • Development Sandbox: https://dev-developer.totalaccess.co.za/api/v1
  • Development Live: https://dev-next.totalaccess.co.za/api/v1

Conventions

Request format

  • All requests use JSON (Content-Type: application/json)
  • Authentication via Authorization: Bearer <token> header
  • All dates are ISO 8601 (2026-07-22T12:00:00Z)

Response format

Every response follows a consistent envelope:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 234
  }
}

Error responses:

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "details": { ... }
  }
}

Pagination

List endpoints support cursor-based and offset pagination:

ParameterDefaultDescription
page1Page number (offset pagination)
limit50Items per page (max 100)
cursorCursor for cursor-based pagination
sortcreated_at:descSort field and direction

Available endpoints

Integration management

PageDescription
AuthenticationAPI keys, JWT tokens, scopes, IP allowlisting
API KeysCreate, list, update, reveal, revoke API keys
OAuth2OAuth2 provider for third-party developers
Outbound WebhooksConfigure event-driven outbound webhooks
Inbound WebhooksCreate inbound webhook endpoints for external data
Webhook LogsQuery delivery logs and statistics
Public Data APIAction-based read-only API with X-API-Key auth
AI Agent & MCP BridgeAI agent tool catalog and MCP adapter

Module APIs

MethodPathDescription
GET/meCurrent authenticated user
GET/modulesList available modules
GET/healthAPI health check (no auth)
GET/finance/invoicesList invoices
POST/finance/invoicesCreate invoice
GET/finance/billsList bills
GET/finance/paymentsList payments
POST/finance/batch-exportBatch export documents as CSV
POST/finance/auditor-exportGenerate auditor export bundle
GET/work-itemsList work items (jobs, tasks, projects)
POST/work-itemsCreate work item
GET/contactsList contacts (customers/suppliers)
GET/employeesList employees
GET/attendance/logsList attendance records
GET/vehiclesList vehicles
GET/formsList form definitions
POST/forms/submissionsSubmit a form
GET/workflowsList workflow templates
POST/workflowsCreate a workflow template
GET/iot/providersList IoT providers
GET/iot/devicesList IoT devices
GET/whatsapp/clientGet WhatsApp client status
POST/whatsapp/verify-numberVerify WhatsApp number(s)
GET/integrations/analyticsAPI usage analytics
GET/integrations/api-usage-logsAPI usage logs
GET/integrations/rate-limit-tierRate limit tier info
GET/whitelabelResolve white-label branding
GET/paymentsList payment history
GET/integrations/postmanDownload Postman collection

Module API documentation is being added progressively. The integration management endpoints above are fully documented. For module-specific endpoint details, contact support.

On this page