跳到主要内容

Templates

When creating a new workflow, you can choose whether to start with an empty workflow, or use an existing template.

Templates provide:

  • Help getting started: n8n might already have a template that does what you need.
  • Examples of what you can build
  • Best practices for creating your own workflows

Access templates

Select View templates icon Templates to view the templates library.

If you use n8n's template library, this takes you to browse Workflows on the n8n website. If you use a custom library provided by your organization, you'll be able to search and browse the templates within the app.

Add your workflow to the n8n library

n8n is working on a creator program, and developing a marketplace of templates. This is an ongoing project, and details are likely to change.

Self-hosted n8n: Use your own library

In your environment variables, set N8N_TEMPLATES_HOST to the base URL of your API.

Endpoints

Your API must provide the same endpoints and data structure as n8n's.

The endpoints are:

MethodPathPurpose
GET/templates/workflows/Fetch template metadata for preview/browsing
GET/workflows/templates/Fetch workflow data to import onto canvas
GET/templates/searchSearch for workflow templates
GET/templates/collections/Get a specific template collection
GET/templates/collectionsList all template collections
GET/templates/categoriesList all template categories
GET/healthHealth check endpoint

Critical: Two different response formats required

The two workflow endpoints require different response formats :

  • /templates/workflows/ : Returns the template itself, which includes the workflow in the workflow key
  • /workflows/templates/ : Returns the workflow the template contains

See Schemas below for details.

Query parameters

The /templates/search endpoint accepts the following query parameters:

ParameterTypeDescription
pageintegerThe page of results to return
rowsintegerThe maximum number of results to return per page
categorycomma-separated list of strings (categories)The categories to search within
searchstringThe search query

The /templates/collections endpoint accepts the following query parameters:

ParameterTypeDescription
categorycomma-separated list of strings (categories)The categories to search within
searchstringThe search query

Schemas

The key difference between the two workflow endpoints:

 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

|

// GET /templates/workflows/ returns (wrapped):

}
}
}

// GET /workflows/templates/ returns (flat):

}
}

---|---

Detailed schemas for response objects:

Show workflow item data schema

Used by /templates/workflows/ endpoint (wrapped in a workflow key).

This schema describes the template metadata used for displaying templates in search/browse UI. It includes a nested workflow property that contains the actual importable workflow definition.

Workflow item data schema

  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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

|

,
"name": ,
"totalViews": ,
"price": ,
"purchaseUrl": ,
"recentViews": ,
"createdAt": ,
"user": ,
"verified":
},
"required": [
"username",
"verified"
]
},
"nodes": ,
"icon": ,
"name": ,
"codex": ,
"resources": ,
"icon": ,
"label":
},
"required": [
"url",
"label"
]
}
},
"primaryDocumentation":
},
"required": [
"url"
]
}
}
},
"required": [
"primaryDocumentation"
]
},
"categories":
},
"nodeVersion": ,
"codexVersion":
},
"required": [
"categories"
]
}
}
},
"group": ,
"defaults": ,
"color":
},
"required": [
"name"
]
},
"iconData": ,
"type": ,
"fileBuffer":
},
"required": [
"type"
]
},
"displayName": ,
"typeVersion": ,
"nodeCategories": ,
"name":
},
"required": [
"id",
"name"
]
}
}
},
"required": [
"id",
"icon",
"name",
"codex",
"group",
"defaults",
"iconData",
"displayName",
"typeVersion"
]
}
},
"description": ,
"image": ,
"url":
}
}
},
"categories": ,
"name":
}
}
},
"workflowInfo": ,
"nodeTypes":
}
},
"workflow": ,
"connections": ,
"settings": ,
"pinData":
},
"required": [
"nodes",
"connections"
]
}
},
"required": [
"id",
"name",
"totalViews",
"createdAt",
"user",
"nodes",
"workflow"
]
}

Show category item data schema

Category item data schema

 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

|

,
"name":
},
"required": [
"id",
"name"
]
}

Show collection item data schema

Collection item data schema

 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

|

,
"rank": ,
"name": ,
"totalViews": ,
"createdAt": ,
"workflows":
},
"required": [
"id"
]
}
},
"nodes":
}
},
"required": [
"id",
"rank",
"name",
"totalViews",
"createdAt",
"workflows",
"nodes"
]
}

You can also interactively explore n8n's API endpoints:

https://api.n8n.io/templates/categories https://api.n8n.io/templates/collections https://api.n8n.io/templates/search https://api.n8n.io/health

You can contact us for more support.