Cloud

Jira Software Cloud / Reference / REST API

Board

Apis related to boards

Operations

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

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

read:board-scope:jira-software

, read:project:jira

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

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/agile/1.0/board' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

200Response

{
  "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"
    }
  ]
}

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:

If you want to create a new project with an associated board, use the Jira platform REST API. For more information, see the Create project method. The 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.
You can create a filter using the Jira REST API. For more information, see the Create filter method.
If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: WRITE

OAuth 2.0 scopes required:

write:board-scope:jira-software

Request

Request bodyapplication/json

filterId

integer

location

object

name

string

type

string

Responses

Returns the created board.

application/json

object

Details about a board.

POST/rest/agile/1.0/board

curl

Node.js

Java

Python

PHP

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"
}'

201Response

{
  "id": 84,
  "name": "scrum board",
  "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
  "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.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

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}

curl

Node.js

Java

Python

PHP

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'

200Response

{
  "id": 84,
  "name": "scrum board",
  "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
}

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

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

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}

curl

Node.js

Java

Python

PHP

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

200Response

{
  "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"
}

DEL

Delete board

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

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: DELETE

OAuth 2.0 scopes required:

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}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/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.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:

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

curl

Node.js

Java

Python

PHP

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'

200Response