Agile Boards
General information
Available since v. 1.14.*
Available ONLY for JIRA administrators
Get Agile Boards
by Owner
Method type - GET
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/owner/{JIRA_USER}
where {JIRA_USER} is JIRA user name, like admin
Example URL: {JIRA_URL}/rest/extender/1.0/agileBoard/owner/admin
Response format - check Response informations
by Administrator
Method type - GET
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/administrator/{JIRA_USER}
where {JIRA_USER} is JIRA user name, like admin
Example URL: {JIRA_URL}/rest/extender/1.0/agileBoard/administrator/admin
Response format - check Response informations
all boards
Method type - GET
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/all
Response format - check Response informations
Response informations
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
{
"total": 2,
"maxResults": 1000,
"boards": [
{
"owner": "admin",
"showDaysInColumn": false,
"jqlFilterId": 10003,
"sprintEnabled": true,
"workingDays": [
{
"sunday": false,
"saturday": false,
"tuesday": true,
"nonWorkingDays": [],
"timezone": "defaultTimeZoneId",
"friday": true,
"thursday": true,
"wednesday": true,
"monday": true
}
],
"columns": [
{
"maxInColumn": "",
"minInColumn": "",
"name": "To Do",
"id": 1,
"position": 0,
"status": [
{
"name": "To Do",
"id": 10000,
"position": 0
}
]
},
{
"maxInColumn": "",
"minInColumn": "",
"name": "In Progress",
"id": 2,
"position": 1,
"status": [
{
"name": "In Progress",
"id": 3,
"position": 0
}
]
},
{
"maxInColumn": "",
"minInColumn": "",
"name": "Done",
"id": 3,
"position": 2,
"status": [
{
"name": "Done",
"id": 10001,
"position": 0
}
]
}
],
"cardColor": [],
"subQuery": "",
"cardColorStrategy": "none",
"estimation": [
{
"timeTracking": "remainingEstimateAndTimeSpent",
"estimationStatistic": "storyPoints"
}
],
"cardLayout": [
{
"mode": "backlog",
"id": "components",
"position": 1
},
{
"mode": "active sprint",
"id": "assignee",
"position": 0
}
],
"quickFilter": [
{
"query": "updatedDate >= -1d",
"name": "Recently Updated",
"description": "Displays issues which have been updated in the last day",
"position": 1
},
{
"query": "assignee = admin",
"name": "Quick filter test",
"description": "",
"position": 0
}
],
"kanbanPlanEnabled": false,
"name": "Scrum board",
"swimlane": [
{
"default": true,
"query": "",
"name": "Everything Else",
"description": "",
"position": 0
}
],
"issueDetailView": [
{
"id": "status",
"position": 0
},
{
"id": "priority",
"position": 1
},
{
"id": "components",
"position": 2
},
{
"id": "labels",
"position": 3
},
{
"id": "versions",
"position": 4
},
{
"id": "fixVersions",
"position": 5
},
{
"id": "issuelinks",
"position": 6
},
{
"id": "reporter",
"position": 7
},
{
"id": "assignee",
"position": 8
},
{
"id": "created",
"position": 9
},
{
"id": "updated",
"position": 10
},
{
"id": "customfield_10001",
"position": 11
}
],
"id": 1,
"jqlFilterQuery": "project = AAA ORDER BY Rank ASC",
"admins": [
{
"type": "user",
"key": "admin"
}
],
"swimlaneStrategy": "epic"
},
{
"owner": "admin",
"showDaysInColumn": true,
"jqlFilterId": 10004,
"sprintEnabled": false,
"workingDays": [
{
"sunday": false,
"saturday": false,
"tuesday": true,
"nonWorkingDays": [
"2018-08-29"
],
"timezone": "defaultTimeZoneId",
"friday": true,
"thursday": true,
"wednesday": true,
"monday": true
}
],
"columns": [
{
"maxInColumn": "",
"minInColumn": "",
"name": "To Do",
"id": 4,
"position": 0,
"status": [
{
"name": "To Do",
"id": 10000,
"position": 0
}
]
},
{
"maxInColumn": "",
"minInColumn": "",
"name": "In Progress",
"id": 5,
"position": 1,
"status": [
{
"name": "In Progress",
"id": 3,
"position": 0
}
]
},
{
"maxInColumn": "",
"minInColumn": "",
"name": "Done",
"id": 6,
"position": 2,
"status": [
{
"name": "Done",
"id": 10001,
"position": 0
}
]
}
],
"cardColor": [
{
"color": "#cc0000",
"position": 1,
"user": "unassigned"
},
{
"color": "#ff9933",
"position": 0,
"user": "admin"
}
],
"subQuery": "fixVersion in unreleasedVersions() OR fixVersion is EMPTY",
"cardColorStrategy": "assignee",
"estimation": [
{
"timeTracking": "none",
"estimationStatistic": "none"
}
],
"cardLayout": [
{
"mode": "kanban",
"id": "versions",
"position": 1
},
{
"mode": "kanban",
"id": "assignee",
"position": 0
}
],
"quickFilter": [
{
"query": "assignee = currentUser()",
"name": "Only My Issues",
"description": "Displays issues which are currently assigned to the current user",
"position": 0
},
{
"query": "updatedDate >= -1d",
"name": "Recently Updated",
"description": "Displays issues which have been updated in the last day",
"position": 1
}
],
"kanbanPlanEnabled": false,
"name": "Kanban board",
"swimlane": [
{
"default": false,
"query": "priority = Highest",
"name": "Expedite",
"description": "All issues with the highest priority.",
"position": 0
},
{
"default": true,
"query": "",
"name": "Everything Else",
"description": "",
"position": 1
}
],
"issueDetailView": [
{
"id": "status",
"position": 0
},
{
"id": "priority",
"position": 1
},
{
"id": "components",
"position": 2
},
{
"id": "labels",
"position": 3
},
{
"id": "versions",
"position": 4
},
{
"id": "fixVersions",
"position": 5
},
{
"id": "issuelinks",
"position": 6
},
{
"id": "reporter",
"position": 7
},
{
"id": "assignee",
"position": 8
},
{
"id": "created",
"position": 9
},
{
"id": "updated",
"position": 10
},
{
"id": "customfield_10001",
"position": 11
}
],
"id": 2,
"jqlFilterQuery": "project = AAA ORDER BY Rank ASC",
"admins": [
{
"type": "user",
"key": "admin"
}
],
"swimlaneStrategy": "custom"
}
],
"startAt": 0
}
Pagination
This REST API uses pagination to improve performance for all Jira users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:
1
2
3
4
5
6
7
8
9
10
{
"startAt" : 0,
"maxResults" : 10,
"total": 200,
"boards": [
{ /* result 0 */ },
{ /* result 1 */ },
{ /* result 2 */ }
]
}Where:
startAtis the index of the first item returned in the page of results.maxResultsis the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 1000)totalis the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.