Optional
accountOptional
expandUse expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
description
Returns the description of the filter.favourite
Returns an indicator of whether the user has set the filter as a favorite.favouritedCount
Returns a count of how many users have set this filter as a favorite.jql
Returns the JQL query that the filter uses.owner
Returns the owner of the filter.searchUrl
Returns a URL to perform the filter's JQL query.sharePermissions
Returns the share permissions defined for the filter.editPermissions
Returns the edit permissions defined for the filter.isWritable
Returns whether the current user has permission to edit the filter.subscriptions
Returns the users that are subscribed to the filter.viewUrl
Returns a URL to view the filter.Optional
filterString used to perform a case-insensitive partial match with name
.
Optional
groupGroup ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId
. This
parameter cannot be used with the groupname
parameter.
Optional
groupnameAs a group's name can change, use of groupId
is recommended to identify a group. Group name used to returns
filters that are shared with a group that matches sharePermissions.group.groupname
. This parameter cannot be used
with the groupId
parameter.
Optional
idThe list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
. Do not exceed 200 filter IDs.
Optional
isWhen true
this will perform a case-insensitive substring match for the provided filterName
. When false
the
filter name will be searched using full text search
syntax.
Optional
maxThe maximum number of items to return per page.
Optional
orderOrder the results by a field:
description
Sorts by filter description. Note that this sorting works independently of whether the expand to
display the description field is in use.favourite_count
Sorts by the count of how many users have this filter as a favorite.is_favourite
Sorts by whether the filter is marked as a favorite.id
Sorts by filter ID.name
Sorts by filter name.owner
Sorts by the ID of the filter owner.is_shared
Sorts by whether the filter is shared.Optional
overrideEXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
Optional
projectProject ID used to returns filters that are shared with a project that matches sharePermissions.project.id
.
Optional
startThe index of the first item to return in a page of results (page offset).
User account ID used to return filters with the matching
owner.accountId
. This parameter cannot be used withowner
.