Apis related to boards
Returns all boards. This only includes boards that the user has permission to view.
Deprecation notice: The required OAuth 2.0 scopes will be updated on February 15, 2024.
read:board-scope:jira-software, read:project:jiraread:board-scope:jira-softwareread:project:jiraConnect app scope required: READ
integer
integer
object
string
string
string
string
boolean
boolean
string
Returns the requested boards, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"isLast": false,
"maxResults": 2,
"startAt": 1,
"total": 5,
"values": [
{
"id": 84,
"name": "scrum board",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
"type": "scrum"
},
{
"id": 92,
"name": "kanban board",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
"type": "kanban"
}
]
}Creates a new board. Board name, type and filter ID is required.
name - Must be less than 255 characters.type - Valid values: scrum, kanbanfilterId - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).location - The container that the board will be located in. location must include the type property (Valid values: project, user). If choosing 'project', then a project must be specified by a projectKeyOrId property in location. If choosing 'user', the current user is chosen by default. The projectKeyOrId property should not be provided.Note:
projectTypeKey for software boards must be 'software' and the projectTemplateKey must be either com.pyxis.greenhopper.jira:gh-kanban-template or com.pyxis.greenhopper.jira:gh-scrum-template.write:board-scope:jira-softwareConnect app scope required: WRITE
integer
object
string
string
Returns the created board.
Details about a board.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"filterId": 10040,
"location": {
"projectKeyOrId": "10000",
"type": "project"
},
"name": "scrum board",
"type": "scrum"
}'1
2
3
4
5
6
{
"id": 84,
"name": "scrum board",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
"type": "scrum"
}Returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter.
read:board-scope.admin:jira-softwareConnect app scope required: READ
integer
Requiredinteger
integer
Returns the requested boards, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/filter/{filterId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"id": 84,
"name": "scrum board",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
}Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).
read:board-scope:jira-softwareread:issue-details:jiraConnect app scope required: READ
integer
RequiredReturns the requested board.
Details about a board.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"id": 84,
"location": {
"displayName": "Example Project",
"name": "Example Project",
"projectId": 10040,
"projectKey": "Example Project Key",
"projectName": "Example Project",
"projectTypeKey": "KEY",
"userAccountId": "5b10a2844c20165700ede21g",
"userId": 10040
},
"name": "scrum board",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
"type": "scrum"
}Deletes the board. Admin without the view permission can still remove the board.
write:board-scope:jira-softwareConnect app scope required: DELETE
integer
RequiredReturned if the board has been successfully removed.
1
2
3
curl --request DELETE \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}' \
--header 'Authorization: Bearer <access_token>'Returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
read:board-scope:jira-softwareread:issue-details:jiraConnect app scope required: READ
integer
Requiredinteger
integer
string
boolean
array<object>
string
Returns the requested issues, at the specified page of the results.
The result of a JQL search.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/backlog' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"expand": "names,schema",
"issues": [
{
"expand": "",
"fields": {
"flagged": true,
"sprint": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
},
"closedSprints": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"goal": "sprint 1 goal"
}
],
"description": "example bug report",
"project": {
"avatarUrls": {
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"insight": {
"lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
"totalIssueCount": 100
},
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
},
"self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
"simplified": false,
"style": "classic"
},
"comment": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
}
]
}
]
},
"created": "2021-01-17T12:34:00.000+0000",
"id": "10000",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "Administrators",
"type": "role",
"value": "Administrators"
}
}
],
"epic": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
"worklog": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
],
"updated": 1,
"timetracking": {
"originalEstimate": "10m",
"originalEstimateSeconds": 600,
"remainingEstimate": "3m",
"remainingEstimateSeconds": 200,
"timeSpent": "6m",
"timeSpentSeconds": 400
}
},
"id": "10001",
"key": "HSP-1",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
}
],
"maxResults": 50,
"startAt": 0,
"total": 1
}Get the board configuration. The response contains the following fields:
id - ID of the board.name - Name of the board.filter - Reference to the filter used by the given board.location - Reference to the container that the board is located in. Includes the container type (Valid values: project, user).subQuery (Kanban only) - JQL subquery used by the given board.columnConfig - The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues in that column will be marked as already completed.estimation (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is "field", the ID and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/3/issue/{issueIdOrKey} request, however the fields must be on the screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.ranking - Contains information about custom field used for ranking in the given board.read:board-scope.admin:jira-softwareread:project:jiraConnect app scope required: READ
integer
RequiredReturns the configuration of the board for given boardId.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/configuration' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"columnConfig": {
"columns": [
{
"name": "To Do",
"statuses": [
{
"id": "1",
"self": "https://your-domain.atlassian.net/status/1"
},
{
"id": "4",
"self": "https://your-domain.atlassian.net/status/4"
}
]
},
{
"max": 4,
"min": 2,
"name": "In progress",
"statuses": [
{
"id": "3",
"self": "https://your-domain.atlassian.net/status/3"
}
]
},
{
"name": "Done",
"statuses": [
{
"id": "5",
"self": "https://your-domain.atlassian.net/status/5"
}
]
}
],
"constraintType": "issueCount"
},
"estimation": {
"field": {
"displayName": "Story Points",
"fieldId": "customfield_10002"
},
"type": "field"
},
"filter": {
"id": "1001",
"self": "https://your-domain.atlassian.net/filter/1001"
},
"id": 10000,
"location": {
"id": "10010",
"key": "PROJ",
"name": "name",
"self": "https://your-domain.atlassian.net/rest/api/3/project/10010",
"type": "project"
},
"name": "Board",
"ranking": {
"rankCustomFieldId": 10020
},
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
}Returns all epics from the board, for the given board ID. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.
read:epic:jira-softwareConnect app scope required: READ
integer
Requiredinteger
integer
string
Returns the requested epics, at the specified page of the results.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/epic' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"isLast": false,
"maxResults": 2,
"startAt": 1,
"total": 5,
"values": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/13",
"name": "epic 2",
"summary": "epic 2 summary",
"color": {
"key": "color_2"
},
"done": false
}
]
}Returns all issues that do not belong to any epic on a board, for a given board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
read:epic:jira-softwareread:issue-details:jira, read:jql:jiraConnect app scope required: READ
integer
Requiredinteger
integer
string
boolean
array<object>
string
Returns the requested issues, at the specified page of the results.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/epic/none/issue' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"expand": "names,schema",
"issues": [
{
"expand": "",
"fields": {
"flagged": true,
"sprint": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
},
"closedSprints": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"goal": "sprint 1 goal"
}
],
"description": "example bug report",
"project": {
"avatarUrls": {
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"insight": {
"lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
"totalIssueCount": 100
},
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
},
"self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
"simplified": false,
"style": "classic"
},
"comment": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
}
]
}
]
},
"created": "2021-01-17T12:34:00.000+0000",
"id": "10000",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "Administrators",
"type": "role",
"value": "Administrators"
}
}
],
"epic": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
"worklog": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
],
"updated": 1,
"timetracking": {
"originalEstimate": "10m",
"originalEstimateSeconds": 600,
"remainingEstimate": "3m",
"remainingEstimateSeconds": 200,
"timeSpent": "6m",
"timeSpentSeconds": 400
}
},
"id": "10001",
"key": "HSP-1",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
}
],
"maxResults": 50,
"startAt": 0,
"total": 1
}Returns all issues that belong to an epic on the board, for the given epic ID and the board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
read:epic:jira-softwareread:issue-details:jira, read:jql:jiraConnect app scope required: READ
integer
Requiredinteger
Requiredinteger
integer
string
boolean
array<object>
string
Returns the requested issues, at the specified page of the results.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"expand": "names,schema",
"issues": [
{
"expand": "",
"fields": {
"flagged": true,
"sprint": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
},
"closedSprints": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"goal": "sprint 1 goal"
}
],
"description": "example bug report",
"project": {
"avatarUrls": {
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"insight": {
"lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
"totalIssueCount": 100
},
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
},
"self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
"simplified": false,
"style": "classic"
},
"comment": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
}
]
}
]
},
"created": "2021-01-17T12:34:00.000+0000",
"id": "10000",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "Administrators",
"type": "role",
"value": "Administrators"
}
}
],
"epic": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
"worklog": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
],
"updated": 1,
"timetracking": {
"originalEstimate": "10m",
"originalEstimateSeconds": 600,
"remainingEstimate": "3m",
"remainingEstimateSeconds": 200,
"timeSpent": "6m",
"timeSpentSeconds": 400
}
},
"id": "10001",
"key": "HSP-1",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
}
],
"maxResults": 50,
"startAt": 0,
"total": 1
}read:board-scope.admin:jira-softwareConnect app scope required: READ
integer
Required200 response
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/features' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"features": [
{
"boardFeature": "SIMPLE_ROADMAP",
"boardId": 2154,
"featureId": "<string>",
"featureType": "BASIC",
"imageUri": "<string>",
"learnMoreArticleId": "<string>",
"learnMoreLink": "<string>",
"localisedDescription": "<string>",
"localisedGroup": "<string>",
"localisedName": "<string>",
"permissibleEstimationTypes": [
{
"localisedDescription": "<string>",
"localisedName": "<string>",
"value": "STORY_POINTS"
}
],
"state": "ENABLED",
"toggleLocked": true
}
]
}write:board-scope.admin:jira-softwareConnect app scope required: WRITE
integer
Requiredinteger
boolean
string
200 response
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/features' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"boardId": 2154,
"enabling": true,
"feature": "<string>"
}'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
{
"features": [
{
"boardFeature": "SIMPLE_ROADMAP",
"boardId": 2154,
"featureId": "<string>",
"featureType": "BASIC",
"imageUri": "<string>",
"learnMoreArticleId": "<string>",
"learnMoreLink": "<string>",
"localisedDescription": "<string>",
"localisedGroup": "<string>",
"localisedName": "<string>",
"permissibleEstimationTypes": [
{
"localisedDescription": "<string>",
"localisedName": "<string>",
"value": "STORY_POINTS"
}
],
"state": "ENABLED",
"toggleLocked": true
}
]
}Returns all issues from a board, for a given board ID. This only includes issues that the user has permission to view. An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
read:board-scope:jira-softwareread:issue-details:jiraConnect app scope required: READ
integer
Requiredinteger
integer
string
boolean
array<object>
string
Returns the requested issues, at the specified page of the results.
The result of a JQL search.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/issue' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"expand": "names,schema",
"issues": [
{
"expand": "",
"fields": {
"flagged": true,
"sprint": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
},
"closedSprints": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"goal": "sprint 1 goal"
}
],
"description": "example bug report",
"project": {
"avatarUrls": {
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"insight": {
"lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
"totalIssueCount": 100
},
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
},
"self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
"simplified": false,
"style": "classic"
},
"comment": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
}
]
}
]
},
"created": "2021-01-17T12:34:00.000+0000",
"id": "10000",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "Administrators",
"type": "role",
"value": "Administrators"
}
}
],
"epic": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
"worklog": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
],
"updated": 1,
"timetracking": {
"originalEstimate": "10m",
"originalEstimateSeconds": 600,
"remainingEstimate": "3m",
"remainingEstimateSeconds": 200,
"timeSpent": "6m",
"timeSpentSeconds": 400
}
},
"id": "10001",
"key": "HSP-1",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
}
],
"maxResults": 50,
"startAt": 0,
"total": 1
}Move issues from the backog to the board (if they are already in the backlog of that board).
This operation either moves an issue(s) onto a board from the backlog (by adding it to the issueList for the board) Or transitions the issue(s) to the first column for a kanban board with backlog. At most 50 issues may be moved at once.
write:board-scope:jira-softwareConnect app scope required: WRITE
integer
Requiredarray<string>
string
string
integer
Empty response is returned if operation was successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request POST \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/issue' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"issues": [
"PR-1",
"10001",
"PR-3"
],
"rankBeforeIssue": "PR-4",
"rankCustomFieldId": 10521
}'Returns all projects that are associated with the board, for the given board ID. If the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name.
A project is associated with a board if the board filter contains reference the project or there is an issue from the project that belongs to the board.
The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query project in (ABC, BCD) AND reporter = admin have reference to ABC and BCD projects but query project in (ABC, BCD) OR reporter = admin doesn't have reference to any project.
An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards.
read:board-scope.admin:jira-softwareread:project:jiraConnect app scope required: READ
integer
Requiredinteger
integer
Returns the board's projects, at the specified page of the results.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/project' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"isLast": true,
"maxResults": 10,
"startAt": 0,
"total": 2,
"values": [
{
"avatarUrls": {
"16x16": "secure/projectavatar?size=xsmall&pid=10000",
"24x24": "secure/projectavatar?size=small&pid=10000",
"32x32": "secure/projectavatar?size=medium&pid=10000",
"48x48": "secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "Project category description",
"id": "10000",
"name": "A project category"
},
"projectTypeKey": "ProjectTypeKey{key='software'}",
"self": "project/EX",
"simplified": false
}
]
}Returns all projects that are statically associated with the board, for the given board ID. Returned projects are ordered by the name.
A project is associated with a board if the board filter contains reference the project.
The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query project in (ABC, BCD) AND reporter = admin have reference to ABC and BCD projects but query project in (ABC, BCD) OR reporter = admin doesn't have reference to any project.
read:board-scope.admin:jira-softwareread:project:jiraConnect app scope required: READ
integer
RequiredReturns the board's projects, at the specified page of the results.
1
2
3
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/project/full' \
--header 'Authorization: Bearer <access_token>'Returns the keys of all properties for the board identified by the id. The user who retrieves the property keys is required to have permissions to view the board.
read:board-scope.admin:jira-softwareConnect app scope required: READ
string
RequiredReturned if the board with given id exists.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/properties' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.
read:board-scope.admin:jira-softwareConnect app scope required: READ
string
Requiredstring
RequiredReturned if the board exists and the property was found.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Sets the value of the specified board's property. You can use this resource to store a custom data against the board identified by the id. The user who stores the data is required to have permissions to modify the board.
write:board-scope.admin:jira-softwareConnect app scope required: WRITE
string
Requiredstring
RequiredThe value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes.
any
Returned if the board property is successfully updated.
any
1
2
3
4
5
6
curl --request PUT \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.
delete:board-scope.admin:jira-softwareConnect app scope required: DELETE
string
Requiredstring
RequiredReturned if the board property was removed successfully.
1
2
3
curl --request DELETE \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
--header 'Authorization: Bearer <access_token>'Returns all quick filters from a board, for a given board ID.
read:board-scope.admin:jira-softwareread:jql:jiraConnect app scope required: READ
integer
Requiredinteger
integer
Returns the requested quick filters, at the specified page of the results. Quick filters will be ordered first by position.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/quickfilter' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"isLast": false,
"maxResults": 2,
"startAt": 1,
"total": 5,
"values": [
{
"boardId": 1,
"description": "Issues of type bug",
"id": 1,
"jql": "issueType = bug",
"name": "Bugs",
"position": 0
},
{
"boardId": 1,
"description": "Issues of type task",
"id": 2,
"jql": "issueType = task",
"name": "Tasks",
"position": 0
}
]
}Returns the quick filter for a given quick filter ID. The quick filter will only be returned if the user can view the board that the quick filter belongs to.
read:board-scope.admin:jira-softwareread:jql:jiraConnect app scope required: READ
integer
Requiredinteger
RequiredReturns the requested quick filter.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"boardId": 1,
"description": "Issues of type bug",
"id": 1,
"jql": "issueType = bug",
"name": "Bugs",
"position": 0
}read:board-scope:jira-softwareConnect app scope required: READ
integer
Required200 response
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/reports' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"reports": [
{}
]
}Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.
read:sprint:jira-softwareConnect app scope required: READ
integer
Requiredinteger
integer
object
Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/sprint' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"isLast": false,
"maxResults": 2,
"startAt": 1,
"total": 5,
"values": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"originBoardId": 5,
"goal": "sprint 1 goal"
},
{
"id": 72,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
}
]
}Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.
read:sprint:jira-softwareread:issue-details:jira, read:jql:jiraConnect app scope required: READ
integer
Requiredinteger
Requiredinteger
integer
string
boolean
array<object>
string
Returns the requested issues, at the specified page of the results.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"expand": "names,schema",
"issues": [
{
"expand": "",
"fields": {
"flagged": true,
"sprint": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
},
"closedSprints": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"goal": "sprint 1 goal"
}
],
"description": "example bug report",
"project": {
"avatarUrls": {
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"insight": {
"lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
"totalIssueCount": 100
},
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
},
"self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
"simplified": false,
"style": "classic"
},
"comment": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
}
]
}
]
},
"created": "2021-01-17T12:34:00.000+0000",
"id": "10000",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "Administrators",
"type": "role",
"value": "Administrators"
}
}
],
"epic": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
"worklog": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
],
"updated": 1,
"timetracking": {
"originalEstimate": "10m",
"originalEstimateSeconds": 600,
"remainingEstimate": "3m",
"remainingEstimateSeconds": 200,
"timeSpent": "6m",
"timeSpentSeconds": 400
}
},
"id": "10001",
"key": "HSP-1",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
}
],
"maxResults": 50,
"startAt": 0,
"total": 1
}Returns all versions from a board, for a given board ID. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user.
read:board-scope:jira-softwareConnect app scope required: READ
integer
Requiredinteger
integer
string
Returns the requested versions, at the specified page of the results.
any
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/version' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
{
"isLast": false,
"maxResults": 2,
"startAt": 1,
"total": 5,
"values": [
{
"archived": false,
"description": "A first version",
"id": 10000,
"name": "Version 1",
"projectId": 10000,
"releaseDate": "2015-04-20T01:02:00.000+10:00",
"released": true,
"self": "https://your-domain.atlassian.net/version/10000"
},
{
"archived": false,
"description": "Minor Bugfix version",
"id": 10010,
"name": "Next Version",
"projectId": 10000,
"released": false,
"self": "https://your-domain.atlassian.net/version/10010"
}
]
}Rate this page: