Jira

Jira is a project and issue-tracking system developed by Atlassian, commonly used for managing software development workflows and organizational tasks. It provides tools for creating, assigning, and tracking issues such as bugs, feature requests, and project tasks. Teams use Jira to structure work into projects, boards, sprints, and workflows, allowing different methodologies—like Scrum, Kanban, or custom processes—to be represented. It stores detailed information about each issue, including status, comments, attachments, time estimates, and relationships to other tasks.

The Jira API is a REST-based interface that gives external applications structured access to Jira data. Through the API, developers can perform operations such as creating issues, updating fields, transitioning workflow states, retrieving project metadata, or searching using Jira Query Language (JQL). The API also supports user and permission management, attachments, and custom fields. It is used to integrate Jira with development tools, automation systems, reporting dashboards, or custom internal applications, enabling teams to extend Jira’s functionality or synchronize information across systems.

Documentation URL: https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/

Installable Elements              (No items selected)



Base Elements

These elements are required for the templates below to work

Announcement banner

This resource represents an announcement banner. Use it to retrieve and update banner configuration.

  • Returns the current announcement banner configuration.

  • Updates the announcement banner configuration.

App data policies

This resource represents app access rule data policies.

  • Returns data policy for the workspace.

  • Returns data policies for the projects specified in the request.

App migration

This resource supports App Migrations

  • Updates the value of a custom field added by Connect apps on one or more issues.

  • Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for use by Connect apps during app migration.

  • Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

App properties

This resource represents app properties. Use it to store arbitrary data for your Connect App

  • Gets all the properties of an app.

  • Returns the key and value of an app's property.

  • Sets the value of an app's property. Use this resource to store custom data for your app.

  • Deletes an app's property.

  • Returns all property keys for the Forge app.

  • Returns the value of a Forge app's property.

  • Sets the value of a Forge app's property.

  • Deletes a Forge app's property.

Application roles

This resource represents application roles. Use it to get details of an application role or all application roles.

  • Returns all application roles.

  • Returns an application role.

Audit records

This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records.

  • Returns a list of audit records.

Avatars

This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project, issue type or priority and obtain avatar images.

  • Returns a list of system avatar details by owner type, where the owner types are issue type, project, user or priority.

  • Returns the system and custom avatars for a project, issue type or priority.

  • Loads a custom avatar for a project, issue type or priority.

  • Deletes an avatar from a project, issue type or priority.

  • Returns the default project, issue type or priority avatar image.

  • Returns a project, issue type or priority avatar image by ID.

  • Returns the avatar image for a project, issue type or priority.

Classification levels

This resource represents classification levels.

  • Returns all classification levels.

Dashboards

This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards.

  • Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

  • Creates a dashboard.

  • Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100.

  • Gets a list of all available gadgets that can be added to all dashboards.

  • Returns a paginated list of dashboards. This operation is similar to Get Dashboards

  • Returns a list of dashboard gadgets on a dashboard.

  • Adds a gadget to a dashboard.

  • Changes the title, position, and color of the gadget on a dashboard.

  • Removes a dashboard gadget from a dashboard.

  • Returns the keys of all properties for a dashboard item.

  • Returns the key and value of a dashboard item property.

  • Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

  • Deletes a dashboard item property.

  • Returns a dashboard.

  • Updates a dashboard, replacing all the dashboard details with those provided.

  • Deletes a dashboard.

  • Copies a dashboard. Any values provided in the `dashboard` parameter replace those in the copied dashboard.

Dynamic modules

This resource represents Modules Registered Dynamically

  • Returns all modules registered dynamically by the calling app.

  • Registers a list of modules.

  • Remove all or a list of modules registered by the calling app.

Field schemes

This resource represents field schemes which are replacing field configuration schemes to control field associations. They are currently in beta and only available to customers who have opted-in to the beta program.

  • REST endpoint for retrieving a paginated list of field association schemes with optional filtering.

  • Endpoint for creating a new field association scheme.

  • Update fields associated with field association schemes.

  • Remove fields associated with field association schemes.

  • Update field association item parameters in field association schemes.

  • Remove field association parameters overrides for work types.

  • Get projects with field association schemes. This will be a temporary API but useful when transitioning from the legacy field configuration APIs to the new ones.

  • Associate projects to field association schemes.

  • Endpoint for fetching a field association scheme by its ID.

  • Endpoint for updating an existing field association scheme.

  • Delete a specified field association scheme

  • Search for fields belonging to a given field association scheme.

  • Retrieve field association parameters on a field association scheme.

  • REST Endpoint for searching for projects belonging to a given field association scheme.

