Jira Integration — ModuleX AI

Field	Description	Required	Format
Client ID	Atlassian OAuth App Client ID	Yes	`-`
Client Secret	Atlassian OAuth App Client Secret	Yes	`-`

add_attachment_to_issue — Adds an attachment to an issue

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

required

A file URL to attach to the issue

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "filename": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Filename"
    },
    "mime_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Mime Type"
    },
    "size": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Size"
    },
    "self_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Self Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddAttachmentToIssueOutput",
  "type": "object"
}

add_comment_to_issue — Adds a new comment to an issue

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

The comment text in plain text (converted to Atlassian Document Format)

object

The comment text in Atlassian Document Format (JSON object). Overrides comment if both provided

object

The group or role to which this comment is visible

string

A JSON array of comment properties

object

Extra properties of any type to include

string

Use ‘renderedBody’ to get comment body rendered in HTML

Response

{
  "$defs": {
    "CommentSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "body": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Body"
        },
        "author": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Author"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        }
      },
      "title": "CommentSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "comment": {
      "anyOf": [
        {
          "$ref": "#/$defs/CommentSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "AddCommentToIssueOutput",
  "type": "object"
}

add_multiple_attachments_to_issue — Adds multiple attachments to an issue

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

array

required

An array of file URLs to attach to the issue. Each element is a string URL

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "attachments": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Attachments",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddMultipleAttachmentsToIssueOutput",
  "type": "object"
}

add_watcher_to_issue — Adds a user as a watcher of an issue by passing the account ID of the user

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

required

The account ID of the user to add as watcher

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddWatcherToIssueOutput",
  "type": "object"
}

assign_issue — Assigns an issue to a user

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

required

The account ID of the user to assign

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "AssignIssueOutput",
  "type": "object"
}

check_issues_against_jql — Checks whether one or more issues would be returned by one or more JQL queries

Parameters

string

required

The cloud ID of the Jira site

array

required

A list of issue IDs to check against the JQL queries. Elements are integers

array

required

A list of JQL query strings to check the issues against

Response

{
  "$defs": {
    "JqlMatchResult": {
      "additionalProperties": false,
      "properties": {
        "issue_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Id"
        },
        "matched_jqls": {
          "items": {
            "type": "string"
          },
          "title": "Matched Jqls",
          "type": "array"
        }
      },
      "title": "JqlMatchResult",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "matches": {
      "items": {
        "$ref": "#/$defs/JqlMatchResult"
      },
      "title": "Matches",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CheckIssuesAgainstJqlOutput",
  "type": "object"
}

count_issues_using_jql — Provides an estimated count of the issues that match a JQL query

Parameters

string

required

The cloud ID of the Jira site

string

required

The JQL query to count issues. Must be bounded (e.g. project = ABC)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Count"
    }
  },
  "required": [
    "success"
  ],
  "title": "CountIssuesUsingJqlOutput",
  "type": "object"
}

create_custom_field_options_context — Creates a context for custom field options

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the custom field

string

required

The ID of the field context

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "options": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Options",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateCustomFieldOptionsContextOutput",
  "type": "object"
}

create_future_sprint — Creates a future sprint

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the board the sprint will be created on

string

required

The name of the sprint

string

The goal of the sprint

string

The start date in ISO 8601 format (e.g. 2024-01-01T00:00:00.000Z)

string

The end date in ISO 8601 format (e.g. 2024-01-15T00:00:00.000Z)

Response

{
  "$defs": {
    "SprintSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "State"
        },
        "start_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Date"
        },
        "end_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "End Date"
        },
        "complete_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Complete Date"
        },
        "goal": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Goal"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "SprintSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "sprint": {
      "anyOf": [
        {
          "$ref": "#/$defs/SprintSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateFutureSprintOutput",
  "type": "object"
}

create_issue — Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask

Parameters

string

required

The cloud ID of the Jira site

string

required

The project ID

string

required

The issue type ID

boolean

Whether the project is added to the user’s Recently viewed project list

object

Additional issue history details

string

Details of issue properties to add or update (JSON array)

object

A map of field name to operations list for issue screen fields

object

Extra fields to include in the issue body (e.g. summary, description, labels, priority)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key"
    },
    "self_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Self Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateIssueOutput",
  "type": "object"
}

create_version — Creates a project version

Parameters

string

required

The cloud ID of the Jira site

string

required

The project ID

string

required

The unique name of the version. Max 255 characters

string

The description of the version

boolean

Indicates that the version is archived

string

The start date (yyyy-mm-dd)

string

The release date (yyyy-mm-dd)

string

Expand options: operations, issuesstatus

Response

