• Backlog
  • Board
  • Epic
  • Issue
  • Sprint
  • Development Information
  • Feature Flags
  • Deployments
  • Builds
  • Security Information
Cloud
Jira Software Cloud / Reference / REST API

Board

Postman Collection
OpenAPI
GET

Get all 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:jira
Scopes

Connect app scope requiredREAD

Request

Query parameters

startAt

integer

maxResults

integer

type

object

name

string

projectKeyOrId

string

accountIdLocation

string

projectLocation

string

includePrivate

boolean

negateLocationFiltering

boolean

orderBy

string

Responses

Returns the requested boards, at the specified page of the results.

application/json

object
GET/rest/agile/1.0/board
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "maxResults": 2, "startAt": 1, "total": 5, "isLast": false, "values": [ { "id": 84, "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84", "name": "scrum board", "type": "scrum" }, { "id": 92, "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92", "name": "kanban board", "type": "kanban" } ] }
POST

Create board

Creates a new board. Board name, type and filter ID is required.

  • name - Must be less than 255 characters.
  • type - Valid values: scrum, kanban
  • filterId - 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:

Scopes

Connect app scope requiredWRITE

write:board-scope:jira-software

Request

Request bodyapplication/json

name

string

type

string

filterId

integer

location

object

Responses

Returns the created board.

application/json

object

Details about a board.

POST/rest/agile/1.0/board
1 2 3 4 5 6 7 8 9 10 11 12 13 14 curl --request POST \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "filterId": 10040, "name": "scrum board", "location": { "projectKeyOrId": "10000", "type": "project" }, "type": "scrum" }'
201Response
1 2 3 4 5 6 { "id": 84, "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84", "name": "scrum board", "type": "scrum" }
GET

Get board by filter id

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.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software

Request

Path parameters

filterId

integer

Required

Query parameters

startAt

integer

maxResults

integer

Responses

Returns the requested boards, at the specified page of the results.

application/json

object
GET/rest/agile/1.0/board/filter/{filterId}
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/filter/{filterId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "id": 84, "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84", "name": "scrum board" }
GET

Get board

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).

Scopes

Connect app scope requiredREAD

read:board-scope:jira-software
, read:issue-details:jira

Request

Path parameters

boardId

integer

Required

Responses

Returns the requested board.

application/json

object

Details about a board.

GET/rest/agile/1.0/board/{boardId}
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "id": 84, "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84", "name": "scrum board", "type": "scrum", "location": { "projectId": 10040, "userId": 10040, "userAccountId": "5b10a2844c20165700ede21g", "displayName": "Example Project", "projectName": "Example Project", "projectKey": "Example Project Key", "projectTypeKey": "KEY", "name": "Example Project" } }
DEL

Delete board

Deletes the board. Admin without the view permission can still remove the board.

Scopes

Connect app scope requiredDELETE

write:board-scope:jira-software

Request

Path parameters

boardId

integer

Required

Responses

Returned if the board has been successfully removed.

DEL/rest/agile/1.0/board/{boardId}
1 2 3 curl --request DELETE \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}' \ --header 'Authorization: Bearer <access_token>'
GET

Get issues for backlog

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.

Scopes

Connect app scope requiredREAD

read:board-scope:jira-software
, read:issue-details:jira

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

jql

string

validateQuery

boolean

fields

array<object>

expand

string

Responses

Returns the requested issues, at the specified page of the results.

application/json

SearchResults

The result of a JQL search.

GET/rest/agile/1.0/board/{boardId}/backlog
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/backlog' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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", "startAt": 0, "maxResults": 50, "total": 1, "issues": [ { "expand": "", "id": "10001", "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001", "key": "HSP-1", "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": { "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } }, "comment": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "id": "10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "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." } ] } ] }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "created": "2021-01-17T12:34:00.000+0000", "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "role", "value": "Administrators", "identifier": "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": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "comment": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "I did some work here." } ] } ] }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "group", "value": "jira-developers", "identifier": "276f955c-63d7-42c8-9520-92d01dca0625" }, "started": "2021-01-17T12:34:00.000+0000", "timeSpent": "3h 20m", "timeSpentSeconds": 12000, "id": "100028", "issueId": "10002" } ], "updated": 1, "timetracking": { "originalEstimate": "10m", "remainingEstimate": "3m", "timeSpent": "6m", "originalEstimateSeconds": 600, "remainingEstimateSeconds": 200, "timeSpentSeconds": 400 } } } ] }
GET

Get configuration

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.
Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software
, read:project:jira

Request

Path parameters

