GET
/
workflows
/
{workflow_id}
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "actions": {},
  "object": {},
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 123,
  "webhook": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "<string>",
    "secret": "<string>",
    "status": "online",
    "entrypoint_ref": "<string>",
    "filters": {},
    "method": "GET",
    "workflow_id": "<string>",
    "url": "<string>"
  },
  "schedules": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "<string>",
      "status": "online",
      "cron": "<string>",
      "inputs": {},
      "every": "<string>",
      "offset": "<string>",
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z",
      "timeout": 123,
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "entrypoint": "<string>",
  "static_inputs": {},
  "expects": {},
  "returns": "<any>",
  "config": {
    "environment": "default",
    "timeout": 300
  },
  "alias": "<string>",
  "error_handler": "<string>"
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workflow_id
required

Query Parameters

​
workspace_id
string
required

Response

200
application/json
Successful Response
​
id
string
required
​
title
string
required
​
description
string
required
​
status
string
required
​
actions
object
required
​
object
object | null
required
​
owner_id
string
required
​
webhook
object
required
​
schedules
object[]
required
​
entrypoint
string | null
required
​
static_inputs
object
required
​
returns
any
required
​
config
object | null
required

This is the runtime configuration for the workflow.

Activities don't need access to this.

​
version
integer | null
​
expects
object | null
​
alias
string | null
​
error_handler
string | null

Was this page helpful?