List plugins available to install

4 parameters

categorystringoptional

One of Plugin::CATEGORIES

querystringoptional

Words to find in the plugin name, description or categories

page_sizeintegeroptional

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

cursorstringoptional

Opaque cursor bound to this account and filters

2 status codes

200Success

dataarray<object>optional

401Unauthorized

errorstringoptional

Error handling

A 401 is returned: Unauthorized.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.plugins.list({
  category: "example",
  query: "keyword",
  pageSize: 20,
  cursor: "example",
});

{
  "data": [
    {
      "categories": [
        "example_value"
      ],
      "category": [
        "news"
      ],
      "description": "Current conditions and forecast",
      "form_fields": [
        {
          "default": "example_value",
          "description": "Example description",
          "field_type": "string",
          "help_text": "example_value",
          "keyname": "username",
          "name": "User Name",
          "optional": true,
          "options": "example_value",
          "placeholder": "example_value"
        }
      ],
      "form_type": "form_input",
      "id": 1,
      "image_url": "https://trmnl.com/images/plugins/weather.svg",
      "install_choices": [
        {}
      ],
      "installable": true,
      "keyname": "weather",
      "kind": "official",
      "name": "Weather",
      "oauth": false,
      "plugin_type": "native",
      "refresh_every": 30,
      "requirements": [
        "example_value"
      ],
      "source_revision": "example_value"
    }
  ]
}

Request

Response

Errors