API
Drive GoRunner from your own code.
Start here
Common tasks
- Make an API tokenSettings › Workspace › API tokens · 3 min
- Run a workflowStart a run and get its result
- Get a runIts status and each step’s output
- Create a workflowFrom a definition, or blank
- Publish a workflowRequired before a production run
- Create a connection from codeFields, or an OAuth sign-in · 6 min
- Call a workflow’s webhookNo token, and a reply in the same call · 5 min
Look something up: Authentication · Errors · Idempotency · Pagination · OpenAPI, llms.txt and Markdown.
Every endpoint 88
One API that updates in place, with no version in the address. Every endpoint below takes an API token (Authorization: Bearer grt_…), except two that need a person in a browser, Start a sign-in for a connection and Open a sign-in in this tab, and Deliver to a webhook, whose address is its key.
By name, path or method, such as runs or POST.
Workflows 15
- List workflows
GET /api/workflows - List tags
GET /api/workflows/tags - Create a workflow
POST /api/workflows - Check a definition
POST /api/workflows/validate - Import a workflow
POST /api/workflows/import - Preview an import
POST /api/workflows/import/preview - Change many workflows at once
POST /api/workflows/bulk - Get a workflow
GET /api/workflows/{id} - Update a workflow’s draft
PUT /api/workflows/{id} - Delete a workflow
DELETE /api/workflows/{id} - Export a workflow
GET /api/workflows/{id}/export - Set a workflow’s tags
PUT /api/workflows/{id}/tags - Move a workflow to a folder
PUT /api/workflows/{id}/folder - Duplicate a workflow
POST /api/workflows/{id}/duplicate - Convert a Code step to 2.0.0
POST /api/code-steps/upgrade
Publish and versions 9
- List versions
GET /api/workflows/{id}/versions - Publish a workflow
POST /api/workflows/{id}/publish - Review what publishing changes
GET /api/workflows/{id}/publish-review - Unpublish a workflow
POST /api/workflows/{id}/unpublish - Get a new webhook address
POST /api/workflows/{id}/webhook/rotate - List variables
GET /api/workflows/{id}/variables - Replace variables
PUT /api/workflows/{id}/variables - Get a version
GET /api/workflows/{id}/versions/{versionId} - Go back to a version
POST /api/workflows/{id}/versions/{versionId}/restore
Runs 16
- List runs
GET /api/runs - List waiting runs
GET /api/runs/waiting - List a workflow’s runs
GET /api/workflows/{id}/runs - Get a run
GET /api/runs/{id} - Delete a run
DELETE /api/runs/{id} - Stream a run
GET /api/runs/{id}/stream - Cancel a run
POST /api/runs/{id}/cancel - Approve or reject a held run
POST /api/runs/{id}/decision - Delete many runs
POST /api/runs/delete - Run a workflow
POST /api/workflows/{id}/run - Count a workflow’s waiting runs
GET /api/workflows/{id}/runs/waiting - Cancel waiting runs
POST /api/workflows/{id}/runs/cancel-waiting - Run a run again
POST /api/runs/{id}/rerun - Run many runs again
POST /api/runs/rerun - Cancel many runs
POST /api/runs/cancel - Deliver to a webhook
POST /api/webhooks/{token}
Run stats 9
- Group failed runs
GET /api/runs/failures - Runs in flight
GET /api/stats - Run summary with trend
GET /api/stats/summary - The last 7 days
GET /api/stats/week - Overview figures
GET /api/stats/overview - Runs over time
GET /api/stats/timeseries - Count runs by state
GET /api/runs/counts - Summarize a range of runs
GET /api/runs/range - Usual run times
GET /api/runs/usual
Apps 9
- List apps
GET /api/pieces - Catalog status
GET /api/pieces/catalog-status - Get an app
GET /api/pieces/{id} - Get an action’s fields
GET /api/pieces/{id}/actions/{actionId} - Get a trigger’s fields
GET /api/pieces/{id}/triggers/{triggerId} - Get a field’s sub-fields
POST /api/pieces/{id}/actions/{actionId}/properties/{propertyName} - Get a field’s options
POST /api/pieces/{id}/actions/{actionId}/options/{propertyName} - Get a trigger’s sample data
POST /api/pieces/{id}/triggers/{triggerId}/sample - Preview a schedule
POST /api/pieces/schedule/next-runs
Connections 16
- List connections
GET /api/connections - Create a connection
POST /api/connections - See which workflows use each connection
GET /api/connections/usage - Test sign-in details before saving
POST /api/connections/test - Start a sign-in for a new connection
POST /api/connections/oauth2/start - Check a sign-in
GET /api/connections/oauth2/attempts/{attemptId} - Stop a sign-in
POST /api/connections/oauth2/attempts/{attemptId}/cancel - Open a sign-in in this tab
POST /api/connections/oauth2/attempts/{attemptId}/go - Get a connection
GET /api/connections/{id} - Rename or update a connection
PUT /api/connections/{id} - Delete a connection
DELETE /api/connections/{id} - Get a connection’s settings
GET /api/connections/{id}/settings - Test a connection
POST /api/connections/{id}/test - Move workflows to another connection
POST /api/connections/{id}/replace - Start a sign-in for a connection
POST /api/connections/{id}/oauth2/start - Check a connection’s sign-in
GET /api/connections/{id}/oauth2/attempts/{attemptId}
Folders 4
Templates 10
- List templates
GET /api/templates - Save a workflow as a template
POST /api/templates - Count templates
GET /api/templates/count - Preview saving a template
POST /api/templates/save-preview - Get a template
GET /api/templates/{id} - Update a template
PUT /api/templates/{id} - Delete a template
DELETE /api/templates/{id} - Update a template’s steps
PUT /api/templates/{id}/definition - Make a workflow from a template
POST /api/templates/{id}/use - Preview using a template
POST /api/templates/{id}/use/preview