Filter sharing

This resource represents options for sharing filters. Use it to get share scopes as well as add and remove share scopes from filters.

  • Returns the default sharing settings for new filters and dashboards for a user.

  • Sets the default sharing for new filters and dashboards for a user.

  • Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

  • Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

  • Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

  • Deletes a share permission from a filter.

Filters

This resource represents filters. Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.

  • Creates a filter.

  • Returns the visible favorite filters of the user.

  • Returns the filters owned by the user.

  • Returns a paginated list of filters.

  • Returns a filter.

  • Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

  • Delete a filter.

  • Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

  • Sets the columns for a filter. Only navigable fields can be set as columns.

  • Reset the user's column configuration for the filter to the default.

  • Add a filter as a favorite for the user.

  • Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list.

  • Changes the owner of the filter.

Group and user picker

This resource represents a list of users and a list of groups. Use it to obtain the details to populate user and group picker suggestions list.

  • Returns a list of users and groups matching a string.

Groups

This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups.

  • Creates a group.

  • Deletes a group.

  • Returns a paginated list of groups.

  • Returns a paginated list of all users in a group.

  • Adds a user to a group.

  • Removes a user from a group.

  • Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results.

Issue attachments

This resource represents issue attachments and the attachment settings for Jira. Use it to get the metadata for an attachment, delete an attachment, and view the metadata for the contents of an attachment. Also, use it to get the attachment settings for Jira.

  • Returns the contents of an attachment. A `Range` header can be set to define a range of bytes within the attachment to download.

  • Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.

  • Returns the thumbnail of an attachment.

  • Returns the metadata for an attachment. Note that the attachment itself is not returned.

  • Deletes an attachment from an issue.

  • Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself.

  • Returns the metadata for the contents of an attachment, if it is an archive.

Issue bulk operations

This resource represents the issue bulk operations. Use it to move multiple issues from one project to another project or edit fields of multiple issues in one go.

  • Use this API to submit a bulk delete request. You can delete up to 1,000 issues in a single operation.

  • Use this API to get a list of fields visible to the user to perform bulk edit operations. You can pass single or multiple issues in the query to get eligible editable fields. This API uses pagination to return responses, delivering 50 fields at a time.

  • Use this API to submit a bulk edit request and simultaneously edit multiple issues. There are limits applied to the number of issues and fields that can be edited. A single request can accommodate a maximum of 1000 issues (including subtasks) and 200 fields.

  • Use this API to submit a bulk issue move request. You can move multiple issues from multiple projects in a single request, but they must all be moved to a single project, issue type, and parent.

  • Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk transition operations. You can submit either single or multiple issues in the query to obtain the available transitions.

  • Use this API to submit a bulk issue status transition request. You can transition multiple issues, alongside with their valid transition Ids. You can transition up to 1,000 issues in a single operation.

  • Use this API to submit a bulk unwatch request. You can unwatch up to 1,000 issues in a single operation.

  • Use this API to submit a bulk watch request. You can watch up to 1,000 issues in a single operation.

  • Use this to get the progress state for the specified bulk operation `taskId`.

Issue comment properties

This resource represents issue comment properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issue comment properties as well as obtain the keys of all properties on a comment. Comment properties are a type of entity property.

  • Returns the keys of all the properties of a comment.

  • Returns the value of a comment property.

  • Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

  • Deletes a comment property.

Issue comments

This resource represents issue comments.

  • Returns a paginated list of comments specified by a list of comment IDs.

  • Returns all comments for an issue.

  • Adds a comment to an issue.

  • Returns a comment.

  • Updates a comment.

  • Deletes a comment.

Issue custom field associations

This resource represents the fields associated to project and issue type contexts.

  • Associates fields with projects.

  • Unassociates a set of fields with a project and issue type context.

Issue custom field configuration (apps)

This resource represents configurations stored against a custom field context by a Forge app. Configurations are information used by the Forge app at runtime to determine how to handle or process the data in a custom field in a given context. Use this resource to set and read configurations.

  • Returns a paginated list of configurations for list of custom fields of a type created by a Forge app.

  • Returns a paginated list of configurations for a custom field of a type created by a Forge app.

  • Update the configuration for contexts of a custom field of a type created by a Forge app.

Issue custom field contexts

This resource represents issue custom field contexts.

  • Returns a paginated list of contexts for a custom field.

  • Creates a custom field context.

  • Returns a paginated list of defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned.

  • Sets default for contexts of a custom field.

  • Returns a paginated list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.

  • Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type.

  • Returns a paginated list of context to project mappings for a custom field. The result can be filtered by `contextId`. Otherwise, all mappings are returned. Invalid IDs are ignored.

  • Updates a custom field context.

  • Deletes a custom field context.

  • Adds issue types to a custom field context, appending the issue types to the issue types list.

  • Removes issue types from a custom field context.

  • Assigns a custom field context to projects.

  • Removes a custom field context from projects.

Issue custom field options

This resource represents custom issue field select list options created in Jira or using the REST API.

  • Returns a custom field option. For example, an option in a select list.

  • Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira.

  • Updates the options of a custom field.

  • Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field.

  • Changes the order of custom field options or cascading options in a context.

  • Deletes a custom field option.

  • Replaces the options of a custom field.

Issue custom field options (apps)

This resource represents custom issue field select list options created by a Connect app.

  • Returns a paginated list of all the options of a select list issue field. A select list issue field is a type of issue field that enables a user to select a value from a list of options.

  • Creates an option for a select list issue field.

  • Returns a paginated list of options for a select list issue field that can be viewed and selected by the user.

  • Returns a paginated list of options for a select list issue field that can be viewed by the user.

  • Returns an option from a select list issue field.

  • Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.

  • Deletes an option from a select list issue field.

  • Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.

Issue custom field values (apps)

This resource represents the values of custom fields added by Forge apps. Use it to update the value of a custom field on issues.

  • Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request.

  • Updates the value of a custom field on one or more issues.

Issue field configurations

This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes.

  • Returns a paginated list of field configurations.

  • Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

  • Updates a field configuration. The name and the description provided in the request override the existing values.

  • Deletes a field configuration.

  • Returns a paginated list of all fields for a configuration.

  • Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

  • Returns a paginated list of field configuration schemes.

  • Creates a field configuration scheme.

  • Returns a paginated list of field configuration issue type items.

  • Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.

  • Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme.

  • Updates a field configuration scheme.

  • Deletes a field configuration scheme.

  • Assigns issue types to field configurations on field configuration scheme.

  • Removes issue types from the field configuration scheme.

Issue fields

This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields.

  • Returns system and custom issue fields.

  • Creates a custom field.

  • Returns a paginated list of fields for Classic Jira projects.

  • Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string.

  • Updates a custom field.

  • Deletes a custom field. The custom field is deleted whether it is in the trash or not.

  • Restores a custom field from trash.

  • Moves a custom field to trash.

  • Returns a paginated list of fields for the requested projects and work types.

Issue link types

This resource represents issue link.

  • Returns a list of all issue link types.

  • Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked.

  • Returns an issue link type.

  • Updates an issue link type.

  • Deletes an issue link type.

Issue links

This resource represents links between issues. Use it to get, create, and delete links between issues.

  • Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue.

  • Returns an issue link.

  • Deletes an issue link.

Issue navigator settings

This resource represents issue navigator settings. Use it to get and set issue navigator default columns.

  • Returns the default issue navigator columns.

  • Sets the default issue navigator columns.

Issue notification schemes

This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes.

  • Returns a paginated list of notification schemes ordered by the display name.

  • Creates a notification scheme with notifications. You can create up to 1000 notifications per request.

  • Returns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings.

  • Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

  • Updates a notification scheme.

  • Adds notifications to a notification scheme. You can add up to 1000 notifications per request.

  • Deletes a notification scheme.

  • Removes a notification from a notification scheme.

Issue priorities

This resource represents issue priorities. Use it to get, create and update issue priorities and details for individual issue priorities.

  • Returns the list of all issue priorities.

  • Creates an issue priority.

  • Sets default issue priority.

  • Changes the order of issue priorities.

  • Returns a paginated list of priorities.

  • Returns an issue priority.

  • Updates an issue priority.

  • Deletes an issue priority.

Issue properties

This resource represents issue properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as obtain details of all properties on an issue.

  • Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified along with up to 10,000 issues on which to set or update that list of entity properties.

  • Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up to 100 issues included in the request.

  • Sets a property value on multiple issues.

  • Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

  • Returns the URLs and keys of an issue's properties.

  • Returns the key and value of an issue's property.

  • Sets the value of an issue's property. Use this resource to store custom data against an issue.

  • Deletes an issue's property.

Issue redaction

This resource represents Issue Redaction. Provides APIs to redact issue data.

  • Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

  • Retrieves the current status of a redaction job ID.

Issue remote links

This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier.

  • Returns the remote issue links for an issue.

  • Creates or updates a remote issue link for an issue.

  • Deletes the remote issue link from the issue using the link's global ID.

  • Returns a remote issue link for an issue.

  • Updates a remote issue link for an issue.

  • Deletes a remote issue link from an issue.

Issue resolutions

This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values.

  • Returns a list of all issue resolution values.

  • Creates an issue resolution.

  • Sets default issue resolution.

  • Changes the order of issue resolutions.

  • Returns a paginated list of resolutions.

  • Returns an issue resolution value.

  • Updates an issue resolution.

  • Deletes an issue resolution.

Issue search

This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker.

  • Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

  • Checks whether one or more issues would be returned by one or more JQL queries.

  • Provide an estimated count of the issues that match the JQL.

  • Searches for issues using JQL. Recent updates might not be immediately visible in the returned search results.

  • Searches for issues using JQL. Recent updates might not be immediately visible in the returned search results.

Issue security level

This resource represents issue security levels. Use it to obtain the details of any issue security level.

  • Returns issue security level members.

  • Returns details of an issue security level.

Issue security schemes

This resource represents issue security schemes. Use it to get an issue security scheme or a list of issue security schemes.

  • Returns all issue security schemes.

  • Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme levels and security scheme levels' members per request.

  • Returns a paginated list of issue security levels.

  • Sets default issue security levels for schemes.

  • Returns a paginated list of issue security level members.

  • Returns a paginated mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by.

  • Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided.

  • Returns a paginated list of issue security schemes.

  • Returns an issue security scheme along with its security levels.

  • Updates the issue security scheme.

  • Deletes an issue security scheme.

  • Adds levels and levels' members to the issue security scheme. You can add up to 100 levels per request.

  • Updates the issue security level.

  • Deletes an issue security level.

  • Adds members to the issue security level. You can add up to 100 members per request.

  • Removes an issue security level member from an issue security scheme.

Issue type properties

This resource represents issue type properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of entity property.

  • Returns all the issue type property keys of the issue type.

  • Returns the key and value of the issue type property.

  • Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.

  • Deletes the issue type property.

Issue type schemes

This resource represents issue type schemes in classic projects.

  • Returns a paginated list of issue type schemes.

  • Creates an issue type scheme.

  • Returns a paginated list of issue type scheme items.

  • Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.

  • Assigns an issue type scheme to a project.

  • Updates an issue type scheme.

  • Deletes an issue type scheme.

  • Adds issue types to an issue type scheme.

  • Changes the order of issue types in an issue type scheme.

  • Removes an issue type from an issue type scheme.

Issue type screen schemes

This resource represents issue type screen schemes.

  • Returns a paginated list of issue type screen schemes.

  • Creates an issue type screen scheme.

  • Returns a paginated list of issue type screen scheme items.

  • Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.

  • Assigns an issue type screen scheme to a project.

  • Updates an issue type screen scheme.

  • Deletes an issue type screen scheme.

  • Appends issue type to screen scheme mappings to an issue type screen scheme.

  • Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.

  • Removes issue type to screen scheme mappings from an issue type screen scheme.

  • Returns a paginated list of projects associated with an issue type screen scheme.

Issue types

This resource represents issues types.

  • Returns all issue types.

  • Creates an issue type and adds it to the default issue type scheme.

  • Returns issue types for a project.

  • Returns an issue type.

  • Updates the issue type.

  • Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (`alternativeIssueTypeId`).

  • Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

  • Loads an avatar for the issue type.

Issue votes

This resource represents votes cast by users on an issue. Use it to get details of votes on an issue as well as cast and withdrawal votes.

  • Returns details about the votes on an issue.

  • Adds the user's vote to an issue. This is the equivalent of the user clicking *Vote* on an issue in Jira.

  • Deletes a user's vote from an issue. This is the equivalent of the user clicking *Unvote* on an issue in Jira.

Issue watchers

This resource represents users watching an issue. Use it to get details of users watching an issue as well as start and stop a user watching an issue.

  • Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned watched status is `false`.

  • Returns the watchers for an issue.

  • Adds a user as a watcher of an issue by passing the account ID of the user.

  • Deletes a user as a watcher of an issue.

Issue worklog properties

This resource represents issue worklog properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete issue worklog properties as well as obtain the keys of all properties on a issue worklog. Issue worklog properties are a type of entity property.

  • Returns the keys of all properties for a worklog.

  • Returns the value of a worklog property.

  • Sets the value of a worklog property. Use this operation to store custom data against the worklog.

  • Deletes a worklog property.

Issue worklogs

This resource represents issue worklogs.

  • Returns worklogs for an issue (ordered by created time), starting from the oldest worklog or from the worklog started on or after a date and time.

  • Adds a worklog to an issue.

  • Deletes a list of worklogs from an issue.

  • Moves a list of worklogs from one issue to another.

  • Returns a worklog.

  • Updates a worklog.

  • Deletes a worklog from an issue.

  • Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.

  • Returns worklog details for a list of worklog IDs.

  • Returns a list of IDs and update timestamps for worklogs updated after a date and time.

Issues

This resource represents Jira issues.

  • Bulk fetch changelogs for multiple issues and filter by fields.

  • Returns all issue events.

  • Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.

  • Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.

  • Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request.

  • Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks.

  • Returns the details for a set of requested issues. You can request up to 100 issues.

  • Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user.

  • Returns a page of issue type metadata for a specified project.

  • Returns a page of field metadata for a specified project and issuetype id.

  • Returns all issues breaching and approaching per-issue limits.

  • Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any.

  • Returns the details for an issue.

  • Edits an issue. Issue properties may be updated as part of the edit.

  • Deletes an 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.

  • Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest.

  • Returns changelogs for an issue specified by a list of changelog IDs.

  • Returns the edit screen fields for an issue that are visible to and editable by the user.

  • Creates an email notification for an issue and adds it to the mail queue.

  • Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.

  • Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.

  • Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details.

JQL

This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom query builders.

  • Returns reference data for JQL searches.

  • Returns reference data for JQL searches.

  • Returns the JQL search auto complete suggestions for a field.

  • Parses and validates JQL queries.

  • Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

  • Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity.

JQL functions (apps)

This resource represents JQL function's precomputations. Precomputation is a mapping between custom function call and JQL fragment returned by this function. Use it to get and update precomputations.

  • Returns the list of a function's precomputations along with information about when they were created, updated, and last used.

  • Update the precomputation value of a function created by a Forge/Connect app.

  • Returns function precomputations by IDs, along with information about when they were created, updated, and last used.

Jira expressions

This resource is a collection of operations for Jira expressions.

  • Analyses and validates Jira expressions.

  • Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint uses the enhanced search API when evaluating JQL queries.

Jira settings

This resource represents various settings in Jira. Use it to get and update Jira settings and properties.

  • Returns all application properties or an application property.

  • Returns the application properties that are accessible on the *Advanced Settings* page.

  • Changes the value of an application property.

  • Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled.

Labels

This resource represents available labels. Use it to get available labels for the global label field.

  • Returns a paginated list of labels.

License metrics

This resource represents license metrics. Use it to get available metrics for Jira licences.

  • Returns licensing information about the Jira instance.

  • Returns the approximate number of user accounts across all Jira licenses.

  • Returns the total approximate number of user accounts for a single Jira license.

Migration of Connect modules to Forge

This resource supports the migration of some Connect modules to their equivalent Forge modules.

  • Returns the details of a Connect issue field's migration to Forge.

Myself

This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale.

  • Returns the value of a preference of the current user.

  • Creates a preference for the user or updates a preference's value by sending a plain text string.

  • Deletes a preference of the user, which restores the default value of system defined settings.

  • Returns the locale for the user.

  • Returns details for the current user.

Permission schemes

This resource represents permission schemes. Use it to get, create, update, and delete permission schemes as well as get, create, update, and delete details of the permissions granted in those schemes.

  • Returns all permission schemes.

  • Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

  • Returns a permission scheme.

  • Updates a permission scheme.

  • Deletes a permission scheme.

  • Returns all permission grants for a permission scheme.

  • Creates a permission grant in a permission scheme.

  • Returns a permission grant.

  • Deletes a permission grant from a permission scheme.

Permissions

This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.

  • Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.

  • Returns all permissions, including global permissions, project permissions or global permissions added by plugins.

  • Returns the global permissions granted to a user.

  • Returns all the projects where the user is granted a list of project permissions.

