List plugins available to install

The published catalog (native and third-party) plus your own third-party plugins at any status. Send a plugin id to createPluginSetting.

get/api/plugins

Request

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

Query parameters

categorystring

One of Plugin::CATEGORIES

querystring

Words to find in the plugin name, description or categories

page_sizeinteger

Selects a cursor page with items and next_cursor instead of the default array

cursorstring

Opaque cursor bound to this account and filters

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.