boardId

integer

Required

Responses

Returns the configuration of the board for given boardId.

application/json

object
GET/rest/agile/1.0/board/{boardId}/configuration
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/configuration' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 { "id": 10000, "name": "Board", "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config", "location": { "type": "project", "key": "PROJ", "id": "10010", "self": "https://your-domain.atlassian.net/rest/api/3/project/10010", "name": "name" }, "filter": { "id": "1001", "self": "https://your-domain.atlassian.net/filter/1001" }, "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" } ] }, { "name": "In progress", "statuses": [ { "id": "3", "self": "https://your-domain.atlassian.net/status/3" } ], "min": 2, "max": 4 }, { "name": "Done", "statuses": [ { "id": "5", "self": "https://your-domain.atlassian.net/status/5" } ] } ], "constraintType": "issueCount" }, "estimation": { "type": "field", "field": { "fieldId": "customfield_10002", "displayName": "Story Points" } }, "ranking": { "rankCustomFieldId": 10020 } }
GET

Get epics

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.

Scopes

Connect app scope requiredREAD

read:epic:jira-software

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

done

string

Responses

Returns the requested epics, at the specified page of the results.

application/json

any

GET/rest/agile/1.0/board/{boardId}/epic
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/epic' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 { "maxResults": 2, "startAt": 1, "total": 5, "isLast": false, "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 } ] }
GET

Get issues without epic for board

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.

Scopes

Connect app scope requiredREAD

read:epic:jira-software
, read:issue-details:jira, read:jql:jira

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

jql

string

validateQuery

boolean

fields

array<object>

expand

string

Responses

Returns the requested issues, at the specified page of the results.

application/json

any

GET/rest/agile/1.0/board/{boardId}/epic/none/issue
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/epic/none/issue' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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", "startAt": 0, "maxResults": 50, "total": 1, "issues": [ { "expand": "", "id": "10001", "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001", "key": "HSP-1", "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": { "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } }, "comment": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "id": "10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "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." } ] } ] }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "created": "2021-01-17T12:34:00.000+0000", "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "role", "value": "Administrators", "identifier": "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": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "comment": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "I did some work here." } ] } ] }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "group", "value": "jira-developers", "identifier": "276f955c-63d7-42c8-9520-92d01dca0625" }, "started": "2021-01-17T12:34:00.000+0000", "timeSpent": "3h 20m", "timeSpentSeconds": 12000, "id": "100028", "issueId": "10002" } ], "updated": 1, "timetracking": { "originalEstimate": "10m", "remainingEstimate": "3m", "timeSpent": "6m", "originalEstimateSeconds": 600, "remainingEstimateSeconds": 200, "timeSpentSeconds": 400 } } } ] }
GET

Get board issues for epic

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.

Scopes

Connect app scope requiredREAD

read:epic:jira-software
, read:issue-details:jira, read:jql:jira

Request

Path parameters

boardId

integer

Required
epicId

integer

Required

Query parameters

startAt

integer

maxResults

integer

jql

string

validateQuery

boolean

fields

array<object>

expand

string

Responses

Returns the requested issues, at the specified page of the results.

application/json

any

GET/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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", "startAt": 0, "maxResults": 50, "total": 1, "issues": [ { "expand": "", "id": "10001", "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001", "key": "HSP-1", "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": { "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } }, "comment": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "id": "10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "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." } ] } ] }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "created": "2021-01-17T12:34:00.000+0000", "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "role", "value": "Administrators", "identifier": "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": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "comment": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "I did some work here." } ] } ] }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "group", "value": "jira-developers", "identifier": "276f955c-63d7-42c8-9520-92d01dca0625" }, "started": "2021-01-17T12:34:00.000+0000", "timeSpent": "3h 20m", "timeSpentSeconds": 12000, "id": "100028", "issueId": "10002" } ], "updated": 1, "timetracking": { "originalEstimate": "10m", "remainingEstimate": "3m", "timeSpent": "6m", "originalEstimateSeconds": 600, "remainingEstimateSeconds": 200, "timeSpentSeconds": 400 } } } ] }
GET

Get features for board

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software

Request

Path parameters

boardId

integer

Required

Responses

200 response

application/json

object
GET/rest/agile/1.0/board/{boardId}/features
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/features' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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, "state": "ENABLED", "localisedName": "<string>", "localisedDescription": "<string>", "learnMoreLink": "<string>", "imageUri": "<string>", "featureType": "BASIC", "localisedGroup": "<string>", "permissibleEstimationTypes": [ { "value": "STORY_POINTS", "localisedName": "<string>", "localisedDescription": "<string>" } ], "featureId": "<string>", "learnMoreArticleId": "<string>", "toggleLocked": true } ] }
PUT

