Atlassian Jira Filter API

The Atlassian Jira Filter API enables creating, managing, and sharing issue filters within Jira.

OpenAPI Specification

atlassian-rest-api-3-filter--openapi-original.yml Raw ↑
components:
  schemas:
    DefaultShareScope:
      additionalProperties: false
      description: >-
        Details of the scope of the default sharing for new filters and
        dashboards.
      properties:
        scope:
          description: |-
            The scope of the default sharing for new filters and dashboards:

             *  `AUTHENTICATED` Shared with all logged-in users.
             *  `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.
             *  `PRIVATE` Not shared with any users.
          enum:
            - GLOBAL
            - AUTHENTICATED
            - PRIVATE
          type: string
      required:
        - scope
      type: object
      xml:
        name: defaultShareScope
    PageBeanFilterDetails:
      additionalProperties: false
      description: A page of items.
      properties:
        isLast:
          description: Whether this is the last page.
          readOnly: true
          type: boolean
        maxResults:
          description: The maximum number of items that could be returned.
          format: int32
          readOnly: true
          type: integer
        nextPage:
          description: If there is another page of results, the URL of the next page.
          format: uri
          readOnly: true
          type: string
        self:
          description: The URL of the page.
          format: uri
          readOnly: true
          type: string
        startAt:
          description: The index of the first item returned.
          format: int64
          readOnly: true
          type: integer
        total:
          description: The number of items returned.
          format: int64
          readOnly: true
          type: integer
        values:
          description: The list of items.
          items:
            $ref: '#/components/schemas/FilterDetails'
          readOnly: true
          type: array
      type: object
    Filter:
      additionalProperties: false
      description: Details about a filter.
      properties:
        approximateLastUsed:
          description: >-
            \[Experimental\] Approximate last used time. Returns the date and
            time when the filter was last used. Returns `null` if the filter
            hasn't been used after tracking was enabled. For performance
            reasons, timestamps aren't updated in real time and therefore may
            not be exactly accurate.
          format: date-time
          readOnly: true
          type: string
        description:
          description: A description of the filter.
          type: string
        editPermissions:
          description: The groups and projects that can edit the filter.
          items:
            $ref: '#/components/schemas/SharePermission'
          type: array
        favourite:
          description: Whether the filter is selected as a favorite.
          type: boolean
        favouritedCount:
          description: >-
            The count of how many users have selected this filter as a favorite,
            including the filter owner.
          format: int64
          readOnly: true
          type: integer
        id:
          description: The unique identifier for the filter.
          readOnly: true
          type: string
        jql:
          description: >-
            The JQL query for the filter. For example, *project = SSP AND
            issuetype = Bug*.
          type: string
        name:
          description: The name of the filter. Must be unique.
          type: string
        owner:
          allOf:
            - $ref: '#/components/schemas/User'
          description: >-
            The user who owns the filter. This is defaulted to the creator of
            the filter, however Jira administrators can change the owner of a
            shared filter in the admin settings.
          readOnly: true
        searchUrl:
          description: >-
            A URL to view the filter results in Jira, using the [Search for
            issues using JQL](#api-rest-api-3-filter-search-get) operation with
            the filter's JQL string to return the filter results. For example,
            *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.
          format: uri
          readOnly: true
          type: string
        self:
          description: The URL of the filter.
          format: uri
          readOnly: true
          type: string
        sharePermissions:
          description: The groups and projects that the filter is shared with.
          items:
            $ref: '#/components/schemas/SharePermission'
          type: array
        sharedUsers:
          allOf:
            - $ref: '#/components/schemas/UserList'
          description: >-
            A paginated list of the users that the filter is shared with. This
            includes users that are members of the groups or can browse the
            projects that the filter is shared with.
          readOnly: true
        subscriptions:
          allOf:
            - $ref: '#/components/schemas/FilterSubscriptionsList'
          description: A paginated list of the users that are subscribed to the filter.
          readOnly: true
        viewUrl:
          description: >-
            A URL to view the filter results in Jira, using the ID of the
            filter. For example,
            *https://your-domain.atlassian.net/issues/?filter=10100*.
          format: uri
          readOnly: true
          type: string
      required:
        - name
      type: object
      xml:
        name: filter
    SharePermission:
      additionalProperties: false
      description: Details of a share permission for the filter.
      properties:
        group:
          allOf:
            - $ref: '#/components/schemas/GroupName'
          description: >-
            The group that the filter is shared with. For a request, specify the
            `groupId` or `name` property for the group. As a group's name can
            change, use of `groupId` is recommended.
        id:
          description: The unique identifier of the share permission.
          format: int64
          readOnly: true
          type: integer
        project:
          allOf:
            - $ref: '#/components/schemas/Project'
          description: >-
            The project that the filter is shared with. This is similar to the
            project object returned by [Get
            project](#api-rest-api-3-project-projectIdOrKey-get) but it contains
            a subset of the properties, which are: `self`, `id`, `key`,
            `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`,
            `simplified`.  

            For a request, specify the `id` for the project.
        role:
          allOf:
            - $ref: '#/components/schemas/ProjectRole'
          description: >-
            The project role that the filter is shared with.  

            For a request, specify the `id` for the role. You must also specify
            the `project` object and `id` for the project that the role is in.
        type:
          description: |-
            The type of share permission:

             *  `user` Shared with a user.
             *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.
             *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.
             *  `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.
             *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.
             *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.
             *  `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.
          enum:
            - user
            - group
            - project
            - projectRole
            - global
            - loggedin
            - authenticated
            - project-unknown
          type: string
        user:
          allOf:
            - $ref: '#/components/schemas/UserBean'
          description: >-
            The user account ID that the filter is shared with. For a request,
            specify the `accountId` property for the user.
      required:
        - type
      type: object
externalDocs:
  description: Find out more about Atlassian products and services.
  url: http://www.atlassian.com
info:
  contact:
    email: [email protected]
  description: Needs description.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: 'Atlassian rest/api/3/filter/'
  version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
openapi: 3.0.1
paths:
  /rest/api/3/filter/defaultShareScope:
    get:
      deprecated: false
      description: >-
        Returns the default sharing settings for new filters and dashboards for
        a user.<br><br>**[Permissions](#permissions) required:** Permission to
        access Jira.
      operationId: atlassianGetdefaultsharescope
      parameters: []
      responses:
        '200':
          content:
            application/json:
              example: '{"scope":"GLOBAL"}'
              schema:
                $ref: '#/components/schemas/DefaultShareScope'
          description: Returned if the request is successful.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
      security:
        - basicAuth: []
        - OAuth2:
            - read:jira-work
        - {}
      summary: Atlassian Get Default Share Scope
      tags:
        - Filter Sharing
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-atlassian-oauth2-scopes:
        - scheme: OAuth2
          scopes:
            - read:jira-work
          state: Current
        - scheme: OAuth2
          scopes:
            - read:filter.default-share-scope:jira
          state: Beta
      x-atlassian-connect-scope: READ
    put:
      deprecated: false
      description: >-
        Sets the default sharing for new filters and dashboards for a
        user.<br><br>**[Permissions](#permissions) required:** Permission to
        access Jira.
      operationId: atlassianSetdefaultsharescope
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              scope: GLOBAL
            schema:
              $ref: '#/components/schemas/DefaultShareScope'
        required: true
      responses:
        '200':
          content:
            application/json:
              example: '{"scope":"GLOBAL"}'
              schema:
                $ref: '#/components/schemas/DefaultShareScope'
          description: Returned if the request is successful.
        '400':
          description: Returned if an invalid scope is set.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
      security:
        - basicAuth: []
        - OAuth2:
            - write:jira-work
        - {}
      summary: Atlassian Set Default Share Scope
      tags:
        - Filter Sharing
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-atlassian-oauth2-scopes:
        - scheme: OAuth2
          scopes:
            - write:jira-work
          state: Current
        - scheme: OAuth2
          scopes:
            - write:filter.default-share-scope:jira
            - read:filter.default-share-scope:jira
          state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/api/3/filter/favourite:
    get:
      deprecated: false
      description: >-
        Returns the visible favorite filters of the user.<br><br>This operation
        can be accessed anonymously.<br><br>**[Permissions](#permissions)
        required:** A favorite filter is only visible to the user where the
        filter is:<br><br> *  owned by the user.<br> *  shared with a group that
        the user is a member of.<br> *  shared with a private project that the
        user has *Browse projects* [project
        permission](https://confluence.atlassian.com/x/yodKLg) for.<br> *  shared with a public project.<br> *  shared with the public.<br><br>For
        example, if the user favorites a public filter that is subsequently made
        private that filter is not returned by this operation.
      operationId: atlassianGetfavouritefilters
      parameters:
        - description: >-
            Use [expand](#expansion) to include additional information about
            filter in the response. This parameter accepts a comma-separated
            list. Expand options include:

             *  `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]`.
             *  `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]`.
          in: query
          name: expand
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              example: >-
                [{"approximateLastUsed":"2023-03-01T13:15:00.000+0000","description":"Lists
                all open
                bugs","favourite":true,"favouritedCount":0,"id":"10000","jql":"type
                = Bug and resolution is empty","name":"All Open
                Bugs","owner":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":false,"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia
                Krystof","key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","self":"https://your-domain.atlassian.net/rest/api/3/filter/10000","sharePermissions":[],"subscriptions":{"end-index":0,"items":[],"max-results":0,"size":0,"start-index":0},"viewUrl":"https://your-domain.atlassian.net/issues/?filter=10000"},{"approximateLastUsed":null,"description":"Issues
                assigned to
                me","favourite":true,"favouritedCount":0,"id":"10010","jql":"assignee
                = currentUser() and resolution is empty","name":"My
                issues","owner":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":false,"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia
                Krystof","key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty","self":"https://your-domain.atlassian.net/rest/api/3/filter/10010","sharePermissions":[{"id":10000,"type":"global"},{"id":10010,"project":{"avatarUrls":{"16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000","48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"},"id":"10000","insight":{"lastIssueUpdateTime":"2021-04-22T05:37:05.000+0000","totalIssueCount":100},"key":"EX","name":"Example","projectCategory":{"description":"First
                Project
                Category","id":"10000","name":"FIRST","self":"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"},"self":"https://your-domain.atlassian.net/rest/api/3/project/EX","simplified":false,"style":"classic"},"type":"project"}],"subscriptions":{"end-index":0,"items":[],"max-results":0,"size":0,"start-index":0},"viewUrl":"https://your-domain.atlassian.net/issues/?filter=10010"}]
              schema:
                items:
                  $ref: '#/components/schemas/Filter'
                type: array
          description: Returned if the request is successful.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
      security:
        - basicAuth: []
        - OAuth2:
            - read:jira-work
        - {}
      summary: Atlassian Get Favorite Filters
      tags:
        - Filters
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-atlassian-oauth2-scopes:
        - scheme: OAuth2
          scopes:
            - read:jira-work
          state: Current
        - scheme: OAuth2
          scopes:
            - read:filter:jira
            - read:group:jira
            - read:project:jira
            - read:project-role:jira
            - read:user:jira
            - read:jql:jira
            - read:application-role:jira
            - read:avatar:jira
            - read:issue-type-hierarchy:jira
          state: Beta
      x-atlassian-connect-scope: READ
  /rest/api/3/filter/my:
    get:
      deprecated: false
      description: >-
        Returns the filters owned by the user. If `includeFavourites` is `true`,
        the user's visible favorite filters are also
        returned.<br><br>**[Permissions](#permissions) required:** Permission to
        access Jira, however, a favorite filters is only visible to the user
        where the filter is:<br><br> *  owned by the user.<br> *  shared with a
        group that the user is a member of.<br> *  shared with a private project
        that the user has *Browse projects* [project
        permission](https://confluence.atlassian.com/x/yodKLg) for.<br> *  shared with a public project.<br> *  shared with the public.<br><br>For
        example, if the user favorites a public filter that is subsequently made
        private that filter is not returned by this operation.
      operationId: atlassianGetmyfilters
      parameters:
        - description: >-
            Use [expand](#expansion) to include additional information about
            filter in the response. This parameter accepts a comma-separated
            list. Expand options include:

             *  `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]`.
             *  `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]`.
          in: query
          name: expand
          schema:
            type: string
        - description: Include the user's favorite filters in the response.
          in: query
          name: includeFavourites
          schema:
            default: false
            type: boolean
      responses:
        '200':
          content:
            application/json:
              example: >-
                [{"approximateLastUsed":"2023-03-01T13:15:00.000+0000","description":"Lists
                all open
                bugs","favourite":true,"favouritedCount":0,"id":"10000","jql":"type
                = Bug and resolution is empty","name":"All Open
                Bugs","owner":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":false,"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia
                Krystof","key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","self":"https://your-domain.atlassian.net/rest/api/3/filter/10000","sharePermissions":[],"subscriptions":{"end-index":0,"items":[],"max-results":0,"size":0,"start-index":0},"viewUrl":"https://your-domain.atlassian.net/issues/?filter=10000"},{"approximateLastUsed":null,"description":"Issues
                assigned to
                me","favourite":true,"favouritedCount":0,"id":"10010","jql":"assignee
                = currentUser() and resolution is empty","name":"My
                issues","owner":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":false,"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia
                Krystof","key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty","self":"https://your-domain.atlassian.net/rest/api/3/filter/10010","sharePermissions":[{"id":10000,"type":"global"},{"id":10010,"project":{"avatarUrls":{"16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000","48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"},"id":"10000","insight":{"lastIssueUpdateTime":"2021-04-22T05:37:05.000+0000","totalIssueCount":100},"key":"EX","name":"Example","projectCategory":{"description":"First
                Project
                Category","id":"10000","name":"FIRST","self":"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"},"self":"https://your-domain.atlassian.net/rest/api/3/project/EX","simplified":false,"style":"classic"},"type":"project"}],"subscriptions":{"end-index":0,"items":[],"max-results":0,"size":0,"start-index":0},"viewUrl":"https://your-domain.atlassian.net/issues/?filter=10010"}]
              schema:
                items:
                  $ref: '#/components/schemas/Filter'
                type: array
          description: Returned if the request is successful.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
      security:
        - basicAuth: []
        - OAuth2:
            - read:jira-work
        - {}
      summary: Atlassian Get My Filters
      tags:
        - Filters
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
        - scheme: OAuth2
          scopes:
            - read:jira-work
          state: Current
        - scheme: OAuth2
          scopes:
            - read:filter:jira
            - read:group:jira
            - read:project:jira
            - read:project-role:jira
            - read:user:jira
            - read:jql:jira
            - read:application-role:jira
            - read:avatar:jira
            - read:issue-type-hierarchy:jira
          state: Beta
      x-atlassian-connect-scope: READ
  /rest/api/3/filter/search:
    get:
      deprecated: false
      description: >-
        Returns a [paginated](#pagination) list of filters. Use this operation
        to get:<br><br> *  specific filters, by defining `id` only.<br> *  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.<br><br>This operation can be accessed
        anonymously.<br><br>**[Permissions](#permissions) required:** None,
        however, only the following filters that match the query parameters are
        returned:<br><br> *  filters owned by the user.<br> *  filters shared
        with a group that the user is a member of.<br> *  filters shared with a
        private project that the user has *Browse projects* [project
        permission](https://confluence.atlassian.com/x/yodKLg) for.<br> *  filters shared with a public project.<br> *  filters shared with the
        public.
      operationId: atlassianGetfilterspaginated
      parameters:
        - description: String used to perform a case-insensitive partial match with `name`.
          in: query
          name: filterName
          schema:
            type: string
        - description: >-
            User account ID used to return filters with the matching
            `owner.accountId`. This parameter cannot be used with `owner`.
          in: query
          name: accountId
          schema:
            maxLength: 128
            minLength: 0
            type: string
        - 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`.
          in: query
          name: owner
          schema:
            type: string
        - 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.
          in: query
          name: groupname
          schema:
            type: string
        - 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.
          in: query
          name: groupId
          schema:
            type: string
        - description: >-
            Project ID used to returns filters that are shared with a project
            that matches `sharePermissions.project.id`.
          in: query
          name: projectId
          schema:
            format: int64
            type: integer
        - 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.
          in: query
          name: id
          schema:
            items:
              format: int64
              type: integer
            type: array
            uniqueItems: true
        - description: |-
            [Order](#ordering) 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.
          in: query
          name: orderBy
          schema:
            default: name
            enum:
              - description
              - '-description'
              - +description
              - favourite_count
              - '-favourite_count'
              - +favourite_count
              - id
              - '-id'
              - +id
              - is_favourite
              - '-is_favourite'
              - +is_favourite
              - name
              - '-name'
              - +name
              - owner
              - '-owner'
              - +owner
              - is_shared
              - '-is_shared'
              - +is_shared
            type: string
        - description: >-
            The index of the first item to return in a page of results (page
            offset).
          in: query
          name: startAt
          schema:
            default: 0
            format: int64
            type: integer
        - description: The maximum number of items to return per page.
          in: query
          name: maxResults
          schema:
            default: 50
            format: int32
            type: integer
        - description: >-
            Use [expand](#expansion) 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.
             *  `approximateLastUsed` \[Experimental\] Returns the approximate date and time when the filter was last evaluated.
             *  `subscriptions` Returns the users that are subscribed to the filter.
             *  `viewUrl` Returns a URL to view the filter.
          in: query
          name: expand
          schema:
            type: string
        - description: >-
            EXPERIMENTAL: Whether share permissions are overridden to enable
            filters with any s

# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-rest-api-3-filter--openapi-original.yml