JQL Filters

Owned by Adam Labus
Last updated: Jun 15, 2024
6 min read

Available since v. 1.5.*

  • Added Pagination

Available since v. 1.22.*

  • Added parameter permissions 

Available since v. 1.23.*

  • Added new api Delete filter API

Available since v. 3.6.*

  • Added new api Get all filters for inactive users

Available since v. 3.20.*

  • Added new api Changing the owner of filters

Available since v. 5.12.*

General information

Available ONLY for Jira Administrators

Get all filters for user

Method type - GET

URL:

  • {JIRA_URL}/rest/extender/1.0/filter/user/{USER_NAME}

  • {JIRA_URL}/rest/extender/1.0/filter/user/{USER_NAME}?permissions=true

where {USER_NAME} is JIRA user name, like admin

Response format - JSON

Example response

{ "startAt" : 0, "maxResults" : 10, "total": 200, "filters": [ { "owner": "admin", "query": "project = 10000 and statusCategory != Done and assignee = EMPTY ORDER BY priority desc", "name": "Open and unassigned (PROJA)", "id": "11000" }, { "owner": "admin", "query": "project = PROJB AND stars = Done", "name": "Done issues in project B", "id": "11100" }] }
{ "startAt" : 0, "maxResults" : 10, "total": 200, "filters": [ { "owner": "admin", "query": "project = 10000 and statusCategory != Done and assignee = EMPTY ORDER BY priority desc", "name": "Open and unassigned (PROJA)", "id": "11000", "permissions": { "isEmpty": false, "isGlobal": false, "isAuthenticated": false, "isPrivate": false, "permissionsMap": [ { "hasViewRights": true, "hasEditRights": false, "id": 10200, "type": "project", "param1": "10100", "param2": null } ] } } ] }

Parameters

  • permissions - optional - (true or empty) - response JSON show all filter permission

 

Get all filters for inactive users

Method type - GET

URL:

  • {JIRA_URL}/rest/extender/1.0/filter/inactiveUsers

  • {JIRA_URL}/rest/extender/1.0/filter/inactiveUsers?permissions=true

Response format - JSON

Example response

{ "startAt" : 0, "maxResults" : 10, "total": 200, "filters": [ { "owner": "admin", "query": "project = 10000 and statusCategory != Done and assignee = EMPTY ORDER BY priority desc", "name": "Open and unassigned (PROJA)", "id": "11000" }, { "owner": "admin", "query": "project = PROJB AND stars = Done", "name": "Done issues in project B", "id": "11100" }] }

Parameters

  • permissions - optional - (true or empty) - response JSON show all filter permission

 

Get all filters

Method type - GET

URL:

  • {JIRA_URL}/rest/extender/1.0/filter/all

  • {JIRA_URL}/rest/extender/1.0/filter/all?permissions=true

Response format - JSON

Example response

Parameters

  • permissions - optional - (true or empty) - response JSON show all filter permission

Delete filters

Method type - DELETE

URL: {JIRA_URL}/rest/extender/1.0/filter/delete

Request format - JSON

Response format - JSON

Example request:

Example response:

 

Changing the owner of filters

Method type - POST

URL: {JIRA_URL}/rest/extender/1.0/ownership/change

Request format - JSON

Example request

Response format - JSON

Example response

You can change the owner of JQL filters dashboards and in one request

 

 

Clear filter permissions

Resets filter permissions to default settings, removes granted edit/view permissions and leaves them solely with the owner.

 

Method type - POST

URL: {JIRA_URL}/rest/rest/extender/1.0/filter/{FILTER_ID}/clearPermissions

  • where {FILTER_ID} is JQL filter id, like 10100

Example URL: {JIRA_URL}/rest/extender/1.0/filter/10100/clearPermissions

Response format - JSON

Example response

 

 

Differences in this API between JIRA versions

Jira 7.2.X - 7.5.X

Jira 7.6.X - 7.11.X

Jira 7.12.X and later

Jira 7.2.X - 7.5.X

Jira 7.6.X - 7.11.X

Jira 7.12.X and later

Parameters not supported

  • hasViewRights

  • hasEditRights

  • isAuthenticated

Parameters not supported

  • hasViewRights

  • hasEditRights

All parameters supported

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.

Example:

  • {JIRA_URL}/rest/extender/1.0/filter/all?startAt=10&maxResults=20

  • {JIRA_URL}/rest/extender/1.0/filter/all?maxResults=1000