{
  "$defs": {
    "VersionSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "archived": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Archived"
        },
        "released": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Released"
        },
        "start_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Date"
        },
        "release_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Release Date"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "VersionSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "version": {
      "anyOf": [
        {
          "$ref": "#/$defs/VersionSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateVersionOutput",
  "type": "object"
}

delete_project — Deletes a project

Parameters

string

required

The cloud ID of the Jira site

string

required

The project ID or key

boolean

required

Whether this project is placed in the Jira recycle bin for recovery

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteProjectOutput",
  "type": "object"
}

get_all_projects — Gets metadata on all projects

Parameters

string

required

The cloud ID of the Jira site

integer

Returns the user’s most recently accessed projects (max 20)

string

Issue properties to include (JSON array)

string

Expand options: description, issueTypes, lead, projectKeys

Response

{
  "$defs": {
    "ProjectSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "project_type_key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Project Type Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "ProjectSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "projects": {
      "items": {
        "$ref": "#/$defs/ProjectSummary"
      },
      "title": "Projects",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetAllProjectsOutput",
  "type": "object"
}

get_board — Returns the board for the given board ID

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the board

Response

{
  "$defs": {
    "BoardSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "board_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Board Type"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "BoardSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "board": {
      "anyOf": [
        {
          "$ref": "#/$defs/BoardSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetBoardOutput",
  "type": "object"
}

get_cloud_id — Gets the cloud ID and details of all accessible Jira Cloud sites

Response

{
  "$defs": {
    "CloudSite": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "scopes": {
          "items": {
            "type": "string"
          },
          "title": "Scopes",
          "type": "array"
        },
        "avatar_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Avatar Url"
        }
      },
      "title": "CloudSite",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "sites": {
      "items": {
        "$ref": "#/$defs/CloudSite"
      },
      "title": "Sites",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetCloudIdOutput",
  "type": "object"
}

get_current_user — Returns the authenticated Jira user's account ID, display name, email, and active status

Parameters

string

required

The cloud ID of the Jira site

Response

{
  "$defs": {
    "UserSummary": {
      "additionalProperties": false,
      "properties": {
        "account_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "email_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Address"
        },
        "active": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Active"
        },
        "avatar_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Avatar Url"
        },
        "account_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Type"
        }
      },
      "title": "UserSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "user": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetCurrentUserOutput",
  "type": "object"
}

get_issue — Gets the details for an issue

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

Comma-separated list of fields to return. *all or *navigable for all or navigable fields

boolean

Whether fields are referenced by keys rather than IDs

string

Issue properties to include (comma-separated or *all)

boolean

Whether project is added to Recently viewed

string

Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issue": {
      "anyOf": [
        {
          "$ref": "#/$defs/IssueSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetIssueOutput",
  "type": "object"
}

get_issue_picker_suggestions — Returns lists of issues matching a query string

Parameters

string

required

The cloud ID of the Jira site

string

A string to match against issue text fields

string

A JQL query defining a list of issues to search within

string

The key of an issue to exclude from results

string

The ID of a project that results must belong to

boolean

Whether to include subtasks in suggestions

boolean

Whether to include the parent issue when currentIssueKey is a subtask

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    },
    "SuggestionSection": {
      "additionalProperties": false,
      "properties": {
        "label": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Label"
        },
        "issues": {
          "items": {
            "$ref": "#/$defs/IssueSummary"
          },
          "title": "Issues",
          "type": "array"
        }
      },
      "title": "SuggestionSection",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "sections": {
      "items": {
        "$ref": "#/$defs/SuggestionSection"
      },
      "title": "Sections",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetIssuePickerSuggestionsOutput",
  "type": "object"
}

get_issue_types — Gets the available issue types, optionally filtered by project

Parameters

string

required

The cloud ID of the Jira site

string

The project ID to filter issue types

Response

{
  "$defs": {
    "IssueTypeSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "subtask": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subtask"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "IssueTypeSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issue_types": {
      "items": {
        "$ref": "#/$defs/IssueTypeSummary"
      },
      "title": "Issue Types",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetIssueTypesOutput",
  "type": "object"
}

get_sprint — Returns the sprint for a given sprint ID

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the sprint

Response

{
  "$defs": {
    "SprintSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "State"
        },
        "start_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Date"
        },
        "end_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "End Date"
        },
        "complete_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Complete Date"
        },
        "goal": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Goal"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "SprintSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "sprint": {
      "anyOf": [
        {
          "$ref": "#/$defs/SprintSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSprintOutput",
  "type": "object"
}

get_task — Gets the status of a long-running asynchronous task

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the long-running async task

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "progress": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Progress"
    },
    "result": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    },
    "task_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetTaskOutput",
  "type": "object"
}

get_transitions — Gets either all transitions or a transition that can be performed by the user on an issue

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

The ID of a specific transition to retrieve

boolean

Whether transitions with Hide From User Condition are included

boolean

Whether details of failing-condition transitions are included

boolean

Whether transitions are sorted by ops-bar sequence then category

string

Expand options: transitions.fields

Response

{
  "$defs": {
    "TransitionSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "to_status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "To Status"
        },
        "has_screen": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Has Screen"
        }
      },
      "title": "TransitionSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "transitions": {
      "items": {
        "$ref": "#/$defs/TransitionSummary"
      },
      "title": "Transitions",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetTransitionsOutput",
  "type": "object"
}

