Plugin Overview

• Format Form API Response (GET) is a modified version of the official Joget Form API plugin, developed by Relinns Technologies, to address a limitation in the default GET API endpoint.
• In the official Form API, fields containing JSON or array data are often returned as raw strings, which causes parsing challenges in client applications and integrations.
• This plugin resolves the issue by converting stringified JSON and arrays into proper native JSON structures in the API response.

How to Use

1. From the API Builder or app plugin settings, select Format Form API Response (GET) plugin.
2. Set the formDefId (Form Definition ID) that you want to expose.
3. Use the following endpoint to retrieve form data:
4. GET /form/{formDefId}/{recordId}
5. If any field in the form contains a JSON string (e.g., starts with {} or []), the plugin will automatically parse it into valid JSON.
6. You can also use optional query parameters like includeSubformData, flattenData, and includeReferenceElements just like the default plugin.

Versioning

8.0-SNAPSHOT | Date Released: 18 August 2025