Skip to main content

Export Module

POST/export/workspace/{workspaceId}/modules/{moduleId}

Exports a module, including its definition and optionally the ToolJet Database table schemas it uses.

Path Parameters
workspaceIdstringrequired
The unique identifier of the workspace.
moduleIdstringrequired
The unique identifier of the module to export.
Query Parameters
exportTJDBbooleanoptional
When true, bundles the TJDB table schemas into the export payload.
Error Responses
400
workspaceId or moduleId is not a valid UUID, or module does not exist / does not belong to workspace.
401
Missing or invalid Authorization: Basic token.
451
EXTERNAL_API license not active on the instance.
500
Unexpected failure in the export pipeline.
Request
curl -X POST "https://{your-domain}/api/ext/export/workspace/{workspaceId}/modules/{moduleId}?exportTJDB=<exportTJDB>" -H "Authorization: Basic <access_token>" -H "Content-Type: application/json"
Response — 200
{
"tooljet_database": [],
"app": [
  {
    "definition": {
      "appV2": {
        "name": "User Management Module",
        "type": "module"
      }
    }
  }
],
"tooljet_version": "3.16.0"
}