get_user — Gets details of a user

Parameters

string

required

The cloud ID of the Jira site

string

required

The account ID of the user

string

Expand options: groups, applicationRoles

Response

{
  "$defs": {
    "UserSummary": {
      "additionalProperties": false,
      "properties": {
        "account_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "email_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Address"
        },
        "active": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Active"
        },
        "avatar_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Avatar Url"
        },
        "account_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Type"
        }
      },
      "title": "UserSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "user": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetUserOutput",
  "type": "object"
}

get_users — Gets the details for a list of users

Parameters

string

required

The cloud ID of the Jira site

string

Filter for a name or term

Response

{
  "$defs": {
    "UserSummary": {
      "additionalProperties": false,
      "properties": {
        "account_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "email_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Address"
        },
        "active": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Active"
        },
        "avatar_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Avatar Url"
        },
        "account_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Type"
        }
      },
      "title": "UserSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "users": {
      "items": {
        "$ref": "#/$defs/UserSummary"
      },
      "title": "Users",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetUsersOutput",
  "type": "object"
}

list_board_issues — Returns all issues from a board, for the given board ID

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the board

integer

The starting index of the returned issues. Base index: 0

integer

The maximum number of issues to return

string

Filters results using a JQL query

string

Comma-separated list of fields to return per issue

string

Expand options for additional information

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issues": {
      "items": {
        "$ref": "#/$defs/IssueSummary"
      },
      "title": "Issues",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListBoardIssuesOutput",
  "type": "object"
}

list_boards — Returns all boards

Parameters

string

required

The cloud ID of the Jira site

integer

The starting index of the returned boards. Base index: 0

integer

The maximum number of boards to return

string

Filters by board type: scrum, kanban, simple

string

Filters results to boards matching this name

string

Filters results to boards relevant to a project

Response

{
  "$defs": {
    "BoardSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "board_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Board Type"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "BoardSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "boards": {
      "items": {
        "$ref": "#/$defs/BoardSummary"
      },
      "title": "Boards",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListBoardsOutput",
  "type": "object"
}

list_epic_issues — Returns all issues that belong to an epic on the given board

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the board

string

required

The ID of the epic

integer

The starting index of the returned issues. Base index: 0

integer

The maximum number of issues to return

string

Filters results using a JQL query

string

Comma-separated list of fields to return per issue

string

Expand options for additional information

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issues": {
      "items": {
        "$ref": "#/$defs/IssueSummary"
      },
      "title": "Issues",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListEpicIssuesOutput",
  "type": "object"
}

list_epics — Returns all epics from a board, for the given board ID

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the board

integer

The starting index of the returned epics. Base index: 0

integer

The maximum number of epics to return

boolean

Filter to epics that are done or not done

Response

{
  "$defs": {
    "EpicSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "done": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Done"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "EpicSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "epics": {
      "items": {
        "$ref": "#/$defs/EpicSummary"
      },
      "title": "Epics",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListEpicsOutput",
  "type": "object"
}

list_issue_comments — Lists all comments for an issue

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

Order results by a field. Valid: created, +created, -created

string

Expand options: renderedBody

Response

{
  "$defs": {
    "CommentSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "body": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Body"
        },
        "author": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Author"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        }
      },
      "title": "CommentSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "comments": {
      "items": {
        "$ref": "#/$defs/CommentSummary"
      },
      "title": "Comments",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListIssueCommentsOutput",
  "type": "object"
}

list_labels_options — Retrieves available options for the Labels field

Parameters

string

required

The cloud ID of the Jira site

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "labels": {
      "items": {
        "type": "string"
      },
      "title": "Labels",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListLabelsOptionsOutput",
  "type": "object"
}

list_sprint_issues — Returns all issues in a sprint

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the sprint

integer

The starting index of the returned issues. Base index: 0

integer

The maximum number of issues to return

string

Filters results using a JQL query

string

Comma-separated list of fields to return per issue

string

Expand options for additional information

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issues": {
      "items": {
        "$ref": "#/$defs/IssueSummary"
      },
      "title": "Issues",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListSprintIssuesOutput",
  "type": "object"
}

