Jira Software Cloud Developer

Jira Software Cloud Developer

Rate this page:

Other operations

Get all boards

GET /rest/agile/1.0/board

Returns all boards. This only includes boards that the user has permission to view.

App scope required: READ

Request

Query parameters
startAt

integer

The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.

Format: int64
maxResults

integer

The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.

Format: int32
type

string

Filters results to boards of the specified types. Valid values: scrum, kanban, simple.

name

string

Filters results to boards that match or partially match the specified name.

projectKeyOrId

string

Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.

accountIdLocation

string

projectLocation

string

includePrivate

boolean

Appends private boards to the end of the list. The name and type fields are excluded for security reasons.

negateLocationFiltering

boolean

If set to true, negate filters used for querying by location. By default false.

orderBy

string

Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.

expand

string

List of fields to expand for each board. Valid values: admins, permissions.

filterId

integer

Filters results to boards that are relevant to a filter. Not supported for next-gen boards.

Format: int64

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/agile/1.0/board' \
  --header 'Accept: application/json'

Responses

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

Content typeValue
application/json

object

Example response (application/json)

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

Rate this page: