Search For Filters
GET {{baseUrl}}/rest/api/3/filter/search?filterName=<string>&accountId=<string>&owner=<string>&groupname=<string>&projectId=<long>&id=<long>&orderBy=name&startAt=0&maxResults=50&expand=<string>
Returns a paginated list of filters. Use this operation to get:
- specific filters, by defining
idonly. - filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.
This operation can be accessed anonymously.
Permissions required: None, however, only the following filters that match the query parameters are returned:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filterName | string | String used to perform a case-insensitive partial match with name. | |
accountId | string | User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner. | |
owner | string | This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId. | |
groupname | string | Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. | |
projectId | string | Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id. | |
id | string | The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. | |
orderBy | string | Order the results by a field: |
-
descriptionSorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. -
favourite_countSorts by the count of how many users have this filter as a favorite. -
is_favouriteSorts by whether the filter is marked as a favorite. -
idSorts by filter ID. -
nameSorts by filter name. -
ownerSorts by the ID of the filter owner. | |startAt| number | | The index of the first item to return in a page of results (page offset). | |maxResults| number | | The maximum number of items to return per page. | |expand| string | | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: -
descriptionReturns the description of the filter. -
favouriteReturns an indicator of whether the user has set the filter as a favorite. -
favouritedCountReturns a count of how many users have set this filter as a favorite. -
jqlReturns the JQL query that the filter uses. -
ownerReturns the owner of the filter. -
searchUrlReturns a URL to perform the filter's JQL query. -
sharePermissionsReturns the share permissions defined for the filter. -
subscriptionsReturns the users that are subscribed to the filter. -
viewUrlReturns a URL to view the filter. |
RESPONSES
status: OK
{"self":"https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=\u0026maxResults=50\u0026filterName=\u0026orderBy=name\u0026startAt=0","maxResults":100,"startAt":0,"total":2,"isLast":true,"values":[{"self":"https://your-domain.atlassian.net/rest/api/3/filter/10000","id":"10000","name":"All Open Bugs","description":"Lists all open bugs","owner":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32"},"displayName":"Mia Krystof","active":false},"jql":"type = Bug and resolution is empty","viewUrl":"https://your-domain.atlassian.net/issues/?filter=10000","searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","favourite":true,"favouritedCount":0,"sharePermissions":[],"subscriptions":[]},{"self":"https://your-domain.atlassian.net/rest/api/3/filter/10010","id":"10010","name":"My issues","description":"Issues assigned to me","owner":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32"},"displayName":"Mia Krystof","active":false},"jql":"assignee = currentUser() and resolution is empty","viewUrl":"https://your-domain.atlassian.net/issues/?filter=10010","searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty","favourite":true,"favouritedCount":0,"sharePermissions":[{"id":10000,"type":"global"},{"id":10010,"type":"project","project":{"self":"https://your-domain.atlassian.net/rest/api/3/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large\u0026pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small\u0026pid=10000","16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall\u0026pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium\u0026pid=10000"},"projectCategory":{"self":"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000","id":"10000","name":"FIRST","description":"First Project Category"},"simplified":false,"style":"classic","insight":{"totalIssueCount":100,"lastIssueUpdateTime":"2020-12-17T01:45:38.377+0000"}}}],"subscriptions":[{"id":1,"user":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","name":"","emailAddress":"mia@example.com","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32"},"displayName":"Mia Krystof","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]},"applicationRoles":{"size":1,"items":[]}}}]}]}