plugins_groups_retrieve
GET
/api/plugins/{name}/groups
const url = 'https://example.com/api/plugins/example/groups';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/plugins/example/groups \ --header 'Authorization: Bearer <token>'Retrieve the list of metadata fields groups for a specific plugin.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Query Parameters
Section titled “Query Parameters”include_fields
boolean
If true, include metadata fields for each group
parent
string
Filter groups by parent
Responses
Section titled “Responses”Media typeapplication/json
Serializer for MadbotPlugin.
object
id
required
string
name
required
string
slug
required
string
description
required
string
icon
required
string format: uri
fields
required
object
key
additional properties
settings
required
Array
types
required
Array
statuses
required
object
key
additional properties
metadata_object_types
required
Serializer for MetadataObjectType DTO.
object
name
required
string
slug
required
string
summary_fields
required
Array
priority
required
Array
description
required
string
additional_information
string
show_additional_information_on_data_tab
boolean
minimal_occurrence
required
integer
maximal_occurrence
required
integer
supported_files
required
Array
version
string
Example
{ "metadata_object_types": { "additional_information": "", "show_additional_information_on_data_tab": false }}Media typeapplication/json
object
code
required
string
message
required
string
details
required
Array<object>
object
parameter
string
code
string
message
string
Example
{ "code": "plugin_error", "message": "An error occurred in the plugin. Check the `details` property for more details.", "details": [ { "parameter": "plugin", "message": "Invalid plugin type", "code": "invalid_plugin_type" } ]}Media typeapplication/json
object
code
required
string
message
required
string
details
required
Array<object>
object
parameter
string
code
string
message
string
Example
{ "code": "object_not_found", "message": "Object not found. Check the `details` property for more details.", "details": [ { "parameter": "<id>", "code": "does_not_exist", "message": "\"<id>\" does not exist." } ]}
