Page History

GET /rest/agile/1.0/board

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

Request

Query parameters

maxResults

integer
Format: int32

name

string

projectKeyOrId

string

type

StringList

startAt

integer
Format: int64

Example

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

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

Returned if the request is invalid.

A schema has not been defined for this response code.

Returned if the user is not logged in.

A schema has not been defined for this response code.

POST /rest/agile/1.0/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). 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.

Request

Body parameters

filterId

integer

Format: int64

name

string

type

string

curl --request POST \
  --url 'http://{baseurl}/rest/agile/1.0/board' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

GET /rest/agile/1.0/board/{boardId}

Returns a single board, for a given board Id.

Request

Path parameters

boardId Required

integer
Format: int64

Example

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

GET /rest/agile/1.0/board/{boardId}/backlog

Returns all issues from a board's backlog, for a given board Id.

Request

Path parameters

boardId Required

integer
Format: int64

Query parameters

expand

string

jql

string

maxResults

integer
Format: int32

validateQuery

boolean

fields

Array<StringList>

startAt

integer
Format: int64

Example

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/backlog' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'