list_sprints — Returns all sprints from a board, for the given board ID

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the board

integer

The starting index of the returned sprints. Base index: 0

integer

The maximum number of sprints to return

string

Filter by sprint states: future, active, closed (comma-separated)

Response

{
  "$defs": {
    "SprintSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "State"
        },
        "start_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Date"
        },
        "end_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "End Date"
        },
        "complete_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Complete Date"
        },
        "goal": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Goal"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        }
      },
      "title": "SprintSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "sprints": {
      "items": {
        "$ref": "#/$defs/SprintSummary"
      },
      "title": "Sprints",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListSprintsOutput",
  "type": "object"
}

move_issues_to_sprint — Moves issues to a sprint, for a given sprint ID

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID of the sprint

array

required

The IDs or keys of the issues to move to the sprint. Each element is a string

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "MoveIssuesToSprintOutput",
  "type": "object"
}

search_issues_with_jql — Search for issues using JQL (Jira Query Language) via GET

Parameters

string

required

The cloud ID of the Jira site

string

required

The JQL query to search for issues

integer

Maximum number of issues to return (default 50, max 5000)

string

Comma-separated list of fields to return

array

Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations

string

Comma-separated list of issue properties to include (max 5)

boolean

Reference fields by key rather than ID

boolean

Fail early if not all field data can be retrieved

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issues": {
      "items": {
        "$ref": "#/$defs/IssueSummary"
      },
      "title": "Issues",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "start_at": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start At"
    },
    "max_results": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Results"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchIssuesWithJqlOutput",
  "type": "object"
}

search_issues_with_jql_post — Searches for issues using JQL with enhanced search capabilities via POST

Parameters

string

required

The cloud ID of the Jira site

string

required

The JQL query to search for issues

integer

Maximum number of items per page

string

Token for pagination from a previous response

array

Fields to return per issue. Elements are strings. Example: [‘summary’, ‘status’]

array

Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations

array

Issue property keys to include (max 5). Elements are strings

boolean

Reference fields by key rather than ID

array

Issue IDs/keys for read-after-write consistency. Elements are strings

Response

{
  "$defs": {
    "IssueSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Key"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "summary": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "issue_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Issue Type"
        },
        "priority": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Priority"
        },
        "assignee": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignee"
        },
        "reporter": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reporter"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        },
        "fields": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields"
        }
      },
      "title": "IssueSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "issues": {
      "items": {
        "$ref": "#/$defs/IssueSummary"
      },
      "title": "Issues",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchIssuesWithJqlPostOutput",
  "type": "object"
}

transition_issue — Performs an issue transition and optionally updates the fields of the screen

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

required

The transition ID to perform

object

List of issue screen fields to update during transition

object

Operations to perform on issue screen fields

object

Additional issue history details

string

Issue properties to add or update (JSON)

object

Extra properties of any type

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "TransitionIssueOutput",
  "type": "object"
}

update_comment — Updates a comment

Parameters

string

required

The cloud ID of the Jira site

string

required

The ID or key of the issue

string

required

The ID of the comment to update

object

The comment text in Atlassian Document Format (JSON). Overrides comment if both provided

string

The comment text (plain text)

object

The group or role to which this comment is visible

string

Comment properties (JSON array)

object

Extra properties of any type

boolean

Whether users are notified when comment is updated

string

Expand options: renderedBody

Response

{
  "$defs": {
    "CommentSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "self_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Self Url"
        },
        "body": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Body"
        },
        "author": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Author"
        },
        "created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created"
        },
        "updated": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated"
        }
      },
      "title": "CommentSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "comment": {
      "anyOf": [
        {
          "$ref": "#/$defs/CommentSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateCommentOutput",
  "type": "object"
}

update_issue — Updates an issue. A transition may be applied and issue properties updated as part of the update

Parameters

string

required

The cloud ID of the Jira site

string

required

The project ID

string

required

The ID or key of the issue

string

The issue type ID

boolean

Whether a notification email is sent to watchers

boolean

Override screen security to enable hidden fields

boolean

Override editable flag to enable uneditable fields

string

The ID of the transition to undertake

boolean

Whether the transition is looped

object

Additional issue history details

string

Issue properties to add or update (JSON array)

object

A map of field name to operations list

object

Extra fields to update (e.g. summary, description)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateIssueOutput",
  "type": "object"
}

​Overview

​Authentication

​OAuth2 Authentication

​Required Credentials

​OAuth Configuration

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

Overview

Authentication

OAuth2 Authentication

Required Credentials

OAuth Configuration

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters