---
title: "Read a plugin"
method: GET
path: "/workflows/plugins/{name}"
tags: ["Workflow plugins"]
---

# Read a plugin

`GET /workflows/plugins/{name}`

## Request

- Base URL: `https://api.nullplatform.com`
- URL: `https://api.nullplatform.com/workflows/plugins/{name}`
- Auth: HTTP bearer

Returns one plugin descriptor, including its full config schema and examples.

## Path parameters

- `name` string, required

## Response `200`

The plugin descriptor.

- object
  - `plugin` PluginDescriptor
    - `name` string, required
    - `version` string, required
    - `pluginType` 'trigger' | 'module' | 'decider', required
    - `description` string, required
    - `category` string
    - `tags` string[]
    - `configSchema` object, required: JSON Schema for the step's `config` block.
    - `inputSchema` object
    - `outputSchema` object
    - `executeMode` 'each' | 'all': Whether the plugin runs once per input item (`each`, the default) or once with the whole batch (`all`).
    - `capabilities` string[]
    - `examples` object[]
    - `documentation` string: Markdown documentation or a URL.

## Other responses

- `4XX`: Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.
- `5XX`: Unexpected server error.

## Changes

- **2026-09-17** `43b3c1ecdfd8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nullplatform/apis/nullplatform-api/changes/workflows/plugins/:name/get.md)

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) - [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nullplatform/apis/nullplatform-api/revisions/d3f66bc633d4?raw)