Jira
Overview
Section titled “Overview”Jira is Atlassian’s bug tracking, issue tracking, and agile project management platform, widely adopted by software teams to organize backlogs, sprints, and workflows with Scrum or Kanban. With the Jira integration in SquadOS, your agents can create and update issues, transition workflow statuses, log worklogs, manage sprints, and much more — all without leaving the conversation.
- Official website: https://www.atlassian.com/software/jira
- Composio documentation: docs.composio.dev/toolkits/jira
Authentication
Section titled “Authentication”This tool supports OAuth 2.0 (OAUTH2), OAuth 2.0 Server-to-Server (S2S_OAUTH2), and API key (API_KEY) to connect.
The most common mode is OAuth 2.0 using your own credentials configured in the Atlassian developer portal. You will need the following fields:
| Field | Required | Description |
|---|---|---|
client_id | Yes | Client ID of the OAuth 2.0 application created in the Atlassian developer portal. |
client_secret | Yes | Client Secret corresponding to the OAuth 2.0 application. |
How to get credentials
Section titled “How to get credentials”- Go to the Atlassian Developer Portal and create a developer account if you don’t have one.
- Click Create and select the OAuth 2.0 Integration type to create a new application.
- In the Authorization tab, click Configure and enter Composio’s Callback URL (shown in the Composio auth configuration screen).
- In the Permissions tab, add the Jira API and configure the required scopes from the User Identity API and Jira API sections.
- In the Settings tab, find the Authentication Details section and copy the Client ID and Client Secret.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Jira. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you authorize access (OAuth) or enter the credentials obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
How do I set up custom OAuth credentials for Jira?
Section titled “How do I set up custom OAuth credentials for Jira?”See the step-by-step guide at composio.dev/auth/jira for creating and configuring your own Jira OAuth credentials with Composio.
What is the difference between JQL GET, JQL POST, and Search Issues?
Section titled “What is the difference between JQL GET, JQL POST, and Search Issues?”JQL GET and POST target the same search functionality but use different HTTP methods. POST supports complex queries in the request body. Search Issues uses JQL POST under the hood with extra parameters and filters. For consistent results, prefer POST for complex queries. Use the fields parameter to request specific fields, or ["*all"] to request all fields.
Available actions
Section titled “Available actions”Create Issue
Section titled “Create Issue”JIRA_CREATE_ISSUE
Creates a new Jira issue (e.g., bug, task, story) in a specified project. IMPORTANT: Different Jira projects may have custom required fields beyond the standard ones (summary, project_key, issue_type). If issue creation fails with ‘field X is required’, use JIRA_GET_ISSUE_CREATE_METADATA to discover available fields for your project. Custom fields can be provided via additional_properties as a JSON string.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
summary | string | Yes | Brief, descriptive title for the issue. |
project_key | string | Yes | Key of the Jira project where the issue will be created (e.g., ‘KAN’, ‘DEV’, ‘PROJ’). |
issue_type | string | Yes | Type of the issue — must be valid for the target project (e.g., ‘Task’, ‘Story’, ‘Epic’, ‘Bug’). |
description | string | No | Detailed description of the issue. Accepts plain text, Markdown, or Atlassian Document Format (ADF). |
assignee | string | No | Account ID of the user to assign the issue to. Use JIRA_FIND_USERS to get valid account IDs. |
assignee_name | string | No | Name or email of the user to assign (ignored if assignee is provided). |
priority | string | No | Priority level (e.g., ‘High’, ‘Medium’, ‘Low’). Names are instance-specific. |
labels | array | No | List of labels to categorize the issue; new labels are created if they don’t exist. |
due_date | string | No | Expected resolution date in YYYY-MM-DD format. |
sprint_id | integer | No | ID of the sprint to assign this issue to. |
components | array | No | List of component IDs (e.g., ‘10000’); components must exist in the project. |
parent | string | No | Parent issue key (e.g., ‘PROJ-123’) or issue ID. Use only for sub-task issue types. |
reporter | string | No | Account ID of the user reporting the issue. Defaults to the API request user. |
versions | array | No | List of IDs for versions affected by this issue. |
fix_versions | array | No | List of IDs for versions where the issue is/will be fixed. |
additional_properties | string | No | JSON string of additional fields, including custom fields (e.g., '{"customfield_10104": 5}'). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Edit Issue
Section titled “Edit Issue”JIRA_EDIT_ISSUE
Updates an existing Jira issue with field values and operations. Supports direct field parameters (summary, description, assignee, priority, etc.) that are merged with the fields parameter. Direct parameters take precedence. Note: the status field cannot be updated via this action — use JIRA_TRANSITION_ISSUE to change issue status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | ID or key of the Jira issue to be edited. |
summary | string | No | Brief, descriptive title for the issue. |
description | string | No | Detailed description of the issue. Supports Markdown, automatically converted to ADF. |
assignee | string | No | User to assign: account ID, email, or name. Provide an empty string to unassign. |
priority_id_or_name | string | No | Priority ID or name (e.g., ‘High’, ‘Medium’). |
labels | array | No | List of labels to set for the issue (replaces existing labels). |
due_date | string | No | Expected resolution date in YYYY-MM-DD format. Use null to remove. |
sprint_id_or_name | string | No | Sprint ID or name to assign this issue to. |
fields | string | No | JSON string of fields for direct updates. |
update | string | No | JSON string for granular field operations (e.g., adding/removing labels). |
notify_users | boolean | No | If true, sends notification email to watchers. |
return_issue | boolean | No | If true, response includes full updated issue details. |
additional_properties | object | No | Additional properties to include in the request body. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Issue
Section titled “Get Issue”JIRA_GET_ISSUE
Retrieves a Jira issue by ID or key with customizable fields and expansions. Request only needed fields and expansions to avoid large responses.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_key | string | Yes | The ID (e.g., ‘10000’) or key (e.g., ‘PROJ-123’) of the Jira issue to retrieve. |
fields | array | No | A list of field names or IDs to return for the issue. If omitted, a default set of fields is returned. |
expand | string | No | A comma-separated list of entities to include (e.g., ‘changelog’, ‘renderedFields’, ‘transitions’). |
properties | array | No | A list of issue property keys to include in the response. |
fields_by_keys | boolean | No | If true, the strings in the fields parameter are interpreted as field keys. |
update_history | boolean | No | Controls whether viewing the issue adds it to the user’s ‘Recently viewed’ list. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Issue
Section titled “Delete Issue”JIRA_DELETE_ISSUE
Permanently and irreversibly deletes a Jira issue by its ID or key. Obtain explicit user confirmation before calling.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID or key of the issue to delete. |
delete_subtasks | boolean | No | If true, the issue’s subtasks are also deleted. If false and the issue has subtasks, the deletion will fail. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Assign Issue
Section titled “Assign Issue”JIRA_ASSIGN_ISSUE
Assigns a Jira issue to a user, default assignee, or unassigns; supports email/name lookup.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID or key of the issue to be assigned. |
account_id | string | No | The Atlassian Account ID of the user to assign the issue to. Use '-1' to assign to the project’s default assignee, or omit to unassign. |
assignee_name | string | No | Name or email of the user to assign (ignored if account_id is provided). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Add Comment
Section titled “Add Comment”JIRA_ADD_COMMENT
Adds a comment using Atlassian Document Format (ADF) for rich text to an existing Jira issue.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID or key of the issue to add the comment to. |
comment | string | Yes | The comment text. Supports Markdown formatting including bold, italic, code, links, and @mentions. |
visibility_type | string | No | Specifies the type of visibility restriction: 'group' or 'role'. |
visibility_value | string | No | Name of the group or role that can view the comment (required if visibility_type is set). |
additional_properties | object | No | Additional properties to include in the comment request body. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Issue Comments
Section titled “List Issue Comments”JIRA_LIST_ISSUE_COMMENTS
Retrieves paginated comments from a Jira issue with optional ordering. Paginate by incrementing start_at by max_results until the cumulative count reaches the total field in the response.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID (e.g., ‘10000’) or key (e.g., ‘PROJ-123’) of the Jira issue. |
start_at | integer | No | The 0-based index of the first comment to return. |
max_results | integer | No | The maximum number of comments to return per page (max ~100 on Jira Cloud). |
order_by | string | No | Field to sort comments by; use 'created' for ascending by creation date. |
expand | string | No | Use 'renderedBody' to include the HTML-rendered version of the comment body. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update Comment
Section titled “Update Comment”JIRA_UPDATE_COMMENT
Updates text content or visibility of an existing Jira comment.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID or key of the Jira issue where the comment is located. |
comment_id | string | Yes | The unique ID of the comment to be updated. |
comment_text | string | Yes | The new text content for the comment. Replaces the existing body. Supports plain text and basic formatting. |
notify_users | boolean | No | Whether to send notifications to users about the comment update. Defaults to True. |
visibility_type | string | No | Type of visibility restriction: 'group' or 'role'. |
visibility_value | string | No | Name of the group or role to restrict comment visibility to. |
additional_properties | string | No | JSON string of comment properties as key-value pairs. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Comment
Section titled “Delete Comment”JIRA_DELETE_COMMENT
Deletes a specific comment from a Jira issue using its ID and the issue’s ID/key; requires user permission to delete comments on the issue.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issueIdOrKey | string | Yes | The ID (e.g., ‘10000’) or key (e.g., ‘PROJ-123’) of the Jira issue from which the comment will be deleted. |
id | string | Yes | The unique identifier of the comment to be deleted (e.g., ‘10001’). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Search Issues
Section titled “Search Issues”JIRA_SEARCH_ISSUES
Advanced Jira issue search supporting structured filters and raw JQL. At least one filter parameter (e.g., jql, project_key, updated_after) is required; calls with no parameters will be rejected.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
jql | string | No | Raw JQL (Jira Query Language) query for advanced users. Takes precedence over filters. |
project_key | string | No | Filter by project key (e.g., ‘PROJ’). |
assignee | string | No | Filter by assignee. Can be account ID, email, display name, or 'unassigned'. |
status_id_or_name | string | No | Filter by status: ID (e.g., ‘10001’) or name (e.g., ‘To Do’, ‘In Progress’, ‘Done’). |
issue_type_id_or_name | string | No | Filter by issue type: ID (e.g., ‘10001’) or name (e.g., ‘Bug’, ‘Task’, ‘Story’). |
priority_id_or_name | string | No | Filter by priority: ID or name (e.g., ‘High’, ‘Medium’, ‘Low’). |
sprint_id_or_name | string | No | Filter by sprint: ID (e.g., ‘123’) or name (e.g., ‘Sprint 1’). |
labels | array | No | Filter by labels (all labels must match). |
text_search | string | No | Search in summary and description text. |
created_after | string | No | Filter issues created after this date. YYYY-MM-DD or relative dates like '-7d'. |
updated_after | string | No | Filter issues updated after this date. |
created_before | string | No | Filter issues created before this date (YYYY-MM-DD format). |
updated_before | string | No | Filter issues updated before this date. |
fields | array | No | List of fields to return for each issue. |
max_results | integer | No | Maximum number of issues to return per page (capped at 100). |
next_page_token | string | No | Cursor token to fetch the next page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Project
Section titled “Create Project”JIRA_CREATE_PROJECT
Creates a new Jira project with required lead, template, and type configuration.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Unique key for the project (uppercase letters only, no spaces or special characters). |
name | string | Yes | Human-readable name for the project. |
lead_account_id | string | Yes | Atlassian Account ID of the project lead. |
project_type_key | string | Yes | Type of project: 'business', 'software', or 'service_desk'. |
project_template_key | string | Yes | Key of the project template, compatible with project_type_key. |
description | string | No | Optional detailed textual description of the project. |
assignee_type | string | No | Default assignee for new issues: 'PROJECT_LEAD' or 'UNASSIGNED'. |
url | string | No | Optional URL for the project. |
avatar_id | integer | No | Optional ID of an existing avatar for the project. |
category_id | integer | No | Optional ID of an existing project category. |
permission_scheme | integer | No | Optional ID of an existing permission scheme. |
notification_scheme | integer | No | Optional ID of an existing notification scheme. |
issue_security_scheme | integer | No | Optional ID of an existing issue security scheme. |
additional_properties | object | No | Additional properties for the project creation request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Project
Section titled “Get Project”JIRA_GET_PROJECT
Retrieves details of a Jira project by its ID or key.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
project_id_or_key | string | Yes | The project ID (numeric) or project key (e.g., ‘PROJ’) of the project to retrieve. |
expand | string | No | Additional information to include: description, issueTypes, lead, projectKeys, issueTypeHierarchy. |
properties | string | No | A comma-separated list of project properties to return (maximum 100 keys). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Projects
Section titled “List All Projects”JIRA_LIST_ALL_PROJECTS
Tool to list all projects accessible to the user. Use when you need to retrieve a comprehensive list of all Jira projects.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
expand | string | No | Additional information in the response: description, issueTypes, lead, projectKeys. |
recent | integer | No | Returns the user’s most recently accessed projects (up to 20). |
properties | array | No | A list of project properties to return. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Sprint
Section titled “Create Sprint”JIRA_CREATE_SPRINT
Creates a new sprint on a Jira board with optional start/end dates and goal.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
origin_board_id | integer | Yes | Identifier of the Jira board for the new sprint. Use JIRA_LIST_BOARDS to find board IDs. |
name | string | Yes | Name for the new sprint (must be 30 characters or less). |
goal | string | No | Primary objective or goal for the sprint. |
start_date | string | No | Intended start date and time for the sprint (ISO 8601 format). |
end_date | string | No | Intended end date and time for the sprint (ISO 8601 format). |
additional_properties | object | No | Additional properties for the sprint creation request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Sprints
Section titled “List Sprints”JIRA_LIST_SPRINTS
Retrieves paginated sprints from a Jira board with optional state filtering.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
board_id | integer | Yes | Unique identifier of the Jira board. Must be a Scrum board ID; Kanban boards do not support sprints. |
state | string | No | Filters sprints by state. Accepts single value ('active') or comma-separated values ('active,closed'). Valid states: 'future', 'active', 'closed'. |
start_at | integer | No | 0-based starting index for pagination. |
max_results | integer | No | Maximum number of sprints per page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Move Issues to Sprint
Section titled “Move Issues to Sprint”JIRA_MOVE_ISSUE_TO_SPRINT
Moves one or more Jira issues to a specified active sprint.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
sprint_id | integer | Yes | Unique identifier for the target sprint. Must belong to the same board/project as the issues being moved. |
issues | array | Yes | A list of issue keys (e.g., ‘PROJ-123’) to be moved to the specified sprint. |
rank_after_issue | string | No | The issue key or ID to rank the moved issues after in the sprint backlog. |
rank_before_issue | string | No | The issue key or ID to rank the moved issues before. |
rank_custom_field_id | integer | No | The ID of the rank custom field to use for ordering. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Transition Issue
Section titled “Transition Issue”JIRA_TRANSITION_ISSUE
Transitions a Jira issue to a different workflow state, with support for transition name lookup and user assignment by email. Use JIRA_GET_TRANSITIONS to verify available transitions before calling this action.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID or key of the issue to transition. |
transition_id_or_name | string | Yes | The ID or name of the transition to apply. Transition names are workflow-specific — use JIRA_GET_TRANSITIONS to get valid values for the current issue. |
comment | string | No | Optional comment to add during the transition. Supports Markdown formatting. |
assignee | string | No | Account ID of the user to assign the issue to during transition. |
assignee_name | string | No | Name or email of the user to assign (ignored if assignee is provided). |
resolution | string | No | Resolution to set when CLOSING an issue (e.g., ‘Done’, ‘Fixed’, ‘Won’t Do’). Only use when transitioning to a final status. |
transition_fields | object | No | Fields to include in the transition payload (e.g., fields required by the transition’s screen). |
additional_properties | object | No | Additional properties to include at the top level of the transition request body. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Transitions
Section titled “Get Transitions”JIRA_GET_TRANSITIONS
Retrieves available workflow transitions for a Jira issue. Always use the numeric id from the response when calling JIRA_TRANSITION_ISSUE — transition IDs are project/workflow-specific and must not be hardcoded or reused.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID (e.g., ‘10000’) or key (e.g., ‘PROJ-123’) of the Jira issue. |
expand | string | No | Use 'transitions.fields' to include the fields associated with each transition. |
transition_id | string | No | The ID of a specific transition to retrieve. |
include_unavailable_transitions | boolean | No | If true, transitions not currently available for the issue will be included. |
sort_by_ops_bar_and_status | boolean | No | If true, sorts transitions by their order in the operations bar and then by status category. |
skip_remote_only_condition | boolean | No | If true, conditions defined by remote apps that only run remotely will be skipped. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Add Worklog
Section titled “Add Worklog”JIRA_ADD_WORKLOG
Tool to add a worklog entry to a Jira issue. Use when logging time spent on an issue.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID or key of the Jira issue to add the worklog to. |
time_spent | string | No | The time spent as a Jira duration string (e.g., ‘2h 30m’, ‘1d’, ‘45m’). Either this or time_spent_seconds must be provided. |
time_spent_seconds | integer | No | The time in seconds spent working on the issue. Either this or time_spent must be provided. |
started | string | No | The datetime when the work was started in ISO 8601 format. If not provided, the current time is used. |
comment | object | No | Atlassian Document Format comment structure. |
adjust_estimate | string | No | Options for adjusting the issue’s remaining estimate: 'new', 'leave', 'manual', or 'auto'. |
new_estimate | string | No | The new remaining estimate if adjust_estimate is 'new' (e.g., ‘2h’). |
reduce_by | string | No | Amount to reduce the remaining estimate if adjust_estimate is 'manual'. |
notify_users | boolean | No | Whether to notify users watching the issue about this worklog. |
visibility | object | No | Details about the visibility restriction of a worklog. |
expand | string | No | Use 'properties' to include custom fields associated with the worklogs. |
override_editable_flag | boolean | No | Whether to add the worklog even if the issue is not editable (e.g., closed). Requires admin permissions. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Worklogs
Section titled “Get Worklogs”JIRA_GET_WORKLOG
Retrieves worklogs for a specified Jira issue.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issue_id_or_key | string | Yes | The ID (e.g., ‘10001’) or key (e.g., ‘PROJECT-123’) of the Jira issue. |
start_at | integer | No | The 0-based index of the first worklog to return. Used for pagination. |
max_results | integer | No | The maximum number of worklogs to return per page. |
started_after | integer | No | Filters worklogs started on or after this date. Provide as a Unix timestamp in milliseconds. |
started_before | integer | No | Filters worklogs started on or before this date. Provide as a Unix timestamp in milliseconds. |
expand | string | No | Use 'properties' to include custom fields associated with the worklogs. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Version
Section titled “Create Version”JIRA_CREATE_VERSION
Creates a new version for releases or milestones in a Jira project.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for the new version. It is recommended that version names be unique within a project. |
projectId | integer | Yes | Numeric ID of the Jira project to which this version will be added. |
description | string | No | Textual description for the version. |
startDate | string | No | Start date for work on the version (YYYY-MM-DD format). |
releaseDate | string | No | Release date for the version (YYYY-MM-DD format). |
released | boolean | No | Indicates if the version is marked as released. |
archived | boolean | No | Indicates if the version is marked as archived. |
additional_properties | object | No | Additional properties for the version creation request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Bulk Create Issues
Section titled “Bulk Create Issues”JIRA_BULK_CREATE_ISSUE
Creates multiple Jira issues (up to 50 per call) with full feature support including markdown, assignee resolution, and priority handling.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issues | array | Yes | List of issues to be created (1 to 50 per request). Each issue definition follows the same structure as the single create issue action. For subtasks, include parent_key to specify the parent issue. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Bulk Fetch Issues
Section titled “Bulk Fetch Issues”JIRA_FETCH_BULK_ISSUES
Tool to bulk fetch multiple Jira issues by their IDs or keys (max 100 per call). Use when you need to retrieve details for multiple issues efficiently in a single API call.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
issueIdsOrKeys | array | Yes | REQUIRED. An array of issue IDs or issue keys to fetch. Minimum 1, maximum 100 issues per request. |
fields | array | No | A list of fields to return for each issue. Use '*all' for all fields or prefix with - to exclude (e.g., '-description'). |
expand | array | No | A list of expand options (e.g., 'renderedFields', 'changelog'). |
properties | array | No | A list of issue property keys to include (maximum 5). |
fieldsByKeys | boolean | No | If true, reference fields by their key rather than ID. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Link Issues
Section titled “Link Issues”JIRA_CREATE_ISSUE_LINK
Links two Jira issues using a specified link type with optional comment.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
link_type | string | Yes | The name of the issue link type to create (e.g., ‘Blocks’, ‘Relates’, ‘Duplicate’, ‘Cloners’). Use JIRA_GET_ISSUE_LINK_TYPES to retrieve valid link type names. |
inward_issue_key | string | Yes | The key of the issue that initiates the link relationship (the ‘source’ issue). |
outward_issue_key | string | Yes | The key of the issue that is the target of the link relationship (the ‘destination’ issue). |
comment | string | No | An optional textual comment to add to the created issue link. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Current User
Section titled “Get Current User”JIRA_GET_CURRENT_USER
Retrieves detailed information about the currently authenticated Jira user. The returned accountId is the correct identifier for fields like lead_account_id in JIRA_CREATE_PROJECT and watcher actions — never use email or username in those fields.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
expand | string | No | Comma-separated list of user properties to expand, e.g., 'groups', 'applicationRoles'. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Issue Statuses
Section titled “Get Issue Statuses”JIRA_GET_ALL_STATUSES
Retrieves all issue statuses associated with workflows from Jira. Returns global statuses that may not be valid for every project or workflow scheme; verify a returned status is applicable to the specific project before use.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |