BAbannerbear

Get a workflow

Changed on

Returns the workflow's definition — the inputs it accepts and the steps it runs, in order. Call this before POST /workflow_runs to learn what to send.

get/workflows/{uid}

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Path parameters

uidstring required

Response

Workflow definition

uidstring
namestring
descriptionstring nullable
tagsstring[]
inputsobject

Inputs this workflow accepts, keyed by name. Each value is { type, required }. url-typed inputs are validated as http(s) URLs when a run is created.

ui_write_access'owner_only' | 'team'
api_write_access'team' | 'owner_only' | 'nobody'

Who may run this workflow via the API

created_atstring date-time

Changes