Jira
Learn how to use Jira with Composio
Overview
Enum
JIRA
Description
Jira API tool
Authentication Details
OAUTH2
API_KEY
Actions
JIRA_ADD_ATTACHMENT
This tool allows users to add attachments to a jira issue. it enables users to attach files such as screenshots, documents, or other files to a specific issue.
Action Parameters
Action Response
JIRA_ADD_COMMENT
This tool adds a new comment to a specified jira issue. the comment can include formatted text using the atlassian document format (adf). it uses the api endpoint post /rest/api/3/issue/{issueidorkey}
/comment to create a comment.
Action Parameters
Action Response
JIRA_ADD_WATCHER_TO_ISSUE
This tool adds a user as a watcher to a specified jira issue. watchers will receive notifications about updates to the issue. this operation requires the “allow users to watch issues” option to be on. this option is set in general configuration for jira. permissions required: - browse projects permission for the project containing the issue - if issue-level security is configured, issue-level security permission to view the issue - to add users other than themselves to the watchlist, manage watcher list project permission
Action Parameters
Action Response
JIRA_ASSIGN_ISSUE
Assigns an issue to a user. use this operation when the calling user does not have the edit issues permission but has the assign issue permission for the project that the issue is in. if account id is set to: - “-1”, the issue is assigned to the default assignee for the project. - null, the issue is set to unassigned. permissions required: - browse projects and assign issues project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue.
Action Parameters
Action Response
JIRA_BULK_CREATE_ISSUE
Creates multiple issues or sub-tasks in bulk. this action allows for the creation of up to 50 issues in a single request. each issue can be a standard issue or a subtask, depending on the issue type specified.
Action Parameters
Action Response
JIRA_CREATE_ISSUE
Creates a new issue in jira. this action allows users to create various types of issues (bugs, tasks, stories, etc.) in a specified jira project. it requires parameters such as project key, summary, and issue type, and supports optional parameters like description, assignee, priority, labels, components, and custom fields.
Action Parameters
Action Response
JIRA_CREATE_ISSUE_LINK
Creates a link between two jira issues with an optional comment. the link type must be a valid link type name in your jira instance. requires appropriate permissions to view and link the specified issues.
Action Parameters
Action Response
JIRA_CREATE_PROJECT
Creates a new project in jira. this action allows you to create a project with specified configurations including project type, template, permissions, and other settings. the project type and template must be compatible - see the project template key field description for valid combinations. requires jira admin permissions.
Action Parameters
Action Response
JIRA_CREATE_SPRINT
This tool creates a future sprint in jira. the sprint name and origin board id are required parameters. the tool allows for creating a new sprint with optional parameters like start date, end date, and goal.
Action Parameters
Action Response
JIRA_CREATE_VERSION
This tool creates a new version in a jira project. it uses the post /rest/api/3/version endpoint and accepts parameters like name, description, projectid, released, archived, releasedate, and startdate to track project releases and milestones.
Action Parameters
Action Response
JIRA_DELETE_COMMENT
This tool will delete a comment from a jira issue using the delete /rest/api/3/issue/{issueidorkey}
/comment/{id}
endpoint. it requires the following parameters: issueidorkey (string) for the id or key of the issue, and id (string) for the id of the comment. the operation requires specific permissions including: browse projects, issue-level security permissions if applicable, and delete permissions (either delete all comments or delete own comments).
Action Parameters
Action Response
JIRA_DELETE_ISSUE
Deletes a jira issue. an issue cannot be deleted if it has subtasks unless deletesubtasks is true. permissions required: - browse projects and delete issues project permission for the project containing the issue - if issue-level security is configured, issue-level security permission to view the issue
Action Parameters
Action Response
JIRA_DELETE_VERSION
This tool allows you to delete a version in jira. a version is a milestone or release point in a project that can be used to track progress and organize issues. the delete operation can be customized to handle associated issues and fix versions. permissions required: - administer jira global permission or - administer projects project permission for the project that contains the version
Action Parameters
Action Response
JIRA_DELETE_WORKLOG
Deletes a worklog from an issue. the user must have permission to delete the worklog by being the worklog author, having the delete all worklogs permission, or the administer project permission.
Action Parameters
Action Response
JIRA_GET_ALL_PROJECTS
Deprecated method returns all projects a user can see. use the paginated “get projects” with search support instead. anonymous access available. requires ‘browse’ or ‘administer’ project permissions.
Action Parameters
Action Response
JIRA_GET_ALL_STATUSES
Returns a list of all statuses available in jira. this action retrieves information about all issue statuses, including their ids, names, descriptions, and categories. this is particularly useful for workflow management and understanding the possible states an issue can be in.
Action Parameters
Action Response
JIRA_GET_ALL_USERS
Get all users in jira action class. this action retrieves a list of all jira users including active, inactive, and deleted users that have not been removed from the database. it supports pagination parameters such as startat and maxresults, and requires ‘browse users and groups’ permission. returns: a list of user objects containing user details like account id, display name, email, etc.
Action Parameters
Action Response
JIRA_GET_COMMENT
This tool retrieves a specific comment from a jira issue. it requires the ‘issueidorkey’ and ‘id’ parameters (with an optional ‘expand’ parameter) to fetch detailed information about a comment, including its content, author details, creation and update dates, and more. this action is essential for viewing and managing specific issue discussions in jira.
Action Parameters
Action Response
JIRA_GET_CURRENT_USER
This tool retrieves detailed information about the currently authenticated user in jira. it is essential for verifying authentication, getting user-specific information, checking user permissions, retrieving preferences, and identifying the user for further api operations.
Action Parameters
Action Response
JIRA_GET_ISSUE
This tool retrieves the details of a specific jira issue using the get /rest/api/3/issue/{issueidorkey}
endpoint. it returns all relevant issue information, such as its summary, description, status, assignee, reporter, comments, attachments, and any custom fields configured in your jira instance.
Action Parameters
Action Response
JIRA_GET_ISSUE_LINK_TYPES
Returns a list of all issue link types in jira, providing details such as the id, name, inward and outward descriptions, and self url. this tool is useful for understanding available link types, getting correct ids for issue linking operations, displaying possible relationships between issues, and validating link types before creating relationships. permissions required: browse projects permission for at least one project in the site.
Action Parameters
Action Response
JIRA_GET_ISSUE_PROPERTY
Returns the value of a property for an issue. this action makes a get request to the /rest/api/3/issue/{issueidorkey}
/properties/{propertykey}
endpoint and returns details including the key and value for the issue property. the operation can be accessed anonymously. permissions required: - browse projects project permission for the project containing the issue. - if issue-level security is configured, issue-level security permission to view the issue.
Action Parameters
Action Response
JIRA_GET_ISSUE_RESOLUTIONS
Returns a list of all issue resolution values. this tool retrieves all configured resolution types in the jira instance, providing details such as resolution ids, names, descriptions, and urls. it is useful for: - getting a list of available resolution types - finding the default resolution - obtaining resolution ids for other api calls - validating resolution names and ids before updating issues - understanding what options are available when closing issues
Action Parameters
Action Response
JIRA_GET_ISSUE_TYPE_SCHEME
This tool retrieves detailed information about a specific issue type scheme in jira. an issue type scheme defines the mapping between issue types and projects. the action will return information about the scheme including its name, description, and the issue types associated with it.
Action Parameters
Action Response
JIRA_GET_ISSUE_WATCHERS
Gets the list of watchers for an issue. a watcher is a user who receives notifications when the issue is updated. this endpoint requires the ‘browse projects’ project permission for the project containing the issue. this operation requires the “allow users to watch issues” option to be on. this option is set in general configuration for jira.
Action Parameters
Action Response
JIRA_GET_ISSUE_WORKLOGS
Gets all work logs for an issue. the response includes details of all work logs for the issue that the user has permission to view. this action is essential for tracking time spent on issues and provides a comprehensive view of work logged against a specific issue, making it useful for project management, time tracking, and reporting purposes. permissions required: - browse projects project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue. - if the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Action Parameters
Action Response
JIRA_GET_PROJECT_VERSIONS
Action to get all versions in a specified jira project. this tool retrieves all versions in a specified jira project. it provides a comprehensive list of project versions with their details including version id, version name, release status, start and release dates, and description. requires ‘browse projects’ project permission.
Action Parameters
Action Response
JIRA_GET_REMOTE_ISSUE_LINKS
Gets the remote issue links for a jira issue. this operation requires the link issue permission. it retrieves external remote links associated with a jira issue, with the ability to filter by issue key and global id. permissions required: - browse projects project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue.
Action Parameters
Action Response
JIRA_GET_TRANSITIONS
This tool returns all transitions or a specific transition for an issue based on its status. it helps in determining available status changes and understanding what workflow transitions (including required screens and conditions) are available for an issue.
Action Parameters
Action Response
JIRA_GET_VOTES
This tool retrieves voting information for a specified issue in jira. it returns details about the number of votes an issue has received and the users who have voted on it. it is used to get vote details, including the vote count, whether the current user has voted, and details about the voters. note: this operation requires the “allow users to vote on issues” option to be enabled in jira settings. users without the “view voters and watchers” project permission won’t see details in the voters field. permissions required: - browse projects project permission - if issue-level security is configured, issue-level security permission to view the issue
Action Parameters
Action Response
JIRA_GET_WORKLOG
Returns all work logs for an issue. the endpoint provides detailed information about each work log including time spent, the author, and work timestamps. it is useful for tracking time spent on issues, generating time reports, auditing work on issues, project management, resource allocation, and billing purposes. permissions required: - browse projects project permission - if issue-level security is configured, issue-level security permission to view the issue - if the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to
Action Parameters
Action Response
JIRA_JIRA_EDIT_ISSUE
This action edits an existing issue in jira. it accepts parameters such as issueidorkey, fields, update, notifyusers, overridescreensecurity, and overrideeditableflag. the action handles field validation, permission checks, screen and workflow validations, and error handling, and returns a 204 status when the issue is updated successfully.
Action Parameters
Action Response
JIRA_JIRA_GET_ISSUE_TYPES
Returns all issue types visible to the user. this tool retrieves a list of all issue types visible to the user, including custom issue types, sub-task issue types, and standard issue types. it is essential for determining available issue types for creating new issues and for retrieving issue type metadata for project configuration. permissions required: - if the user has the “administer jira” global permission, all issue types are returned. - if the user has the “browse projects” project permission for one or more projects, only the issue types associated with those projects are returned.
Action Parameters
Action Response
JIRA_LIST_BOARDS
This tool retrieves all boards that the authenticated user has permission to view. it supports optional parameters (startat, maxresults, type, name, projectkeyorid, includeprivate, orderby) to filter and paginate the results.
Action Parameters
Action Response
JIRA_LIST_ISSUE_COMMENTS
This tool retrieves all comments for a specific jira issue. it accepts a required parameter ‘issueidorkey’ along with optional parameters for pagination and sorting. the response includes an array of comment objects containing details like author info, comment body, timestamps, and visibility settings.
Action Parameters
Action Response
JIRA_LIST_SPRINTS
This tool retrieves all sprints from a specified board and returns them in order of start date, with the most recent sprint appearing first. it supports parameters such as board id (required), state (optional), start at (optional, default: 0), and max results (optional, default: 50) for pagination.
Action Parameters
Action Response
JIRA_MOVE_ISSUE_TO_SPRINT
This tool moves one or more jira issues to a specific sprint. the sprint must be active or open to receive issues. it accepts a sprint id and an array of issue keys (up to 50 issues per operation).
Action Parameters
Action Response
JIRA_REMOVE_WATCHER_FROM_ISSUE
Removes a user from an issue’s list of watchers. this operation requires the user to have permission to view the issue and to manage the issue’s watchers. permissions required: - browse projects project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue. - to remove users other than themselves from the watchlist, manage watcher list project permission for the project that the issue is in.
Action Parameters
Action Response
JIRA_SEARCH_FOR_ISSUES_USING_JQL_GET
This tool allows searching for jira issues using jql (jira query language) queries. it provides a flexible way to search and filter issues based on various criteria, including pagination and custom field selection.
Action Parameters
Action Response
JIRA_SEARCH_FOR_ISSUES_USING_JQL_POST
This tool allows searching for jira issues using jql (jira query language) queries via post request. this endpoint is particularly useful for handling complex queries that exceed url length limits, supports additional parameters like startat, maxresults, fields, expand, validatequery, and properties, and provides enhanced flexibility for batch operations and paginated responses.
Action Parameters
Action Response
JIRA_SEND_NOTIFICATION_FOR_ISSUE
This tool sends email notifications for a specific jira issue. it allows users to create customized email notifications that will be added to the mail queue and sent to specified recipients. it includes parameters to specify the issue id or key, subject, text body, optional html body, and recipient details. this tool is useful for automating notification workflows and ensuring that relevant stakeholders are informed of important issue updates.
Action Parameters
Action Response
JIRA_UPDATE_COMMENT
This tool updates an existing comment on a jira issue. it requires permissions such as ‘browse projects’, ‘edit all comments’ or ‘edit own comments’, and appropriate visibility permissions if restrictions apply.
Action Parameters
Action Response