Workflows

Retrieve workflow

Returns a single workflow definition and its dense settings snapshot.

get/api/v1/workflows/{name}

Path parameters

namestring required

Workflow slug or name.

Response

Workflow details

namestring required

slugstring required

descriptionstring required

filenamestring required

graphstring required

Example response

{
  "settings": {
    "run": {
      "environment": {
        "cwd": "/srv/fabro/workspaces/team-a"
      }
    }
  }
}

Changes

Changed in 19 of the 134 revisions of this API.9419

Aug 21, 20261493908ec53f1See the full diff
- ○
  added the optional property settings/run/integrations/github/additional_repositories to the response with the 200 status
  response-optional-property-added
Aug 21, 20264b6d69f0b05a11See the full diff
- ▲
  the settings/run/clone/depth response property's min was decreased from 1.00 to 0.00 for the response status 200
  response-property-min-decreased
- ○
  the depth response's property default value 100 was added for the status 200
  response-property-default-value-added
Aug 21, 202645581b16fce211See the full diff
- ●
  removed the optional property settings/run/integrations/github/additional_repositories from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property settings/run/clone/depth to the response with the 200 status
  response-optional-property-added
Aug 21, 20267c8b8c58f6ca1See the full diff
- ○
  added the optional property settings/run/integrations/github/additional_repositories to the response with the 200 status
  response-optional-property-added
Aug 1, 20266fabbe7d611f11See the full diff
- ▲
  removed the required property settings/run/agent/permissions from the response with the 200 status
  response-required-property-removed
- ○
  added the required property settings/run/agent/fabro_tools to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 30, 2026a43c0a25e7cd1See the full diff
- ○
  added the optional property settings/run/model/controls to the response with the 200 status
  response-optional-property-added
Jul 30, 202678d7c62e137d1See the full diff
- ▲
  the settings/run/model/fallbacks response's property type/format changed from array/ to object/ for status 200
  response-property-type-changed
Jul 28, 2026356da07a11e91See the full diff
- ●
  removed the optional property settings/run/hooks/items/allowed_env_vars from the response with the 200 status
  response-optional-property-removed
Jul 28, 2026148f0a9eb9121See the full diff
- ○
  added the optional property settings/run/hooks/items/allowed_env_vars to the response with the 200 status
  response-optional-property-added
Jul 28, 20263c01c6d3d31e1See the full diff
- ●
  removed the optional property settings/run/hooks/items/allowed_env_vars from the response with the 200 status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (19 revisions)