Get my filters

v1.0.0

Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

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 for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

Input

{
  "type": "object",
  "properties": {
    "expand": {
      "type": "string"
    },
    "includeFavourites": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "Details about a filter.",
    "required": [
      "name"
    ],
    "properties": {
      "description": {
        "type": "string",
        "description": "A description of the filter."
      },
      "editPermissions": {
        "type": "array",
        "description": "The groups and projects that can edit the filter.",
        "items": {
          "type": "object",
          "description": "Details of a share permission for the filter.",
          "required": [
            "type"
          ],
          "properties": {
            "group": {
              "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.",
              "type": "object"
            },
            "id": {
              "type": "integer",
              "format": "int64",
              "description": "The unique identifier of the share permission."
            },
            "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`.  \nFor a request, specify the `id` for the project.",
              "type": "object"
            },
            "role": {
              "description": "The project role that the filter is shared with.  \nFor 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": "object"
            },
            "type": {
              "type": "string",
              "description": "The type of share permission:\n\n *  `user` Shared with a user.\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `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`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `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"
              ]
            },
            "user": {
              "description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.",
              "type": "object"
            }
          },
          "additionalProperties": false
        }
      },
      "favourite": {
        "type": "boolean",
        "description": "Whether the filter is selected as a favorite."
      },
      "favouritedCount": {
        "type": "integer",
        "format": "int64",
        "description": "The count of how many users have selected this filter as a favorite, including the filter owner."
      },
      "id": {
        "type": "string",
        "description": "The unique identifier for the filter."
      },
      "jql": {
        "type": "string",
        "description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."
      },
      "name": {
        "type": "string",
        "description": "The name of the filter. Must be unique."
      },
      "owner": {
        "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.",
        "type": "object"
      },
      "searchUrl": {
        "type": "string",
        "format": "uri",
        "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*."
      },
      "self": {
        "type": "string",
        "format": "uri",
        "description": "The URL of the filter."
      },
      "sharePermissions": {
        "type": "array",
        "description": "The groups and projects that the filter is shared with.",
        "items": {
          "type": "object",
          "description": "Details of a share permission for the filter.",
          "required": [
            "type"
          ],
          "properties": {
            "group": {
              "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.",
              "type": "object"
            },
            "id": {
              "type": "integer",
              "format": "int64",
              "description": "The unique identifier of the share permission."
            },
            "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`.  \nFor a request, specify the `id` for the project.",
              "type": "object"
            },
            "role": {
              "description": "The project role that the filter is shared with.  \nFor 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": "object"
            },
            "type": {
              "type": "string",
              "description": "The type of share permission:\n\n *  `user` Shared with a user.\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `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`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `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"
              ]
            },
            "user": {
              "description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.",
              "type": "object"
            }
          },
          "additionalProperties": false
        }
      },
      "sharedUsers": {
        "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.",
        "type": "object"
      },
      "subscriptions": {
        "description": "A paginated list of the users that are subscribed to the filter.",
        "type": "object"
      },
      "viewUrl": {
        "type": "string",
        "format": "uri",
        "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*."
      }
    },
    "additionalProperties": false
  }
}