Toggle features

Scopes

Connect app scope requiredWRITE

write:board-scope.admin:jira-software

Request

Path parameters

boardId

integer

Required

Request bodyapplication/json

boardId

integer

feature

string

enabling

boolean

Responses

200 response

application/json

object
PUT/rest/agile/1.0/board/{boardId}/features
1 2 3 4 5 6 7 8 9 10 curl --request PUT \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/features' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "boardId": 2154, "feature": "<string>", "enabling": true }'
200Response
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, "state": "ENABLED", "localisedName": "<string>", "localisedDescription": "<string>", "learnMoreLink": "<string>", "imageUri": "<string>", "featureType": "BASIC", "localisedGroup": "<string>", "permissibleEstimationTypes": [ { "value": "STORY_POINTS", "localisedName": "<string>", "localisedDescription": "<string>" } ], "featureId": "<string>", "learnMoreArticleId": "<string>", "toggleLocked": true } ] }
GET

Get issues for board

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.

Scopes

Connect app scope requiredREAD

read:board-scope:jira-software
, read:issue-details:jira

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

jql

string

validateQuery

boolean

fields

array<object>

expand

string

Responses

Returns the requested issues, at the specified page of the results.

application/json

SearchResults

The result of a JQL search.

GET/rest/agile/1.0/board/{boardId}/issue
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/issue' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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", "startAt": 0, "maxResults": 50, "total": 1, "issues": [ { "expand": "", "id": "10001", "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001", "key": "HSP-1", "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": { "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } }, "comment": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "id": "10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "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." } ] } ] }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "created": "2021-01-17T12:34:00.000+0000", "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "role", "value": "Administrators", "identifier": "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": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "comment": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "I did some work here." } ] } ] }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "group", "value": "jira-developers", "identifier": "276f955c-63d7-42c8-9520-92d01dca0625" }, "started": "2021-01-17T12:34:00.000+0000", "timeSpent": "3h 20m", "timeSpentSeconds": 12000, "id": "100028", "issueId": "10002" } ], "updated": 1, "timetracking": { "originalEstimate": "10m", "remainingEstimate": "3m", "timeSpent": "6m", "originalEstimateSeconds": 600, "remainingEstimateSeconds": 200, "timeSpentSeconds": 400 } } } ] }
POST

Move issues to board

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.

Scopes

Connect app scope requiredWRITE

write:board-scope:jira-software

Request

Path parameters

boardId

integer

Required

Request bodyapplication/json

issues

array<string>

rankBeforeIssue

string

rankAfterIssue

string

rankCustomFieldId

integer

Responses

Empty response is returned if operation was successful.

POST/rest/agile/1.0/board/{boardId}/issue
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --request POST \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/issue' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data '{ "rankBeforeIssue": "PR-4", "rankCustomFieldId": 10521, "issues": [ "PR-1", "10001", "PR-3" ] }'
GET

Get projects

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.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software
, read:project:jira

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

Responses

Returns the board's projects, at the specified page of the results.

application/json

any

GET/rest/agile/1.0/board/{boardId}/project
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/project' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 { "maxResults": 10, "startAt": 0, "total": 2, "isLast": true, "values": [ { "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } }, { "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC", "id": "10001", "key": "ABC", "name": "Alphabetical", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } } ] }
GET

Get projects full

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.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software
, read:project:jira

Request

Path parameters

boardId

integer

Required

Responses

Returns the board's projects, at the specified page of the results.

GET/rest/agile/1.0/board/{boardId}/project/full
1 2 3 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/project/full' \ --header 'Authorization: Bearer <access_token>'
GET

Get board property keys

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.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software

Request

Path parameters

boardId

string

Required

Responses

Returned if the board with given id exists.

application/json

any

GET/rest/agile/1.0/board/{boardId}/properties
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/properties' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
GET

Get board property

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.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software

Request

Path parameters

boardId

string

Required
propertyKey

string

Required

Responses

Returned if the board exists and the property was found.

application/json

any

GET/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
PUT

Set board property

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.

Scopes

Connect app scope requiredWRITE

write:board-scope.admin:jira-software

Request

Path parameters

boardId

string

Required
propertyKey

string

Required

Responses

Returned if the board property is successfully updated.

PUT/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
1 2 3 curl --request PUT \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \ --header 'Authorization: Bearer <access_token>'
DEL

Delete board property

Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.

