{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Filters API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Filters", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Favorite Filters", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/filter/favourite", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." } ] }, "docs": "Returns the visible favorite filters of the user.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** A favorite filter is only visible to the user where the filter is:

* owned by the user.
* shared with a group that the user is a member of.
* shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* shared with a public project.
* shared wit" }, { "info": { "name": "Atlassian Get My Filters", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/filter/my", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." }, { "name": "includeFavourites", "value": "", "type": "query", "description": "Include the user's favorite filters in the response." } ] }, "docs": "Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

**[Permissions](#permissions) required:** Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

* owned by the user.
* shared with a group that the user is a member of.
* shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yod" }, { "info": { "name": "Atlassian Search For Filters", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/filter/search", "params": [ { "name": "filterName", "value": "", "type": "query", "description": "String used to perform a case-insensitive partial match with `name`." }, { "name": "accountId", "value": "", "type": "query", "description": "User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`." }, { "name": "owner", "value": "", "type": "query", "description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with `accountId`." }, { "name": "groupname", "value": "", "type": "query", "description": "As 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." }, { "name": "groupId", "value": "", "type": "query", "description": "Group 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." }, { "name": "projectId", "value": "", "type": "query", "description": "Project ID used to returns filters that are shared with a project that matches `sharePermissions.project.id`." }, { "name": "id", "value": "", "type": "query", "description": "The 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." }, { "name": "orderBy", "value": "", "type": "query", "description": "[Order](#ordering) the results by a field:\n\n * `description` Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use.\n * `favourite_count` Sorts by the count of how many users have this filter as a favorite.\n * `is_favourite` Sorts by whether the filter is marked as a favorite.\n * `id` Sorts by filter ID.\n * `name` Sorts by filter name.\n * `owner` Sorts by the ID of the filter owner.\n * `is_shared` Sorts by whether the filter is shared." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `description` Returns the description of the filter.\n * `favourite` Returns an indicator of whether the user has set the filter as a favorite.\n * `favouritedCount` Returns a count of how many users have set this filter as a favorite.\n * `jql` Returns the JQL query that the filter uses.\n * `owner` Returns the owner of the filter.\n * `searchUrl` Returns a URL to perform the filter's JQL query.\n * `sharePermissions` Returns the share permissions defined for the filter.\n * `editPermissions` Returns the edit permissions defined for the filter.\n * `isWritable` Returns whether the current user has permission to edit the filter.\n * `approximateLastUsed` \\[Experimental\\] Returns the approximate date and time when the filter was last evaluated.\n * `subscriptions` Returns the users that are subscribed to the filter.\n * `viewUrl` Returns a URL to view the filter." }, { "name": "overrideSharePermissions", "value": "", "type": "query", "description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ] }, "docs": "Returns a [paginated](#pagination) list of filters. Use this operation to get:

* specific filters, by defining `id` only.
* 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](#permissions) required:** None, however, only the following filters that" }, { "info": { "name": "Atlassian Get Filter", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/filter/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter to return." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." }, { "name": "overrideSharePermissions", "value": "", "type": "query", "description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ] }, "docs": "Returns a filter.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** None, however, the filter is only returned where it is:

* owned by the user.
* shared with a group that the user is a member of.
* shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* shared with a public project.
* shared with the public." }, { "info": { "name": "Atlassian Update Filter", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/filter/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter to update." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." }, { "name": "overrideSharePermissions", "value": "", "type": "query", "description": "EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

**[Permissions](#permissions) required:** Permission to access Jira, however the user must own the filter." }, { "info": { "name": "Atlassian Delete Filter", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/filter/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter to delete." } ] }, "docs": "Delete a filter.

**[Permissions](#permissions) required:** Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Get Columns", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/filter/:id/columns", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter." } ] }, "docs": "Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** None, however, column details are only returned for:

* 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 project" }, { "info": { "name": "Atlassian Set Columns", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/filter/:id/columns", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`

**[Permissions](#permissions) required:** Permission to access Jira," }, { "info": { "name": "Atlassian Reset Columns", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/filter/:id/columns", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter." } ] }, "docs": "Reset the user's column configuration for the filter to the default.

**[Permissions](#permissions) required:** Permission to access Jira, however, columns are only reset for:

* 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](https://confluence.atlassian.com/x/yodKLg) for.
* filters shared with a public project.
* filters share" }, { "info": { "name": "Atlassian Add Filter As Favorite", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/filter/:id/favourite", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." } ] }, "docs": "Add a filter as a favorite for the user.

**[Permissions](#permissions) required:** Permission to access Jira, however, the user can only favorite:

* 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](https://confluence.atlassian.com/x/yodKLg) for.
* filters shared with a public project.
* filters shared with the public." }, { "info": { "name": "Atlassian Remove Filter As Favorite", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/filter/:id/favourite", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." } ] }, "docs": "Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

**[Permissions](#permissions) required:** Permission to access Jira." }, { "info": { "name": "Atlassian Change Filter Owner", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/filter/:id/owner", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the filter to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the owner of the filter.

**[Permissions](#permissions) required:** Permission to access Jira. However, the user must own the filter or have the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Create Filter", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/filter", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." }, { "name": "overrideSharePermissions", "value": "", "type": "query", "description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.

**[Permissions](#permissions) required:** Permission to access Jira." } ] } ], "bundled": true }