The Jira Software Cloud REST API

Get all boards

GET /rest/agile/1.0/board

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

Connect 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

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

400

401

403

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

Content type	Value
application/json	object

Example response (application/json)

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

Search epics

Experimental

GET /rest/agile/1.0/epic/search

Returns searched epics according to provided parameters.

Connect app scope required: READ

Request

Query parameters

maxResults

integer

The maximum number of returned results.

Default: 50, Format: int32

excludeDone

boolean

Flag that will exclude done epics from the results.

Default: false

query

string

Text query by which the results should be filtered.

projectKey

string

Key of a project by which epics will be prioritised (on the top) in the results.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/agile/1.0/epic/search'

Responses

200

401

403

Returned when the search was successful.

A schema has not been defined for this response code.

Get features for project

GET /rest/agile/1.0/project/{projectIdOrKey}/features

Connect app scope required: READ

Request

Path parameters

projectIdOrKey Required

string

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/agile/1.0/project/{projectIdOrKey}/features' \
  --header 'Accept: application/json'

Responses

200

200 response

Content type	Value
application/json	object