Scopes

Connect app scope requiredDELETE

delete:board-scope.admin:jira-software

Request

Path parameters

boardId

string

Required
propertyKey

string

Required

Responses

Returned if the board property was removed successfully.

DEL/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
1 2 3 curl --request DELETE \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \ --header 'Authorization: Bearer <access_token>'
GET

Get all quick filters

Returns all quick filters from a board, for a given board ID.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software
, read:jql:jira

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

Responses

Returns the requested quick filters, at the specified page of the results. Quick filters will be ordered first by position.

application/json

object
GET/rest/agile/1.0/board/{boardId}/quickfilter
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/quickfilter' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "maxResults": 2, "startAt": 1, "total": 5, "isLast": false, "values": [ { "id": 1, "boardId": 1, "name": "Bugs", "jql": "issueType = bug", "description": "Issues of type bug", "position": 0 }, { "id": 2, "boardId": 1, "name": "Tasks", "jql": "issueType = task", "description": "Issues of type task", "position": 0 } ] }
GET

Get quick filter

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.

Scopes

Connect app scope requiredREAD

read:board-scope.admin:jira-software
, read:jql:jira

Request

Path parameters

boardId

integer

Required
quickFilterId

integer

Required

Responses

Returns the requested quick filter.

application/json

object
GET/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 { "id": 1, "boardId": 1, "name": "Bugs", "jql": "issueType = bug", "description": "Issues of type bug", "position": 0 }
GET

Get reports for board

Scopes

Connect app scope requiredREAD

read:board-scope:jira-software

Request

Path parameters

boardId

integer

Required

Responses

200 response

application/json

object
GET/rest/agile/1.0/board/{boardId}/reports
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/reports' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "reports": [ {} ] }
GET

Get all sprints

Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.

Scopes

Connect app scope requiredREAD

read:sprint:jira-software

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

state

object

Responses

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.

application/json

any

GET/rest/agile/1.0/board/{boardId}/sprint
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/sprint' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 { "maxResults": 2, "startAt": 1, "total": 5, "isLast": false, "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

Get board issues for sprint

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.

Scopes

Connect app scope requiredREAD

read:sprint:jira-software
, read:issue-details:jira, read:jql:jira

Request

Path parameters

boardId

integer

Required
sprintId

integer

Required

Query parameters

startAt

integer

maxResults

integer

jql

string

validateQuery

boolean

fields

array<object>

expand

string

Responses

Returns the requested issues, at the specified page of the results.

application/json

any

GET/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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", "startAt": 0, "maxResults": 50, "total": 1, "issues": [ { "expand": "", "id": "10001", "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001", "key": "HSP-1", "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": { "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" }, "simplified": false, "style": "classic", "insight": { "totalIssueCount": 100, "lastIssueUpdateTime": "2022-11-15T23:15:20.052+0000" } }, "comment": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "id": "10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "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." } ] } ] }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "created": "2021-01-17T12:34:00.000+0000", "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "role", "value": "Administrators", "identifier": "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": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "comment": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "I did some work here." } ] } ] }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "group", "value": "jira-developers", "identifier": "276f955c-63d7-42c8-9520-92d01dca0625" }, "started": "2021-01-17T12:34:00.000+0000", "timeSpent": "3h 20m", "timeSpentSeconds": 12000, "id": "100028", "issueId": "10002" } ], "updated": 1, "timetracking": { "originalEstimate": "10m", "remainingEstimate": "3m", "timeSpent": "6m", "originalEstimateSeconds": 600, "remainingEstimateSeconds": 200, "timeSpentSeconds": 400 } } } ] }
GET

Get all versions

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.

Scopes

Connect app scope requiredREAD

read:board-scope:jira-software

Request

Path parameters

boardId

integer

Required

Query parameters

startAt

integer

maxResults

integer

released

string

Responses

Returns the requested versions, at the specified page of the results.

application/json

any

GET/rest/agile/1.0/board/{boardId}/version
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.com/rest/agile/1.0/board/{boardId}/version' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 { "maxResults": 2, "startAt": 1, "total": 5, "isLast": false, "values": [ { "self": "https://your-domain.atlassian.net/version/10000", "id": 10000, "projectId": 10000, "name": "Version 1", "description": "A first version", "archived": false, "released": true, "releaseDate": "2015-04-20T01:02:00.000+10:00" }, { "self": "https://your-domain.atlassian.net/version/10010", "id": 10010, "projectId": 10000, "name": "Next Version", "description": "Minor Bugfix version", "archived": false, "released": false } ] }

Rate this page: