Retrieve workflow

Endpoint

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

Path Parameters

id string, required

System-generated unique identifier

Query Parameters

user_key string, optional

Unique user identifier

expand array, optional

Expand related objects

Response

Returns successful.

Response Properties

hashid string

System-generated unique identifier

actions_count integer

Number of actions in the workflow

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

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
{
  "hashid": "g0o4y",
  "actions_count": 0,
  "created_at": "2025-07-13T01:01:17-04:00",
  "created_at_string": "Jul 13, 2025 01:01 am EDT",
  "created_at_utc": "2025-07-13T05:01:17Z",
  "default_template": false,
  "description": null,
  "event_trigger": null,
  "event_trigger_draft": null,
  "executions_count": 0,
  "groups": [],
  "has_draft": false,
  "id": "01980228-aea9-7b99-8f7b-3a411ac062e4",
  "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": 600,
    "nodes": [
      {
        "id": "start_of_workflow",
        "type": "Start",
        "name": "Start Workflow"
      }
    ],
    "object": "workflow_layout_template",
    "positions": {
      "start_of_workflow": {
        "x": 450,
        "y": 0
      }
    },
    "width": 1500
  },
  "template_draft": {
    "action_types": [],
    "edges": [],
    "height": 600,
    "nodes": [
      {
        "id": "start_of_workflow",
        "type": "Start",
        "name": "Start Workflow"
      }
    ],
    "object": "workflow_layout_template",
    "positions": {
      "start_of_workflow": {
        "x": 450,
        "y": 0
      }
    },
    "width": 1500
  },
  "trigger_conditions": {},
  "trigger_conditions_draft": {},
  "updated_at": "2025-07-13T01:01:17-04:00",
  "updated_at_string": "Jul 13, 2025 01:01 am EDT",
  "updated_at_utc": "2025-07-13T05:01:17Z"
}