---
id: workflow-plugin-read
title: "Read a plugin"
description: "Returns one plugin descriptor, including its full config schema and examples."
sidebar_label: "Read a plugin"
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcOfGmaKbI7dNjgt/TX0GHtijRFBqTBTIsniQtFauTJjmf4fx+OlGzHdtIO2MMe6hdZ0vHuu+PdxzutBMkqiMm1uHL+tjRuAa3pKm2DuMmEwlB43ZJ2VkzEBVLnbQBnsReCQcD5DLQtTKe0rUBTgLIzBgpnS11BKGpsJEirAO9k0xoMuciEa9FL1v1WiYlY9PbPkuqJR6lEJlrpZYOEnkGuhGYgraRaZMLKBsUkXTLh8a9Oe1RiQr7DTCSjYrIStGxZLpDXthLrfbcu6407rIqR9SjFRNRE7RmrxkBifZOJgEXnNS0jmhlKj/68o1pMrm/4tcfQOhswsOHvx2O+PGhuGz02WjhLaIlXyLY1uoixGf0ZeNnq0B83+xML4hB5jiTpZDTpjnKaog8f4pNXG2MiO1CxDd71EM85+sCIs17jJS+5H7uIudTVxwTtZh9K2qD9DXg4vFujjy56lo/zMUvvADu2wHYN+0NeVxWy141TnUlOFFqhFzf7yXAkWQpJWDm/fByTtoRVyubAq1JVbVZI7+VSZEITNuGImfVeKI/s8v0s+uXjb+8hCUPpPFCNEAjbJwGmSdMUZsYVtzmj0bbt6CHV60y4jh4XwDssOsJ3Tj0aapQFF6Y05pA9rmqkGhPSPv99F9mkQGjRQwQJHCE4mbKmaRaFFZayM/QUnE/CC011fLOonUGYSSpqOJlKY6ZP87RlrZxpo4c8/MpN2NnPa85k1RUYzpJ0JrTCpnWxQm+2ol+jfwgjJ5srugYtyePpth+zd9LfKrewcG8dB0LCp4tf86hTKqX5sTQfdqqPSXAdf5l4/vvvhzz00mi0BOi98zkwK82cWkKQywCLWhIs+PXCO1tNQNokCFMGPM1AQt010p4xS8uZQZgqJKkNv7IqA2dhLo1WCXAptek8hiyeHWjJL+OWu7JEG4+MUqNRj7Bg693MYPPdETYcWC5JHCG3Q/4NJK2SXvVORcdPLt68hB9/Gv8IvS1IHoUMAvo5KpABpg9h4szbpz96gJju43kdIbAMfLp4mwHmVQ5TJsYwGY02p2JYBsImVzgfRdBh+8o6OitdZ9X08Oz61zoieaWQPsZ37x3BRj6QpG434yMbRsrdrHg+fh7JlkP6JdUwwEqlrhUsyj90efVidlW2XTW2gHc6UEjUxptZfAHuxtEwUlhqGwsmjPbURgqIgTlS1fd37YPHwPVxPM8nX87zB0ji4DTnVudx15j2wygU0o4S87MbDYYgqy9EpekCQS3nCMP5D731JTwpnMInYj38MvHDMRb5ZPGuxYJQpSrxPaF8q+Rvlfytkv+XlRx1Uu146KowAo3QdkPbz4CjFbfwa8FjDxd3msE6b3ZyUrY6t50xrZFUOt/khWvuTUqxrUwx2J2XNu6wItHPa3yfhETW/3njfCOJW96ry9jvaFu6XboYBtewM7RMxDh/lo8PNvtFp43KoO1mRoc64w40NizgZtHDTb5yXxp7zF3XttmMttIW88/2s33jOg9aoQzgfCWt/huBah3g/MPbCQucwenpq22qnp6C9Jj610Hd0N6FHF7P0XMXNkeYYeEaDCDBds0MeVNPTz3ONbt4eppBcGAd1XHkDoDMvsYFypPNc6NlwMEeb6SC1nFB+wDkQMKgC06MvkWYGj3H6dMczgvSc0msV1qQrIcNxK4wfQLgCb+fqzhSvcXXcUronfRYOObl6E+MM6c3zJbxmvWEwD0/t4VxAAlpL4yrQq/xIxYeKcTHc+k1t5qs/BaxhcKjQktamiQQkBhzYG3gymF46AMfJ4PWBWqk3Q6n4gKlAtlPJPv5stoeYv/5148++wnvaNQaqSNnxdIauOJ6800kbKZw/jeJ0G8yUbtALLZazWTAT96s1/z4rw55XL2+ycQQs1i3Sgf+r8SklCbgI76eXPQs8hSOfB05inzgWMsMO5em4zuRiVtcDt9o1jw31Sh58mY86dV5UWBLO4sOPn4wmWwY6+fXlzxh3qeQPcqI2o8CWq2SxKW7Rbteb/AR3zPA9fofZHmt0A==
sidebar_class_name: "get api-method"
info_path: docs/api/workflows
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read a plugin"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/workflows/plugins/{name}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



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

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"name","required":true,"schema":{"type":"string"},"description":"The plugin name.","example":"http-request"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The plugin descriptor.","content":{"application/json":{"schema":{"type":"object","properties":{"plugin":{"title":"PluginDescriptor","type":"object","required":["name","version","pluginType","description","configSchema"],"properties":{"name":{"type":"string","example":"http-request"},"version":{"type":"string","example":"1.0.0"},"pluginType":{"type":"string","enum":["trigger","module","decider"]},"description":{"type":"string"},"category":{"type":"string","example":"integrations"},"tags":{"type":"array","items":{"type":"string"}},"configSchema":{"type":"object","description":"JSON Schema for the step's `config` block."},"inputSchema":{"type":"object"},"outputSchema":{"type":"object"},"executeMode":{"type":"string","enum":["each","all"],"description":"Whether the plugin runs once per input item (`each`, the default) or once with the whole batch (`all`)."},"capabilities":{"type":"array","items":{"type":"string"},"example":["produces-items","idempotent"]},"examples":{"type":"array","items":{"type":"object"}},"documentation":{"type":"string","description":"Markdown documentation or a URL."}},"additionalProperties":true}}}}}},"4XX":{"description":"Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>
  
</StatusCodes>