> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jira

> How to set up the Jira connector, plus the actions and events that are available.

![Jira](https://stackone-logos.com/api/jira/filled/svg)

v1.1.1[See changelog](https://docs.stackone.com/connectors/jira/changelog.md)

[147 actions](#actions) · [47 events](#events) · 2 auth methods

Project Management
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/jira/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth app in the Atlassian Developer Console. Supports granular scopes across projects, issues,...

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/jira/guides/connector-profile/api-key.md)
>
> Best for personal scripts and single-user automation. Uses email + API token for basic authentication.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/jira/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/jira/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

delete:sprint:jira-software

manage:jira-configuration

manage:jira-project

read:board-scope:jira-software

read:jira-user

read:jira-work

read:sprint:jira-software

write:jira-work

write:sprint:jira-software

No scopes found

147 actions

ActionDescriptionRequired scopes

Add Attachment`jira_add_attachment`

Add an attachment to an issue

`write:jira-work`

Get Attachment`jira_get_attachment`

Get metadata for an attachment by ID

`read:jira-work`

Delete Attachment`jira_delete_attachment`

Delete an attachment from an issue

`write:jira-work`

Get Attachment Archive Metadata`jira_get_attachment_metadata`

Get metadata for archive attachments (ZIP, TAR, etc.) — only works on archive file types

`read:jira-work`

Get Attachment Settings`jira_get_attachment_settings`

Get global attachment settings for the Jira instance

`read:jira-work`

Get All Boards`jira_get_all_boards`

Get all boards visible to the user

`read:board-scope:jira-software`

Get Board`jira_get_board`

Get details of a specific board

`read:board-scope:jira-software`

Get Board Issues`jira_get_board_issues`

Get all issues for a board

`read:board-scope:jira-software`

Get Board Backlog`jira_get_board_backlog`

Get all issues in the backlog of a board

`read:board-scope:jira-software`

Get Board Configuration`jira_get_board_configuration`

Get board configuration including columns and status mappings

`read:board-scope:jira-software`

List Project Categories`jira_list_categories`

Get all project categories

`read:jira-work`

Get Project Category`jira_get_category`

Get details of a specific project category

`read:jira-work`

Create Project Category`jira_create_category`

Create a new project category

`manage:jira-project`

Update Project Category`jira_update_category`

Update an existing project category

`manage:jira-project`

Delete Project Category`jira_delete_category`

Delete a project category

`manage:jira-project`

Get Issue Changelogs`jira_get_issue_changelogs`

Get the changelog history for an issue

`read:jira-work`

Get Changelogs By IDs`jira_get_changelogs_by_ids`

Get specific changelog entries for an issue by changelog IDs

`read:jira-work`

List Issue Comments`jira_list_issue_comments`

Get all comments for an issue

`read:jira-work`

Create Issue Comment`jira_create_issue_comment`

Create a comment on an issue

`write:jira-work`

Get Comment`jira_get_issue_comment`

Get a specific comment on an issue

`read:jira-work`

Update Comment`jira_update_issue_comment`

Update a comment on an issue

`write:jira-work`

Delete Comment`jira_delete_issue_comment`

Delete a comment from an issue

`write:jira-work`

List Components`jira_list_components`

Get components across the site, optionally narrowed to specific projects

`read:jira-work`

Create Component`jira_create_component`

Create a new component in a project

`manage:jira-project`

Get Component`jira_get_component`

Get details of a specific component

`read:jira-work`

Update Component`jira_update_component`

Update an existing component

`manage:jira-project`

Delete Component`jira_delete_component`

Delete a component from a project

`manage:jira-project`

List Dashboards`jira_list_dashboards`

Get all dashboards accessible to the user

`read:jira-work`

Search Dashboards`jira_search_dashboards`

Search for dashboards with advanced filtering

`read:jira-work`

Get Dashboard`jira_get_dashboard`

Get details of a specific dashboard

`read:jira-work`

Create Dashboard`jira_create_dashboard`

Create a new dashboard

`write:jira-work`

Update Dashboard`jira_update_dashboard`

Update an existing dashboard

`write:jira-work`

Delete Dashboard`jira_delete_dashboard`

Delete a dashboard

`write:jira-work`

Copy Dashboard`jira_copy_dashboard`

Copy an existing dashboard

`read:jira-work`

List Fields`jira_list_fields`

Get all fields (system and custom) in the Jira instance

`read:jira-work`

Search Fields`jira_search_fields`

Search for fields with pagination and filtering

`read:jira-work`

Get Field Configurations`jira_get_field_configurations`

Get all field configurations

`manage:jira-configuration`

List Filters`jira_list_filters`

Get all filters accessible to the user

`read:jira-work`

Get Filter`jira_get_filter`

Get details of a specific filter

`read:jira-work`

Create Filter`jira_create_filter`

Create a new filter (saved search)

`write:jira-work`

Update Filter`jira_update_filter`

Update an existing filter

`write:jira-work`

Delete Filter`jira_delete_filter`

Delete a filter

`write:jira-work`

Set Filter Favourite`jira_set_filter_favourite`

Add a filter to the current user's favourites

`write:jira-work`

Delete Filter Favourite`jira_delete_filter_favourite`

Remove a filter from the current user's favourites

`write:jira-work`

Get Favourite Filters`jira_get_favourite_filters`

Get all filters marked as favourites by the current user

`read:jira-work`

Get My Filters`jira_get_my_filters`

Get all filters owned by the current user

`read:jira-work`

List Groups`jira_list_groups`

Get all groups in the Jira instance

`read:jira-user`

Search Groups`jira_search_groups`

Find groups matching a query for group picker

`read:jira-user`

Get Group Members`jira_get_group_members`

Get members of a specific group

`manage:jira-configuration`

Create Group`jira_create_group`

Create a new group

`manage:jira-configuration`

Delete Group`jira_delete_group`

Delete a group

`manage:jira-configuration`

Create Group Member`jira_create_group_member`

Create a group member (add user to group)

`manage:jira-configuration`

Delete Group Member`jira_delete_group_member`

Delete a group member (remove user from group)

`manage:jira-configuration`

Get Unified Credentials`jira_unified_get_me`

Get the current Jira connection's unified credentials and identity.

`read:jira-user`

List Unified Groups`jira_unified_list_groups`

List unified groups in Jira.

`read:jira-user`

Get Unified Group`jira_unified_get_group`

Get a unified Jira group by ID.

`read:jira-user`

List Unified Roles`jira_unified_list_roles`

List unified roles in Jira.

`read:jira-user`

Get Unified Role`jira_unified_get_role`

Get a unified Jira role by ID.

`read:jira-user`

List Unified Users`jira_unified_list_users`

List unified users in Jira.

`read:jira-user`

Get Unified User`jira_unified_get_user`

Get a unified Jira user by ID.

`read:jira-user`

Get Issue Link Types`jira_get_issue_link_types`

Get all available issue link types

`read:jira-work`

Get Issue Link Type`jira_get_issue_link_type`

Get details of a specific issue link type

`read:jira-work`

Create Issue Link`jira_create_issue_link`

Create a link between two issues

`write:jira-work`

Get Issue Link`jira_get_issue_link`

Get details of a specific issue link

`read:jira-work`

Delete Issue Link`jira_delete_issue_link`

Delete an issue link

`write:jira-work`

Create Issue Link Type`jira_create_issue_link_type`

Create a new issue link type

`manage:jira-configuration`

Update Issue Link Type`jira_update_issue_link_type`

Update an existing issue link type

`manage:jira-configuration`

Delete Issue Link Type`jira_delete_issue_link_type`

Delete an issue link type

`manage:jira-configuration`

Search For Issues Using JQL`jira_search_issues`

Search for issues using the JQL endpoint with nextPageToken pagination

`read:jira-work`

Create Issue`jira_create_issue`

Create a new issue in Jira

`write:jira-work`

Get Issue`jira_get_issue`

Get details of a specific issue by ID or key

`read:jira-work`

Update Issue`jira_update_issue`

Update an existing issue

`write:jira-work`

Delete Issue`jira_delete_issue`

Delete an issue

`write:jira-work`

Assign Issue`jira_assign_issue`

Assign an issue to a user

`write:jira-work`

List Issue Types`jira_list_issue_types`

Get all issue types in the Jira instance

`read:jira-work`

Get Issue Type`jira_get_issue_type`

Get details of a specific issue type

`read:jira-work`

List Labels`jira_list_labels`

Get all labels used in the Jira instance

`read:jira-work`

Get My Permissions`jira_get_my_permissions`

Get permissions for the current user

`read:jira-work`

Get All Permissions`jira_get_all_permissions`

Get all available permission types

`manage:jira-configuration`

Get Bulk Permissions`jira_get_bulk_permissions`

Get permissions for multiple projects and issues in a single request

`read:jira-work`

List Priorities`jira_list_priorities`

Get all issue priorities with pagination and filtering

`read:jira-work`

Get Priority`jira_get_priority`

Get details of a specific priority

`read:jira-work`

List Projects`jira_list_projects`

Get a paginated list of projects visible to the user

`read:jira-work`

Get Project`jira_get_project`

Get details of a specific project

`read:jira-work`

Get Project Statuses`jira_get_project_statuses`

Get all valid statuses for a project grouped by issue type

`read:jira-work`

Get Project Components`jira_get_project_components`

Get all components for a project

`read:jira-work`

Get Project Versions`jira_get_project_versions`

Get all versions for a project

`read:jira-work`

Get Project Issue Types`jira_get_project_issue_types`

Get all issue types available for a project

`read:jira-work`

Create Project`jira_create_project`

Create a new Jira project

`manage:jira-project`

Update Project`jira_update_project`

Update a project's details

`manage:jira-project`

Delete Project`jira_delete_project`

Delete a project

`manage:jira-project`

Archive Project`jira_archive_project`

Archive a project

`manage:jira-project`

Restore Deleted Project`jira_restore_project`

Restore a deleted project

`manage:jira-project`

List Project Roles`jira_list_project_roles`

Get all project roles

`manage:jira-configuration`

Get Project Role`jira_get_project_role`

Get a project role by ID

`manage:jira-configuration`

Create Project Role`jira_create_project_role`

Create a new project role

`manage:jira-configuration`

Delete Project Role`jira_delete_project_role`

Delete a project role

`manage:jira-configuration`

Get Project Role For Project`jira_get_project_role_for_project`

Get a project role and its actors (users/groups) for a specific project

`read:jira-work`

Create Project Role Actor`jira_create_project_role_actor`

Create actors (users or groups) for a project role

`manage:jira-project`

List Remote Issue Links`jira_list_remote_issue_links`

Get all remote links for an issue

`read:jira-work`

Get Remote Issue Link`jira_get_remote_issue_link`

Get a specific remote issue link by ID

`read:jira-work`

Create Remote Issue Link`jira_create_remote_issue_link`

Create a remote issue link

`write:jira-work`

Update Remote Issue Link`jira_update_remote_issue_link`

Update a remote issue link by ID

`write:jira-work`

Delete Remote Issue Link`jira_delete_remote_issue_link`

Delete a remote issue link by ID

`write:jira-work`

Delete Remote Issue Link By Global ID`jira_delete_remote_issue_link_by_global_id`

Delete a remote issue link by its global ID

`write:jira-work`

List Resolutions`jira_list_resolutions`

Get all issue resolutions

`read:jira-work`

Get Resolution`jira_get_resolution`

Get details of a specific resolution

`read:jira-work`

Get Server Info`jira_get_server_info`

Get information about the Jira instance

`read:jira-work`

Get Current User`jira_get_current_user`

Get details of the currently authenticated user

`read:jira-work`

Get Board Sprints`jira_get_board_sprints`

Get all sprints for a board

`read:board-scope:jira-software`

Get Sprint`jira_get_sprint`

Get details of a specific sprint

`read:board-scope:jira-software`

Create Sprint`jira_create_sprint`

Create a new sprint

`write:sprint:jira-software`

Partially Update Sprint`jira_update_sprint`

Update an existing sprint

`write:sprint:jira-software`

Delete Sprint`jira_delete_sprint`

Delete a sprint

`delete:sprint:jira-software`

Get Sprint Issues`jira_get_sprint_issues`

Get all issues in a sprint

`read:sprint:jira-software`

Move Issues To Sprint`jira_move_issues_to_sprint`

Move issues to a sprint

`write:sprint:jira-software`

List Statuses`jira_list_statuses`

Get all statuses in the Jira instance

`manage:jira-configuration`

Get Status`jira_get_status`

Get details of a specific status by ID or name

`read:jira-work`

Get Issue Transitions`jira_get_issue_transitions`

Get available transitions for an issue

`read:jira-work`

Transition Issue`jira_transition_issue`

Transition an issue to a different status

`write:jira-work`

Get All Users`jira_get_all_users`

Get a list of all users (active and inactive)

`read:jira-user`

Get User`jira_get_user`

Get details of a specific user by account ID

`read:jira-user`

Get User Groups`jira_get_user_groups`

Get the groups to which a user belongs

`read:jira-user`

Search Users`jira_search_users`

Search for active users matching a query string

`read:jira-user`

Search Users For Picker`jira_search_users_for_picker`

Find users for user picker with highlighted query matches

`read:jira-user`

Search Users Assignable To Projects`jira_search_users_assignable_to_projects`

Find users who can be assigned issues in one or more projects

`read:jira-user`

Search Users Assignable To Issues`jira_search_users_assignable_to_issues`

Find users who can be assigned to a specific issue

`read:jira-user`

Search Users With Permissions`jira_search_users_with_permissions`

Find users who have a set of permissions for a project or issue

`read:jira-user`

Search Users With Browse Permission`jira_search_users_with_browse_permission`

Find users who have permission to browse issues in a project or specific issue

`read:jira-user`

Create Version`jira_create_version`

Create a new project version

`manage:jira-project`

Get Version`jira_get_version`

Get details of a specific version

`read:jira-work`

Update Version`jira_update_version`

Update an existing version

`manage:jira-project`

Delete Version`jira_delete_version`

Delete a project version

`manage:jira-project`

List Issue Votes`jira_list_issue_votes`

Get vote information for an issue

`read:jira-work`

Create Issue Vote`jira_create_issue_vote`

Add a vote to an issue for the current user

`write:jira-work`

Delete Issue Vote`jira_delete_issue_vote`

Remove a vote from an issue for the current user

`write:jira-work`

List Issue Watchers`jira_list_issue_watchers`

Get the list of watchers for an issue

`read:jira-work`

Create Issue Watcher`jira_create_issue_watcher`

Add a user as a watcher to an issue

`write:jira-work`

Delete Issue Watcher`jira_delete_issue_watcher`

Remove a user as a watcher from an issue

`write:jira-work`

Search Workflows`jira_search_workflows`

Search for workflows in Jira

`manage:jira-configuration`

List Workflow Schemes`jira_list_workflow_schemes`

Get all workflow schemes

`manage:jira-configuration`

Get Workflow Scheme`jira_get_workflow_scheme`

Get a workflow scheme by ID

`manage:jira-configuration`

List Issue Worklogs`jira_list_issue_worklogs`

Get all worklogs for an issue

`read:jira-work`

Create Issue Worklog`jira_create_issue_worklog`

Add a worklog entry to an issue

`write:jira-work`

Get Issue Worklog`jira_get_issue_worklog`

Get a specific worklog entry from an issue

`read:jira-work`

Update Issue Worklog`jira_update_issue_worklog`

Update a worklog entry on an issue

`write:jira-work`

Delete Issue Worklog`jira_delete_issue_worklog`

Delete a worklog entry from an issue

`write:jira-work`

## Events

Tags

Select all
|
Clear

Attachments

Boards

Comments

Filters

Issue Links

Issue Types

Issues

Options

Projects

Sprints

Users

Versions

Webhooks

Worklogs

No tags found

47 events

EventDescriptionTags

Issue Created`jira_webhook_issue_created`

Triggered when a new issue is created in Jira. Includes issue details such as type, priority, assignee, and project.

IssuesWebhooks

Issue Updated`jira_webhook_issue_updated`

Triggered when an existing issue is modified in Jira. Includes changelog with field-level changes such as status transit...

IssuesWebhooks

Issue Deleted`jira_webhook_issue_deleted`

Triggered when an issue is permanently deleted from Jira. Includes the deleted issue details.

IssuesWebhooks

Comment Created`jira_webhook_comment_created`

Triggered when a new comment is added to a Jira issue. Includes the comment body, author, and associated issue details.

IssuesCommentsWebhooks

Comment Updated`jira_webhook_comment_updated`

Triggered when an existing comment is edited on a Jira issue. Includes the updated comment body and author details.

IssuesCommentsWebhooks

Comment Deleted`jira_webhook_comment_deleted`

Triggered when a comment is removed from a Jira issue. Includes the deleted comment details and associated issue.

IssuesCommentsWebhooks

Worklog Created`jira_webhook_worklog_created`

Triggered when a new worklog entry is added to a Jira issue. Includes time spent, author, and associated issue details.

IssuesWorklogsWebhooks

Worklog Updated`jira_webhook_worklog_updated`

Triggered when an existing worklog entry is modified on a Jira issue. Includes updated time spent and author details.

IssuesWorklogsWebhooks

Worklog Deleted`jira_webhook_worklog_deleted`

Triggered when a worklog entry is removed from a Jira issue. Includes the deleted worklog details.

IssuesWorklogsWebhooks

Sprint Created`jira_webhook_sprint_created`

Triggered when a new sprint is created in a Jira board. Includes sprint name, board, and date details.

SprintsWebhooks

Sprint Updated`jira_webhook_sprint_updated`

Triggered when a sprint is modified in Jira, such as name or date changes. Includes updated sprint details.

SprintsWebhooks

Sprint Started`jira_webhook_sprint_started`

Triggered when a sprint is started (moved to active state) in Jira. Includes sprint start and end dates.

SprintsWebhooks

Sprint Closed`jira_webhook_sprint_closed`

Triggered when a sprint is completed/closed in Jira. Includes sprint completion date and final details.

SprintsWebhooks

Sprint Deleted`jira_webhook_sprint_deleted`

Triggered when a sprint is permanently deleted from a Jira board.

SprintsWebhooks

Project Created`jira_webhook_project_created`

Triggered when a new project is created in Jira. Includes project key, name, lead, and configuration details.

ProjectsWebhooks

Project Updated`jira_webhook_project_updated`

Triggered when a project is modified in Jira, such as name, lead, or configuration changes.

ProjectsWebhooks

Project Deleted`jira_webhook_project_deleted`

Triggered when a project is permanently deleted from Jira.

ProjectsWebhooks

Project Soft Deleted`jira_webhook_project_soft_deleted`

Triggered when a project is moved to the trash in Jira (soft delete with undo option). The project can be restored withi...

ProjectsWebhooks

Project Restored Deleted`jira_webhook_project_restored_deleted`

Triggered when a previously soft-deleted project is restored from the Jira trash.

ProjectsWebhooks

Version Created`jira_webhook_version_created`

Triggered when a new version (fix version) is created in a Jira project. Includes version name and project details.

VersionsWebhooks

Version Updated`jira_webhook_version_updated`

Triggered when a version is modified in Jira, such as name or description changes.

VersionsWebhooks

Version Moved`jira_webhook_version_moved`

Triggered when a version is reordered within a Jira project version list.

VersionsWebhooks

Version Released`jira_webhook_version_released`

Triggered when a version is marked as released in Jira. Includes the release date.

VersionsWebhooks

Version Unreleased`jira_webhook_version_unreleased`

Triggered when a previously released version is marked as unreleased in Jira.

VersionsWebhooks

Version Deleted`jira_webhook_version_deleted`

Triggered when a version is deleted from a Jira project. Also triggered when versions are merged.

VersionsWebhooks

Board Created`jira_webhook_board_created`

Triggered when a new board (Scrum or Kanban) is created in Jira.

BoardsWebhooks

Board Updated`jira_webhook_board_updated`

Triggered when a board is modified in Jira, such as name or filter changes.

BoardsWebhooks

Board Deleted`jira_webhook_board_deleted`

Triggered when a board is deleted from Jira.

BoardsWebhooks

Board Configuration Changed`jira_webhook_board_configuration_changed`

Triggered when a board configuration is changed in Jira, such as column mappings, swimlanes, or estimation settings.

BoardsWebhooks

User Created`jira_webhook_user_created`

Triggered when a new user account is created in the Jira instance.

UsersWebhooks

User Updated`jira_webhook_user_updated`

Triggered when a user account is modified in Jira, such as display name or email changes. Note - group membership change...

UsersWebhooks

User Deleted`jira_webhook_user_deleted`

Triggered when a user account is removed from the Jira instance.

UsersWebhooks

Attachment Created`jira_webhook_attachment_created`

Triggered when a file attachment is added to a Jira issue. Includes the attachment filename, size, and author.

AttachmentsWebhooks

Attachment Deleted`jira_webhook_attachment_deleted`

Triggered when a file attachment is removed from a Jira issue.

AttachmentsWebhooks

Issue Link Created`jira_webhook_issuelink_created`

Triggered when a link is created between two Jira issues (e.g., blocks, duplicates, relates to).

Issue LinksWebhooks

Issue Link Deleted`jira_webhook_issuelink_deleted`

Triggered when a link between two Jira issues is removed.

Issue LinksWebhooks

Issue Type Created`jira_webhook_issuetype_created`

Triggered when a new issue type is created in Jira (e.g., Bug, Story, Task).

Issue TypesWebhooks

Issue Type Updated`jira_webhook_issuetype_updated`

Triggered when an issue type is modified in Jira, such as name or description changes.

Issue TypesWebhooks

Issue Type Deleted`jira_webhook_issuetype_deleted`

Triggered when an issue type is removed from Jira.

Issue TypesWebhooks

Unassigned Issues Option Changed`jira_webhook_option_unassigned_issues_changed`

Triggered when the "Allow unassigned issues" setting is toggled in Jira General Configuration.

OptionsWebhooks

Subtasks Option Changed`jira_webhook_option_subtasks_changed`

Triggered when the sub-tasks feature is enabled or disabled in Jira Issue Settings.

OptionsWebhooks

Issue Links Option Changed`jira_webhook_option_issuelinks_changed`

Triggered when the issue linking feature is enabled or disabled in Jira Issue Settings.

OptionsWebhooks

Time Tracking Option Changed`jira_webhook_option_timetracking_changed`

Triggered when the time tracking feature is enabled or disabled in Jira Issue Settings.

OptionsWebhooks

Time Tracking Provider Option Changed`jira_webhook_option_timetracking_provider_changed`

Triggered when the time tracking provider is changed in Jira Issue Settings.

OptionsWebhooks

Filter Created`jira_webhook_filter_created`

Triggered when a new saved filter (JQL query) is created in Jira.

FiltersWebhooks

Filter Updated`jira_webhook_filter_updated`

Triggered when a saved filter is modified in Jira, such as JQL query or name changes.

FiltersWebhooks

Filter Deleted`jira_webhook_filter_deleted`

Triggered when a saved filter is removed from Jira.

FiltersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.