API Reference

All Tarasol APIs follow consistent conventions for authentication, request format, and error handling.

Base URL

All API requests go through the Gateway Service:

https://{gateway-host}/api/{service}/{endpoint}

Authentication

All API requests (except login) require a Bearer token:

Authorization: Bearer <access_token>

Tokens are obtained via the Identity Service login endpoint.

Request Headers

Error Response Format

All errors follow a consistent format:

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request",
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

HTTP Status Codes

Pagination

List endpoints support pagination:

GET /api/cms/correspondence?page=1&limit=20&sort=createdAt&order=desc

Service Endpoints

For detailed endpoint documentation, see individual service pages:

• Gateway Service — API routing
• Identity Service — Authentication
• CMS Service — Content management
• Correspondence Service — Correspondence lifecycle
• Task Service — Task management
• Admin Service — User management
• Notification Service — Notifications
• Media Service — File handling
• Search Service — Full-text search
• BI Service — Reports and analytics