Read a plugin and its form fields

form_fields lists what to send updatePluginSettingFields, keyed by the same keyname.

get/api/plugins/{id}

Request

Base URL: https://trmnl.com
URL: https://trmnl.com/api/plugins/{id}
Auth: HTTP bearer

Path parameters

idstring required

Plugin id or keyname

Response

Success

Example response

{
  "data": {
    "id": 1,
    "keyname": "weather",
    "name": "Weather",
    "description": "Current conditions and forecast",
    "category": [
      "news"
    ],
    "plugin_type": "native",
    "form_type": "form_input",
    "image_url": "https://trmnl.com/images/plugins/weather.svg",
    "refresh_every": 30,
    "installable": true,
    "form_fields": [
      {
        "keyname": "username",
        "field_type": "string",
        "name": "User Name"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.