Skip to main content

GET /api/modules/

Retrieves detailed information about a specific module.

Authentication

Requires authentication with valid JWT token.

Path Parameters

id
UUID
required
The unique identifier of the module to retrieve

Response

id
UUID
Unique identifier for the module
name
string
Module name
path
string
Module path
icon
string
Module icon identifier
status
string
Module status (e.g., ACTIVE, INACTIVE)

Status Codes

  • 200 OK - Module found and returned successfully
  • 404 Not Found - Module not found

Example Request

curl -X GET https://api.example.com/api/modules/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "User Management",
  "path": "/users",
  "icon": "users-icon",
  "status": "ACTIVE"
}

Error Response

{
  "timestamp": "2026-03-04T10:30:00Z",
  "status": 404,
  "error": "Not Found",
  "message": "Module not found with id: 550e8400-e29b-41d4-a716-446655440000",
  "path": "/api/modules/550e8400-e29b-41d4-a716-446655440000"
}

Build docs developers (and LLMs) love