1 General information
2 Get Agile Boards
- 2.1 by Owner
- 2.2 where Owner is inactive user
- 2.3 by Administrator
- 2.4 where any Administrator is inactive user
- 2.5 all boards
- 2.6 where the filter has been removed
3 Get Agile Boards that have the JQL filter removed
4 Change Agile Boards filter
5 Bulk restore Agile Boards with deleted JQL filter
6 Add a message to Agile Boards when owner is deactivated
7 Response informations
8 Pagination

Available since v. 1.14.*

Available since v. 3.6.0 - added new REST API’s

Get Agile Boards where any Administrator is inactive user
Get Agile Boards where Owner is inactive user
Get Agile Boards where the filter has been removed
Change Agile Boards filter

Available since v. 3.11.0 - added new REST API

Add a message to Agile Boards when owner is deactivated

Available since v. 4.28.0 - added new REST API’s

General information

Available ONLY for JIRA administrators

Get Agile Boards

by Owner

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/owner/{JIRA_USER}

where {JIRA_USER} is JIRA user name, like admin

Example URL: {JIRA_URL}/rest/extender/1.0/agileBoard/owner/admin

Response format - check Response informations

where Owner is inactive user

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/inactiveUsers/owner

Response format - check Response informations

by Administrator

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/administrator/{JIRA_USER}

where {JIRA_USER} is JIRA user name, like admin

Example URL: {JIRA_URL}/rest/extender/1.0/agileBoard/administrator/admin

Response format - check Response informations

where any Administrator is inactive user

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/inactiveUsers/administrators

Response format - check Response informations

all boards

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/all

Response format - check Response informations

where the filter has been removed

Agile Boards of this type are not visible from the GUI, because the JQL filter has been removed

If you want to restore these boards, check Change Agile Boards filter

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/withDeletedFilter

Response format - check Response informations

Get Agile Boards that have the JQL filter removed

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/withDeletedFilter

Response format - check Response informations

Change Agile Boards filter

Method type - POST

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/changeFilter

Request format - JSON

Response format - JSON

Example request:

{
    "filterId": 10200,
    "boards": [1, 2]
}

Example response:

{
    "status": "done",
    "message": "filter for Agile Boards has changed"
}

filterId - required - new JQL filter id for boards
boards - required - list of identifiers of boards in which the JQL filter will be replaced

Bulk restore Agile Boards with deleted JQL filter

Method type - POST

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/restoreWithDeletedFilter/newFilter/{FILTER_ID}

where {FILTER_ID} is new JQL filter id

Response format - JSON

Example response:

{
    "status": "done",
    "message": "all boards matching your criteria have been updated"
    "boards": ["2345", "1", "56", "77"]
}

Add a message to Agile Boards when owner is deactivated

Method type - POST

URL: {JIRA_URL}/rest/extender/1.0/agileBoard/setMessage

Request format - JSON

Response format - JSON

Example request:

Example response:

Response informations

Pagination

This REST API uses pagination to improve performance for all Jira users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:

Where:

startAt is the index of the first item returned in the page of results.
maxResults is the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 1000)
total is the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.