Get issue watchers

v1.0.0

Returns the watchers for an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See for details.

This operation can be accessed anonymously.

required:

Browse projects for the project that the issue is ini
If is configured, issue-level security permission to view the issue.
To see details of users on the watchlist other than themselves, View voters and watchers for the project that the issue is in.

Input

{
  "type": "object",
  "properties": {
    "issueIdOrKey": {
      "type": "string"
    }
  },
  "required": [
    "issueIdOrKey"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The details of watchers on an issue.",
  "properties": {
    "isWatching": {
      "type": "boolean",
      "description": "Whether the calling user is watching this issue."
    },
    "self": {
      "type": "string",
      "description": "The URL of these issue watcher details."
    },
    "watchCount": {
      "type": "integer",
      "format": "int32",
      "description": "The number of users watching this issue."
    },
    "watchers": {
      "type": "array",
      "description": "Details of the users watching this issue.",
      "items": {
        "type": "object",
        "description": "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n *  User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n *  User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n *  User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
        "properties": {
          "accountId": {
            "type": "string",
            "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
          },
          "accountType": {
            "type": "string",
            "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)"
          },
          "active": {
            "type": "boolean",
            "description": "Whether the user is active."
          },
          "avatarUrls": {
            "description": "The avatars of the user.",
            "type": "object"
          },
          "displayName": {
            "type": "string",
            "description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value."
          },
          "emailAddress": {
            "type": "string",
            "description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null."
          },
          "key": {
            "type": "string",
            "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
          },
          "name": {
            "type": "string",
            "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
          },
          "self": {
            "type": "string",
            "description": "The URL of the user."
          },
          "timeZone": {
            "type": "string",
            "description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null."
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}