GoRunner

Get one piece

GET
/api/pieces/{id}

One piece from the SAME source as the list — a piece the fleet cannot run is not fetchable here either.

The default response is the full piece with every action and trigger schema inlined: measured at 13,162 bytes for http, 18 KB for imap. ?view=summary drops every schema and returns what it takes to CHOOSE an operation — each action/trigger's id, name, description, sideEffects, how many input fields it declares, and the discriminators (gate fields, most far-reaching first) worth supplying as query parameters when you then fetch the operation detail. Measured: http 13,162 -> 841 bytes.

ASYMMETRY WITH THE LIST ENDPOINT: here an unrecognised ?view= value is NOT an error — it silently serves the full piece. Only the exact value summary selects the projection.

No ETag is issued for this endpoint (Cache-Control: no-cache and X-GoRunner-Catalog-Source are still set), so If-None-Match has no effect.

A piece's actions describe the DEFAULT version only. actionsByVersion / triggersByVersion carry the operation ids each version declares, which is what a step pinned to an older pieceVersion must be validated against.

Authorization

bearerAuth
AuthorizationBearer <token>

An API token: Authorization: Bearer grt_…. Mint one in the app under Settings → Workspace → API tokens; the raw value is shown once. Scopes confine the token — see x-permission on each operation.

In: header

Path Parameters

id*string

Piece id, exactly as it appears in a workflow step's pieceId (e.g. http, webhook, code, schedule, subflow).

Query Parameters

view?"summary"

summary returns the schema-free projection. Omitted — or any other value — returns the full piece.

Value in

  • "summary"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/pieces/http?view=summary"
{  "data": {    "id": "string",    "name": "string",    "description": "string",    "logoUrl": "string",    "version": "string",    "versions": [      "string"    ],    "icon": "string",    "category": "string",    "nodeType": "action",    "kind": "core",    "actions": [      {        "id": "string",        "name": "string",        "description": "string",        "sideEffects": "pure",        "inputSchema": {          "type": "string",          "properties": {            "property1": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            },            "property2": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            }          },          "required": [            "string"          ]        },        "outputSchema": {          "type": "string",          "properties": {            "property1": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            },            "property2": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            }          },          "required": [            "string"          ]        },        "sampleData": {},        "errorHandling": {          "retryOnFailure": true,          "maxRetries": 0,          "continueOnFailure": true        },        "timeoutSeconds": 0      }    ],    "triggers": [      {        "id": "string",        "name": "string",        "description": "string",        "type": "webhook",        "inputSchema": {          "type": "string",          "properties": {            "property1": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            },            "property2": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            }          },          "required": [            "string"          ]        },        "outputSchema": {          "type": "string",          "properties": {            "property1": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            },            "property2": {              "type": "string",              "title": "string",              "description": "string",              "default": null,              "enum": [                "string"              ],              "enumLabels": {                "property1": "string",                "property2": "string"              },              "format": "string",              "properties": {                "property1": {},                "property2": {}              },              "items": {},              "propertyType": "string",              "placeholder": "string",              "group": "string",              "order": 0,              "required": true,              "minLength": 0,              "maxLength": 0,              "min": 0,              "max": 0,              "pattern": "string",              "refreshers": [                "string"              ],              "refreshOnSearch": true,              "expressionEnabled": true,              "language": "string",              "displayConditions": [                {                  "field": "string",                  "operator": "eq",                  "value": null,                  "values": [                    null                  ]                }              ]            }          },          "required": [            "string"          ]        },        "sampleData": {},        "derivesSample": true      }    ],    "auth": {      "type": "none",      "required": true,      "description": "string",      "fields": [        {          "name": "string",          "title": "string",          "type": "string",          "required": true,          "description": "string"        }      ],      "oauth2": {        "authorizationUrl": "string",        "tokenUrl": "string",        "scopes": [          "string"        ],        "scopeSep": "string",        "authParams": {          "property1": "string",          "property2": "string"        }      }    },    "actionsByVersion": {      "property1": [        "string"      ],      "property2": [        "string"      ]    },    "triggersByVersion": {      "property1": [        "string"      ],      "property2": [        "string"      ]    }  }}