Skip to main content
GET
/
workflows
/
{workflow_id}
[Beta] Get a workflow
curl --request GET \
  --url https://api.open.cx/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "workflow_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "is_active": true,
  "trigger_type": "<string>",
  "version_number": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "workflow_blocks": [
    "<unknown>"
  ],
  "trigger_configuration": "<unknown>",
  "trigger_constraints": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workflow_id
string
required

Response

Default Response

​
id
number
required

Version serial ID

​
workflow_id
string
required

Workflow UUID (groups all versions of the same workflow)

​
name
string
required

Workflow name

​
description
string | null
required

Workflow description

​
is_active
boolean | null
required

Whether this version is currently active

​
trigger_type
string
required

Trigger type: "manual-trigger", "ai-trigger", "cron-trigger", "webhook", "form-trigger", or event-based triggers

​
version_number
number
required

Version number (increments with each edit)

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
workflow_blocks
any[] | null
required

Workflow step/block definitions

​
trigger_configuration
any | null
required

Trigger-specific configuration

​
trigger_constraints
any | null
required

Trigger constraint rules (JSON Logic)