Download a custom plugin's API specification
Custom plugins are configured for specific tenants and agreed with your organization. Your team will know if a custom plugin has been enabled for your workspace. For more detailed information and customization, contact sales@tourfold.com.
Plugins that provide persistent tables or managed definitions remain installed once enabled; they cannot be disabled through plugin management. BW and ÖAMTC follow this rule. Plugins without persistent schema can still be enabled and disabled. Installation does not grant additional record permissions.
Each enabled plugin has its own OpenAPI specification. Download it from the relevant workspace so the specification matches the API deployed in that environment.
- Sign in to your Tourfold workspace and open Settings → General.
- Select Features & Plugins, between Workspace and Reset.
- Find the plugin under Plugins and select Download OpenAPI spec beside its name.
The download is a JSON file named tourfold-plugin-<plugin-id>-openapi.json.
Import it into your preferred OpenAPI viewer or client generator. If a download fails, select
the same button to try again.
The authenticated download URL is GET /plugins/{plugin_id}/openapi on the API server for your
environment. Use the identifier of the custom plugin configured for your workspace.
What the file contains​
The document describes that plugin's HTTP operations, request and response schemas, authentication, error responses, and event schemas for the shared event stream. It includes the shared schemas those operations reference. Other plugins' operations and the general Tourfold API are not included; the general API has its own OpenAPI reference and YAML download.
Included external integration operations retain their agreed compatibility rules. The specification
identifies deprecated routes and their current replacements where applicable. A plugin with no
HTTP operations still has a valid OpenAPI document, with an empty paths object.
Only enabled plugins appear in the workspace's list. Downloading requires an authenticated session and the plugin to be enabled for that workspace. Downloading the document does not grant additional API permissions: requests must satisfy the requirements described in the file.
Download a fresh copy after a deployment that changes the plugin API. The document's info.version
identifies the API contract version, not the application's build number.