Intuka API Reference

Base URL

All API requests are made to your tenant's dedicated instance:

https://your-tenant.intuka.com/api/v1

Replace your-tenant with your organization's subdomain.

Authentication

Intuka uses JWT Bearer tokens for API authentication. All authenticated endpoints require the Authorization header.

POST /api/v1/auth/login
Content-Type: application/json

{
  "email": "user@company.com",
  "password": "your-password",
  "tenantSlug": "your-tenant"
}

GET /api/v1/sales/leads
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

POST /api/v1/auth/refresh
Content-Type: application/json

{
  "refreshToken": "your-refresh-token"
}

Versioning

The API is versioned via URL path. The current version is v1. All endpoints are prefixed with /api/v1.

Response Format

All responses are JSON. Successful responses follow this structure:

{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully"
}

Error responses include a descriptive message and error code:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": [ ... ]
  }
}

Pagination

List endpoints support offset-based pagination using page and limit query parameters.

GET /api/v1/sales/leads?page=2&limit=25

Paginated responses include metadata:

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 2,
    "limit": 25,
    "total": 142,
    "totalPages": 6
  }
}

Error Codes

Rate Limits

API rate limits are applied per user and per tenant. Specific limits:

When rate-limited, the API returns HTTP 429 with a Retry-After header.

RBAC & Permissions

Intuka uses Role-Based Access Control. Users are assigned permission profiles that determine which endpoints and actions they can access.

sales.view      — View sales records
sales.create    — Create leads, accounts, etc.
sales.edit      — Edit sales records
sales.delete    — Delete sales records
finance.approve — Approve financial documents
hr.manage       — Manage HR records

Custom permission profiles can be created and assigned via the Profiles API.

API Modules

The Intuka API is organized into modules. Click any module to explore its endpoints.