Plugin Overview

• Format List API Response (GET) plugin enhances the Joget GET List API by automatically formatting stringified JSON fields into valid JSON objects or arrays.
• In the official List 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.

Prerequisites

• Joget DX 8 or higher

• API Builder installed

How to Use

1. From the API Builder or app plugin settings, select Format List API Response (GET) plugin.

2. Set the listId that you want to expose.

3. Use the following endpoint to retrieve list data:

4. If any field in the list contains a JSON string (e.g., starts with {} or []), the plugin will automatically parse it into valid JSON.

5. You can also use optional query parameters like page, sort, and filter just like the default plugin.

Versioning

8.0-SNAPSHOT | Date Released: 29 August 2025