Plans

This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans.

  • Returns a paginated list of plans.

  • Creates a plan.

  • Returns a plan.

  • Updates details of a plan using JSON Patch.

  • Archives a plan.

  • Duplicates a plan.

  • Moves a plan to trash.

Priority schemes

This resource represents issue priority schemes. Use it to get priority schemes and related information, and to create, update and delete priority schemes.

  • Returns a paginated list of priority schemes.

  • Creates a new priority scheme.

  • Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme.

  • Returns a paginated list of priorities available for adding to a priority scheme.

  • Updates a priority scheme.

  • Deletes a priority scheme.

  • Returns a paginated list of priorities by scheme.

  • Returns a paginated list of projects by scheme.

Project avatars

This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars.

  • Sets the avatar displayed for a project.

  • Deletes a custom avatar from a project. Note that system avatars cannot be deleted.

  • Loads an avatar for a project.

  • Returns all project avatars, grouped by system and custom avatars.

Project categories

This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories.

  • Returns all project categories.

  • Creates a project category.

  • Returns a project category.

  • Updates a project category.

  • Deletes a project category.

Project classification levels

This resource represents classification levels used in a project. Use it to view and manage classification levels in your projects.

  • Returns the default data classification for a project.

  • Updates the default data classification level for a project.

  • Remove the default data classification level for a project.

Project components

This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component.

  • Returns a paginated list of all components in a project, including global (Compass) components when applicable.

  • Creates a component. Use components to provide containers for issues within a project.

  • Returns a component.

  • Updates a component. Any fields included in the request are overwritten.

  • Deletes a component.

  • Returns the counts of issues assigned to the component.

  • Returns a paginated list of all components in a project.

  • Returns all components in a project.

Project email

This resource represents the email address used to send a project's notifications. Use it to get and set the project's sender email address.

  • Returns the project's sender email address.

  • Sets the project's sender email address.

Project features

This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects.

  • Returns the list of features for a project.

  • Sets the state of a project feature.

Project key and name validation

This resource provides validation for project keys and names.

  • Validates a project key by confirming the key is a valid string and not in use.

  • Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

  • Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number.

Project permission schemes

This resource represents permission schemes for a project.

  • Returns the issue security scheme associated with the project.

  • Gets the permission scheme associated with the project.

  • Assigns a permission scheme with a project.

  • Returns all issue security levels for the project that the user has access to.

Project properties

This resource represents project properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of entity property.

  • Returns all project property keys for the project.

  • Returns the value of a project property.

  • Sets the value of the project property. You can use project properties to store custom data against the project.

  • Deletes the project from a project.

Project role actors

This resource represents the users assigned to project roles. Use it to get, add, and remove default users from project roles. Also use it to add and remove users from a project role associated with a project.

  • Sets the actors for a project role for a project, replacing all existing actors.

  • Adds actors to a project role for the project.

  • Deletes actors from a project role for the project.

  • Returns the default actors for the project role.

  • Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.

  • Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.

Project roles

This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.

  • Returns a list of project roles for the project returning the name and self URL for each role.

  • Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.

  • Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.

  • Gets a list of all project roles, complete with project role details and default actors.

  • Creates a new project role with no default actors.

  • Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.

  • Updates the project role's name and description. You must include both a name and a description in the request.

  • Updates either the project role's name or its description.

  • Deletes a project role.

Project templates

This resource represents project templates. Use it to create a new project from a custom template.

  • Creates a project based on a custom template provided in the request.

  • Edit custom template

  • Get custom template

  • Remove custom template

  • Save custom template

Project types

This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type.

  • Returns all project types, whether or not the instance has a valid license for each type.

  • Returns all project types with a valid license.

  • Returns a project type.

  • Returns a project type if it is accessible to the user.

Project versions

