Jira

Learn how to use Jira with Composio

Overview

Enum

JIRA

Description

Jira API tool

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read:jira-work,write:jira-work,manage:jira-project,manage:jira-configuration,read:jira-user,manage:jira-webhook,manage:jira-data-provider,read:servicedesk-request,manage:servicedesk-customer,write:servicedesk-request,read:servicemanagement-insight-objects,offline_access
Base64_Encode
stringRequired
your-domain
stringRequired

Actions

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

file_content
stringRequired
file_name
stringRequired
issue_key
stringRequired

Action Response

data
object
error
successful
boolean

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

comment
stringRequired
issue_id_or_key
stringRequired
visibility_type
string
visibility_value
string

Action Response

data
object
error
successful
boolean

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

account_id
stringRequired
issue_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

account_id
string
issue_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

issueUpdates
arrayRequired

Action Response

data
object
error
successful
boolean

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

assignee
string
components
array
description
string
due_date
string
environment
string
fix_versions
array
issue_type
stringRequired
labels
array
priority
string
project_key
stringRequired
reporter
string
summary
stringRequired
versions
array

Action Response

data
object
error
successful
boolean

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

assignee_type
string
avatar_id
integer
category_id
integer
description
string
issue_security_scheme
integer
key
stringRequired
lead_account_id
stringRequired
name
stringRequired
notification_scheme
integer
permission_scheme
integer
project_template_key
stringRequired
project_type_key
stringRequired
url
string

Action Response

data
object
error
successful
boolean

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

end_date
string
goal
string
name
stringRequired
origin_board_id
integerRequired
start_date
string

Action Response

data
object
error
successful
boolean

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

archived
boolean
description
string
name
stringRequired
projectId
integerRequired
releaseDate
string
released
boolean
startDate
string

Action Response

data
object
error
successful
boolean

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

id
stringRequired
issueIdOrKey
stringRequired

Action Response

data
object
error
successful
boolean

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

delete_subtasks
boolean
issue_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

move_affected_issues_to
string
move_fix_issues_to
string
version_id
stringRequired

Action Response

data
object
error
successful
boolean

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

adjust_estimate
stringDefaults to auto
increase_by
string
issue_id_or_key
stringRequired
new_estimate
string
notify_users
booleanDefaults to True
override_editable_flag
boolean
worklog_id
stringRequired

Action Response

data
object
error
successful
boolean

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

expand
string
name
string
properties
array
recent
integer

Action Response

data
object
error
successful
boolean

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

data
object
error
successful
boolean

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

max_results
integer
start_at
integer

Action Response

data
object
error
successful
boolean

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

comment_id
stringRequired
expand
string
issue_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

expand
string

Action Response

data
object
error
successful
boolean

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

expand
string
fields
array
fields_by_keys
boolean
issue_id_or_key
stringRequired
properties
array
update_history
boolean

Action Response

data
object
error
successful
boolean

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

issue_id_or_key
stringRequired
property_key
stringRequired

Action Response

data
object
error
successful
boolean

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

data
object
error
successful
boolean

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

issue_type_scheme_id
stringRequired

Action Response

data
object
error
successful
boolean

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

issue_id_or_key
stringRequired
max_results
integer
start_at
integer

Action Response

data
object
error
successful
boolean

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

issue_id_or_key
stringRequired
max_results
integer
start_at
integer
started_after
integer
started_before
integer

Action Response

data
object
error
successful
boolean

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

expand
string
project_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

expand
string
include_unavailable_transitions
boolean
issue_id_or_key
stringRequired
skip_remote_only_condition
boolean
sort_by_ops_bar_and_status
boolean
transition_id
string

Action Response

data
object
error
successful
boolean

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

issue_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

expand
string
issue_id_or_key
stringRequired
max_results
integer
start_at
integer
started_after
integer
started_before
integer

Action Response

data
object
error
successful
boolean

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

fields
object
issue_id_or_key
stringRequired
notify_users
booleanDefaults to True
override_editable_flag
boolean
override_screen_security
boolean
return_issue
boolean
update
object

Action Response

data
object
error
successful
boolean

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

data
object
error
successful
boolean

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

includePrivate
boolean
max_results
integer
name
string
orderBy
string
projectKeyOrId
string
start_at
integer
type
string

Action Response

data
object
error
successful
boolean

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

expand
string
issue_id_or_key
stringRequired
max_results
integerDefaults to 50
order_by
string
start_at
integer

Action Response

data
object
error
successful
boolean

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

board_id
integerRequired
max_results
integerDefaults to 50
start_at
integer
state
string

Action Response

data
object
error
successful
boolean

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

issues
arrayRequired
sprint_id
integerRequired

Action Response

data
object
error
successful
boolean

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

account_id
stringRequired
issue_id_or_key
stringRequired

Action Response

data
object
error
successful
boolean

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

expand
string
fields
array
fields_by_keys
boolean
jql
stringRequired
max_results
integerDefaults to 50
properties
array
start_at
integer
validate_query
stringDefaults to strict

Action Response

data
object
error
successful
boolean

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

expand
string
fields
array
fields_by_keys
boolean
jql
stringRequired
max_results
integerDefaults to 50
properties
array
start_at
integer
validate_query
stringDefaults to strict

Action Response

data
object
error
successful
boolean

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

html_body
string
issue_id_or_key
stringRequired
restrict
object
subject
stringRequired
text_body
stringRequired
to
objectRequired

Action Response

data
object
error
successful
boolean

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

comment_id
stringRequired
comment_text
stringRequired
issue_id_or_key
stringRequired
notify_users
booleanDefaults to True
visibility_type
string
visibility_value
string

Action Response

data
object
error
successful
boolean