Skip to content

plugins_retrieve

GET
/api/plugins/{name}/
curl --request GET \
--url https://example.com/api/plugins/example/ \
--header 'Authorization: Bearer <token>'

Retrieve a specific plugin by name.

name
required
string
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
"" nullable
show_additional_information_on_data_tab
boolean
minimal_occurrence
required
integer
maximal_occurrence
required
integer
supported_files
required
Array
version
string
nullable

Example

{
"metadata_object_types": {
"additional_information": "",
"show_additional_information_on_data_tab": false
}
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
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."
}
]
}