Read a plugin and its form fields

1 parameter

idstringrequired

Plugin id or keyname

3 status codes

200Success

dataobjectoptional

401Unauthorized

errorstringoptional

404No plugin matches the id or keyname

Error handling

A 401 is returned: Unauthorized. A 404 is returned: No plugin matches the id or keyname.

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.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "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