Retrieve workflow

Endpoint

GET https://embedworkflow.com/api/v1/workflows/{id}

Path Parameters

id string, required

System-generated unique identifier

Query Parameters

id_type string, optional

Type of identifier used in the URL

user_key string, optional

Unique user identifier

expand array, optional

Expand related objects

Response

Returns successful.

Response Properties

id string

Unique identifier

actions_count integer

Number of actions in the workflow

auto_clone_for_new_users boolean

Auto-clone this template for new users (Admin only)

created_at string

Created at in specified timezone

created_at_string string

Created at formatted as human-readable string

created_at_utc string

Created at in UTC

description string

Description of the workflow

event_trigger object

Event trigger configuration

event_trigger_draft object

Draft event trigger configuration

executions_count integer

Number of times workflow has been executed

groups array

Permission groups (Admin only)

has_draft boolean

Whether the workflow has unsaved draft changes

is_template boolean

Mark as template visible in library (Admin only)

key string

Unique key for the workflow

last_published_at string

Last published at in specified timezone

last_published_at_string string

Last published at formatted as human-readable string

last_published_at_utc string

Last published at in UTC

match_conditions object

Conditions for matching workflow execution

match_conditions_draft object

Draft conditions for matching workflow execution

name string

Name of the workflow

object string

Object type identifier

on boolean

Whether the workflow is enabled

stats object

Workflow execution statistics

status string

Current status of the workflow

template object

Published workflow template layout

template_draft object

Draft workflow template layout

trigger_conditions object

Conditions for triggering the workflow

trigger_conditions_draft object

Draft conditions for triggering the workflow

updated_at string

Updated at in specified timezone

updated_at_string string

Updated at formatted as human-readable string

updated_at_utc string

Updated at in UTC

Errors

404 - not found

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
  "id": "019add30-840f-72fe-88e6-43b9dd42bc08",
  "actions_count": 0,
  "auto_clone_for_new_users": false,
  "created_at": "2025-12-01T22:52:15-05:00",
  "created_at_string": "Dec 01, 2025 10:52 pm EST",
  "created_at_utc": "2025-12-02T03:52:15Z",
  "description": null,
  "event_trigger": null,
  "event_trigger_draft": null,
  "executions_count": 0,
  "groups": [],
  "has_draft": false,
  "is_template": false,
  "key": "workflow_12",
  "last_published_at": null,
  "last_published_at_string": null,
  "last_published_at_utc": null,
  "match_conditions": null,
  "match_conditions_draft": null,
  "name": "Workflow 12",
  "object": "workflow",
  "on": false,
  "stats": {},
  "status": "off",
  "template": {
    "action_types": [],
    "edges": [],
    "height": 150,
    "nodes": [
      {
        "id": "start_of_workflow",
        "type": "Start",
        "name": "Start Workflow"
      }
    ],
    "object": "workflow_layout_template",
    "positions": {
      "start_of_workflow": {
        "x": 450,
        "y": 0
      }
    },
    "width": 1200
  },
  "template_draft": {
    "action_types": [],
    "edges": [],
    "height": 150,
    "nodes": [
      {
        "id": "start_of_workflow",
        "type": "Start",
        "name": "Start Workflow"
      }
    ],
    "object": "workflow_layout_template",
    "positions": {
      "start_of_workflow": {
        "x": 450,
        "y": 0
      }
    },
    "width": 1200
  },
  "trigger_conditions": {},
  "trigger_conditions_draft": {},
  "updated_at": "2025-12-01T22:52:15-05:00",
  "updated_at_string": "Dec 01, 2025 10:52 pm EST",
  "updated_at_utc": "2025-12-02T03:52:15Z"
}