Addons API

Manage addon modules for your workspace. Addons extend Opbox with industry-specific workflows, templates, tables, and metadata fields. Currently available: Corporate Services (CSP) for ADGM & DIFC entity management.

Endpoints

Authorization: All endpoints require authentication. Installing, enabling, disabling, and uninstalling addons require ADMIN or OWNER role.

List Addons

Returns all available addon definitions merged with your workspace's installation status. Uninstalled addons are included with installed: false.

GET /api/addons

Response

{
  "addons": [
    {
      "key": "csp",
      "name": "Corporate Services",
      "tagline": "ADGM & DIFC entity management, compliance, and filings",
      "description": "Full lifecycle management for corporate entities...",
      "icon": "Building2",
      "category": "Compliance",
      "version": "1.0.0",
      "features": ["Entity register", "Stakeholder management", "..."],
      "matterTemplateCount": 15,
      "tableCount": 3,
      "metadataFieldCount": 10,
      "installed": true,
      "status": "ACTIVE",
      "installedAt": "2026-02-15T10:00:00.000Z",
      "installedBy": { "id": "cm...", "name": "Will", "email": "will@example.com" }
    }
  ]
}

Install an Addon

Installs an addon for your workspace. This provisions matter templates, metadata fields, and other resources defined by the addon. If the addon was previously disabled, this re-enables it.

POST /api/addons
Content-Type: application/json

{
  "addonKey": "csp"
}

Body Parameters

Provisioned Resources (CSP)

When the CSP addon is installed, the following resources are automatically created:

Responses

// Response (200)
{
  "success": true
}

// Response (409) - already installed
{
  "error": "Addon is already installed"
}

Get Addon Detail

Returns full addon definition, installation status, and usage stats (if installed). Stats include counts of entities, stakeholders, boards, and matters.

GET /api/addons/:key

Path Parameters

Response

{
  "addon": {
    "key": "csp",
    "name": "Corporate Services",
    "tagline": "ADGM & DIFC entity management, compliance, and filings",
    "description": "Full lifecycle management for corporate entities...",
    "icon": "Building2",
    "category": "Compliance",
    "version": "1.0.0",
    "features": [
      "Entity register with 10+ entity types",
      "Stakeholder management with PEP screening",
      "Cap table with share class tracking",
      "KYC document inventory with expiry monitoring",
      "PINCA filing board (11 types via metadata)",
      "Incorporation workflow templates",
      "Annual renewal tracking",
      "Strike-off procedure templates",
      "Multi-jurisdiction (ADGM & DIFC)",
      "Metadata fields for compliance tracking"
    ],
    "matterTemplateCount": 6,
    "tableCount": 13,
    "metadataFieldCount": 10,
    "installed": true,
    "status": "ACTIVE",
    "installedAt": "2026-02-15T10:00:00.000Z",
    "stats": {
      "entities": 24,
      "stakeholders": 58,
      "boards": 6,
      "matters": 142
    }
  }
}

Enable or Disable an Addon

Toggles an installed addon between ACTIVE and DISABLED states. Disabling hides the addon's UI elements but preserves all data. Enabling restores visibility.

PATCH /api/addons/:key
Content-Type: application/json

// Disable
{ "action": "disable" }

// Enable
{ "action": "enable" }

Body Parameters

Response

// Response (200)
{
  "success": true
}

Uninstall an Addon

Removes the addon installation. You can choose to keep or delete provisioned resources. Matters created from addon templates are never deleted.

DELETE /api/addons/:key
Content-Type: application/json

// Keep provisioned data (templates become user-owned)
{ "keepData": true }

// Delete provisioned data (orphans templates with existing matters)
{ "keepData": false }

Body Parameters

Response

// Response (200)
{
  "success": true
}

Addon Status Values

Available Addons