This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by version.

  • Returns a paginated list of all versions in a project.

  • Returns all versions in a project. The response is not paginated.

  • Creates a project version.

  • Returns a project version.

  • Updates a project version.

  • Deletes a project version.

  • Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`.

  • Modifies the version's sequence within the project, which affects the display order of the versions in Jira.

  • Returns the version's related issues count

  • Returns related work items for the given version id.

  • Updates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited.

  • Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided.

  • Deletes a project version.

  • Returns counts of the issues and unresolved issues for the project version.

  • Deletes the given related work for the given version.

Projects

This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type.

  • Creates a project based on a project type template

  • Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.

  • Returns a paginated list of projects visible to the user.

  • Returns the project details for a project.

  • Updates the project details of a project.

  • Deletes a project.

  • Archives a project.

  • Deletes a project asynchronously.

  • Restores a project that has been archived or placed in the Jira recycle bin.

  • Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

  • Get the issue type hierarchy for a next-gen project.

  • Gets a notification scheme associated with the project.

Screen schemes

This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes.

  • Returns a paginated list of screen schemes.

  • Creates a screen scheme.

  • Updates a screen scheme. Only screen schemes used in classic projects can be updated.

  • Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

Screen tab fields

This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs.

  • Returns all fields for a screen tab.

  • Adds a field to a screen tab.

  • Removes a field from a screen tab.

  • Moves a screen tab field.

Screen tabs

This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs.

  • Returns the list of tabs for a bulk of screens.

  • Returns the list of tabs for a screen.

  • Creates a tab for a screen.

  • Updates the name of a screen tab.

  • Deletes a screen tab.

  • Moves a screen tab.

Screens

This resource represents the screens used to record issue details.

  • Returns a paginated list of the screens a field is used in.

  • Returns a paginated list of all screens or those specified by one or more screen IDs.

  • Creates a screen with a default field tab.

  • Adds a field to the default tab of the default screen.

  • Updates a screen. Only screens used in classic projects can be updated.

  • Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.

  • Returns the fields that can be added to a tab on a screen.

Server info

This resource provides information about the Jira instance.

  • Returns information about the Jira instance.

Service Registry

This resource represents a service registry. Use it to retrieve attributes related to a service registry in JSM.

  • Retrieve the attributes of given service registries.

Status

This resource represents statuses. Use it to search, get, create, delete, and change statuses.

  • Returns a list of the statuses specified by one or more status IDs.

  • Updates statuses by ID.

  • Creates statuses for a global or project scope.

  • Deletes statuses by ID.

  • Returns a list of the statuses specified by one or more status names.

  • Returns a paginated list of statuses that match a search on name or project.

  • Returns a page of issue types in a project using a given status.

  • Returns a page of projects using a given status.

  • Returns a page of workflows using a given status.

Tasks

This resource represents a long-running asynchronous tasks. Use it to obtain details about the progress of a long-running task or cancel a long-running task.

  • Returns the status of a long-running asynchronous task.

  • Cancels a task.

Teams in plan

This resource represents planning settings for plan-only and Atlassian teams in a plan. Use it to get, create, update and delete planning settings.

  • Returns a paginated list of plan-only and Atlassian teams in a plan.

  • Adds an existing Atlassian team to a plan and configures their plannning settings.

  • Returns planning settings for an Atlassian team in a plan.

  • Updates any of the following planning settings of an Atlassian team in a plan using JSON Patch.

  • Removes an Atlassian team from a plan and deletes their planning settings.

  • Creates a plan-only team and configures their planning settings.

  • Returns planning settings for a plan-only team.

  • Updates any of the following planning settings of a plan-only team using JSON Patch.

  • Deletes a plan-only team and their planning settings.

Time tracking

This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking.

  • Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

  • Selects a time tracking provider.

  • Returns all time tracking providers.

  • Returns the time tracking settings. This includes settings such as the time format, default time unit, and others.

  • Sets the time tracking settings.

UI modifications (apps)

UI modifications is a feature available for Forge apps only.

  • Gets UI modifications. UI modifications can only be retrieved by Forge apps.

  • Creates a UI modification. UI modification can only be created by Forge apps.

  • Updates a UI modification. UI modification can only be updated by Forge apps.

  • Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.

User properties

This resource represents userproperties and provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a list of property keys for a user.

  • Returns the keys of all properties for a user.

  • Returns the value of a user's property.

  • Sets the value of a user's property. Use this resource to store custom data against a user.

  • Deletes a property from a user.

User search

This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. Note that the operations in this resource only return users found within the first 1000 users.

  • Returns a list of users who can be assigned issues in one or more projects.

  • Returns a list of users that can be assigned to an issue.

  • Returns a list of users who fulfill criteria

  • Returns a list of users whose attributes match the query term.

  • Returns a list of active users that match the search string and property.

  • Finds users with a structured query and returns a paginated list of user details.

  • Finds users with a structured query and returns a paginated list of user keys.

  • Returns a list of users who fulfill criteria.

Users

This resource represent users.

  • Returns a user.

  • Creates a user.

  • Deletes a user.

  • Returns a paginated list of the users specified by one or more account IDs.

  • Returns the account IDs for the users specified in the `key` or `username` parameters.

  • Returns the default issue table columns for the user.

  • Sets the default issue table columns for the user.

  • Resets the default issue table columns for the user to the system default.

  • Returns a user's email address regardless of the user's profile visibility settings.

  • Returns a user's email address regardless of the user's profile visibility settings.

  • Returns the groups to which a user belongs.

  • Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

  • Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Webhooks

This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register and manage webhooks.

  • Returns a paginated list of the webhooks registered by the calling app.

  • Registers webhooks.

  • Removes webhooks by ID. Only webhooks registered by the calling app are removed.

  • Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries.

  • Extends the life of webhook. Webhooks registered through the REST API expire after 30 days.

Workflow scheme drafts

This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes.

  • Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme.

  • Returns the draft workflow scheme for an active workflow scheme.

  • Updates a draft workflow scheme.

  • Deletes a draft workflow scheme.

  • Returns the default workflow for a workflow scheme's draft.

  • Sets the default workflow for a workflow scheme's draft.

  • Resets the default workflow for a workflow scheme's draft.

  • Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

  • Sets the workflow for an issue type in a workflow scheme's draft.

  • Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

  • Publishes a draft workflow scheme.

  • Returns the workflow-issue type mappings for a workflow scheme's draft.

  • Sets the issue types for a workflow in a workflow scheme's draft.

  • Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

Workflow scheme project associations

This resource represents the associations between workflow schemes and projects.

  • Returns a list of the workflow schemes associated with a list of projects.

  • Assigns a workflow scheme to a project.

Workflow schemes

This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types. A workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings. Active workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme).

  • Returns a paginated list of all workflow schemes, not including draft workflow schemes.

  • Creates a workflow scheme.

  • Switches a workflow scheme for a project.

  • Returns a list of workflow schemes by providing workflow scheme IDs or project IDs.

  • Updates company-managed and team-managed project workflow schemes.

  • Gets the required status mappings for the desired changes to a workflow scheme.

  • Returns a workflow scheme.

  • Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more.

  • Deletes a workflow scheme.

  • Returns the default workflow for a workflow scheme.

  • Sets the default workflow for a workflow scheme.

  • Resets the default workflow for a workflow scheme.

  • Returns the issue type-workflow mapping for an issue type in a workflow scheme.

  • Sets the workflow for an issue type in a workflow scheme.

  • Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

  • Returns the workflow-issue type mappings for a workflow scheme.

  • Sets the issue types for a workflow in a workflow scheme.

  • Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

  • Returns a page of projects using a given workflow scheme.

Workflow status categories

This resource represents status categories. Use it to obtain a list of all status categories and the details of a category. Status categories provided a mechanism for categorizing statuses.

  • Returns a list of all status categories.

  • Returns a status category.

Workflow statuses

This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status.

  • Returns a list of all statuses associated with active workflows.

  • Returns a status. The status must be associated with an active workflow to be returned.

Workflow transition rules

This resource represents workflow transition rules. Workflow transition rules define a Connect or a Forge app routine, such as a workflow post functions that is executed in association with the workflow. Use it to read and modify configuration of workflow transition rules.

  • Returns a paginated list of workflows with transition rules.

  • Updates configuration of workflow transition rules.

  • Deletes workflow transition rules from one or more workflows.

Workflows

This resource represents workflows.

  • Returns a workflow and related statuses for a specified workflow id and version number.

  • Returns a list of workflow history entries for a specified workflow id.

  • Deletes a workflow.

  • Returns a page of issue types using a given workflow within a project.

  • Returns a page of projects using a given workflow.

  • Returns a page of workflow schemes using a given workflow.

  • Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

  • Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair.

  • Create workflows and related statuses.

  • Validate the payload for bulk create workflows.

  • Get the user's default workflow editor. This can be either the new editor or the legacy editor.

  • Returns a requested workflow within a given project.

  • Returns a paginated list of global and project workflows.

  • Update workflows and related statuses.

  • Validate the payload for bulk update workflows.

Other operations

  • Returns worklog details for a list of issue ID and worklog ID pairs.

In order to install this in your org, you need to access the library from the Declarative Webhooks app in your Salesforce org, Declarative Webhooks Library tab.