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:
| Parameter | Default | Description |
|---|---|---|
page | 1 | Page number (offset pagination) |
limit | 50 | Items per page (max 100) |
cursor | — | Cursor for cursor-based pagination |
sort | created_at:desc | Sort field and direction |
Available endpoints
Integration management
| Page | Description |
|---|---|
| Authentication | API keys, JWT tokens, scopes, IP allowlisting |
| API Keys | Create, list, update, reveal, revoke API keys |
| OAuth2 | OAuth2 provider for third-party developers |
| Outbound Webhooks | Configure event-driven outbound webhooks |
| Inbound Webhooks | Create inbound webhook endpoints for external data |
| Webhook Logs | Query delivery logs and statistics |
| Public Data API | Action-based read-only API with X-API-Key auth |
| AI Agent & MCP Bridge | AI agent tool catalog and MCP adapter |
Module APIs
| Method | Path | Description |
|---|---|---|
GET | /me | Current authenticated user |
GET | /modules | List available modules |
GET | /health | API health check (no auth) |
GET | /finance/invoices | List invoices |
POST | /finance/invoices | Create invoice |
GET | /finance/bills | List bills |
GET | /finance/payments | List payments |
POST | /finance/batch-export | Batch export documents as CSV |
POST | /finance/auditor-export | Generate auditor export bundle |
GET | /work-items | List work items (jobs, tasks, projects) |
POST | /work-items | Create work item |
GET | /contacts | List contacts (customers/suppliers) |
GET | /employees | List employees |
GET | /attendance/logs | List attendance records |
GET | /vehicles | List vehicles |
GET | /forms | List form definitions |
POST | /forms/submissions | Submit a form |
GET | /workflows | List workflow templates |
POST | /workflows | Create a workflow template |
GET | /iot/providers | List IoT providers |
GET | /iot/devices | List IoT devices |
GET | /whatsapp/client | Get WhatsApp client status |
POST | /whatsapp/verify-number | Verify WhatsApp number(s) |
GET | /integrations/analytics | API usage analytics |
GET | /integrations/api-usage-logs | API usage logs |
GET | /integrations/rate-limit-tier | Rate limit tier info |
GET | /whitelabel | Resolve white-label branding |
GET | /payments | List payment history |
GET | /integrations/postman | Download Postman collection |
Module API documentation is being added progressively. The integration management endpoints above are fully documented. For module-specific endpoint details, contact support.