List workflow data fields

Endpoint

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

Path Parameters

id string, required

System-generated unique identifier

Query Parameters

node_id string, optional

Node ID to determine current workflow position

parent_node_id string, optional

Parent node ID to determine workflow position

user_key string, optional

User context for determining available data fields

event_trigger string, optional

Event trigger context for determining available data fields

action_event_trigger string, optional

Action's event trigger context for determining available data fields

type string, optional

Data type filter - can be a single type or multiple types

Response

Returns successful.

Response Properties

collection array

No description available

meta object

No description available

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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "collection": [
    {
      "variable": "changelog_file_path",
      "data_path": "changelog_file_path",
      "display_label": "Changelog file path",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "release_notes_base64",
      "data_path": "release_notes_base64",
      "display_label": "Release Notes Base64",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "github_access_token",
      "data_path": "github_access_token",
      "display_label": "Github Acess Token",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "user_name",
      "data_path": "user['primary']['name']",
      "display_label": "User name",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "zip_code",
      "data_path": "addresses[0]['zip']",
      "display_label": "Zip code",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "title",
      "data_path": "title",
      "display_label": "Title",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    }
  ],
  "meta": {
    "page_limit": null,
    "has_next_page": false,
    "has_previous_page": false
  }
}