List available custom widgets | Grist Octri Preview

1 status code

200List of widgets

namestringoptional

Widget display name

urlstringoptional

URL to load the widget

widgetIdstringoptional

Unique widget identifier

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.widgets.list();

[
  {
    "name": "Example Name",
    "url": "https://example.com",
    "widgetId": "550e8400-e29b-41d4-a716-446655440000"
  }
]