Get one trigger's schema, narrowed
The trigger-side twin of GET /api/pieces/{id}/actions/{actionId}, with identical narrowing semantics: arbitrary field=value query pairs, filteredBy / ignored / unresolved / conditionalFields bookkeeping, absent-is-not-false requiredness, top-level filtering only. Example: GET /api/pieces/schedule/triggers/schedule?frequency=every_day returns 4 of the trigger's 10 fields.
What a trigger detail does NOT carry: the sideEffects field is always empty here (it is an action-only classification), and the trigger's type (webhook / cron / poll / error / run_finished / callable, always lowercase) is on the piece, not on this projection — read it from GET /api/pieces/{id}.
sampleData here is the trigger's DECLARED example. For triggers whose real payload depends on their configuration (Form, Schedule, Callable) it is generic — use POST /api/pieces/{id}/triggers/{triggerId}/sample to get the derived one.
In a workflow definition the trigger names its trigger id in a field called actionId (not triggerId), and the trigger's configuration goes in config.
Authorization
bearerAuth 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
Piece id (the trigger's pieceId).
Trigger id — the value a definition stores in the trigger's actionId field. A wrong id returns 404 naming every trigger this piece has.
Query Parameters
Reserved key, not interpreted as a gate value.
FREE-FORM PARAMETER SET — send the trigger schema's own property names, e.g. ?frequency=every_day. Never send a literal gateValues key.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/pieces/schedule/triggers/schedule?frequency=every_day"{ "data": { "pieceId": "string", "pieceVersion": "string", "id": "string", "name": "string", "description": "string", "sideEffects": "pure", "inputSchema": { "type": "string", "properties": { "property1": { "type": "string", "description": "string", "default": null, "enum": [ "string" ], "enumLabels": { "property1": "string", "property2": "string" }, "format": "string", "properties": { "property1": {}, "property2": {} }, "items": {}, "propertyType": "string", "required": true, "minLength": 0, "maxLength": 0, "min": 0, "max": 0, "pattern": "string", "refreshers": [ "string" ], "language": "string", "displayConditions": [ { "field": "string", "operator": "eq", "value": null, "values": [ null ] } ] }, "property2": { "type": "string", "description": "string", "default": null, "enum": [ "string" ], "enumLabels": { "property1": "string", "property2": "string" }, "format": "string", "properties": { "property1": {}, "property2": {} }, "items": {}, "propertyType": "string", "required": true, "minLength": 0, "maxLength": 0, "min": 0, "max": 0, "pattern": "string", "refreshers": [ "string" ], "language": "string", "displayConditions": [ { "field": "string", "operator": "eq", "value": null, "values": [ null ] } ] } }, "required": [ "string" ] }, "outputSchema": { "type": "string", "properties": { "property1": { "type": "string", "description": "string", "default": null, "enum": [ "string" ], "enumLabels": { "property1": "string", "property2": "string" }, "format": "string", "properties": { "property1": {}, "property2": {} }, "items": {}, "propertyType": "string", "required": true, "minLength": 0, "maxLength": 0, "min": 0, "max": 0, "pattern": "string", "refreshers": [ "string" ], "language": "string", "displayConditions": [ { "field": "string", "operator": "eq", "value": null, "values": [ null ] } ] }, "property2": { "type": "string", "description": "string", "default": null, "enum": [ "string" ], "enumLabels": { "property1": "string", "property2": "string" }, "format": "string", "properties": { "property1": {}, "property2": {} }, "items": {}, "propertyType": "string", "required": true, "minLength": 0, "maxLength": 0, "min": 0, "max": 0, "pattern": "string", "refreshers": [ "string" ], "language": "string", "displayConditions": [ { "field": "string", "operator": "eq", "value": null, "values": [ null ] } ] } }, "required": [ "string" ] }, "sampleData": {}, "filteredBy": { "property1": "string", "property2": "string" }, "ignored": [ "string" ], "unresolved": [ "string" ], "conditionalFields": [ "string" ], "dynamicFields": [ "string" ] }}