Skip to main content

Jira (API Token)

Manage issues, projects, and workflows in Jira using API token authentication.

Jira (API Token) Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 1185 actions:

ActionPurposeParameters
get_rest_api_2_announcement_bannerReturns the current announcement banner configuration. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_2_announcement_bannerUpdates the announcement banner configuration. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. isDismissible (boolean)
. isEnabled (boolean)
. message (string)
. visibility (string)
} (object) required
post_rest_api_2_app_field_context_configuration_listReturns a paginated pagination list of configurations for list of custom fields of a typehttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ created by a Forge apphttps://developer.atlassian.com/platform/forge/. The result can be filtered by one of these criteria: id. fieldContextId. issueId. projectKeyOrId and issueTypeId. Otherwise, all configurations for the provided list of custom fields are returned. Permissions permissions requiid (array)
fieldContextId (array)
issueId (integer)
projectKeyOrId (string)
issueTypeId (string)
startAt (integer)
maxResults (integer)
data: {
. fieldIdsOrKeys (array)
} (object) required
post_rest_api_2_app_field_valueUpdates 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. Apps can only perform this operation on custom fieldshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/ and custom field typeshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ declared in their own manifests. Permissions permissions required: Only the app that ogenerateChangelog (boolean)
data: {
. updates (array)
} (object) required
get_rest_api_2_app_field_by_field_id_or_key_context_configurationReturns a paginated pagination list of configurations for a custom field of a typehttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ created by a Forge apphttps://developer.atlassian.com/platform/forge/. The result can be filtered by one of these criteria: id. fieldContextId. issueId. projectKeyOrId and issueTypeId. Otherwise, all configurations are returned. Permissions permissions required: Administer Jira global permissionhttps://fieldIdOrKey (string)
id (array)
fieldContextId (array)
issueId (integer)
projectKeyOrId (string)
issueTypeId (string)
startAt (integer)
maxResults (integer)
put_rest_api_2_app_field_by_field_id_or_key_context_configurationUpdate the configuration for contexts of a custom field of a typehttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ created by a Forge apphttps://developer.atlassian.com/platform/forge/. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Jira permissions are not required for the Forge app that created the custom field type.fieldIdOrKey (string)
data: {
. configurations (array)
} (object) required
put_rest_api_2_app_field_by_field_id_or_key_valueUpdates the value of a custom field on one or more issues. Apps can only perform this operation on custom fieldshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/ and custom field typeshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ declared in their own manifests. Permissions permissions required: Only the app that owns the custom field or custom field type can update its values with this operation. TfieldIdOrKey (string)
generateChangelog (boolean)
data: {
. updates (array)
} (object) required
get_rest_api_2_application_propertiesReturns all application properties or an application property. If you specify a value for the key parameter, then an application property is returned as an object not in an array. Otherwise, an array of all editable application properties is returned. See Set application property api-rest-api-2-application-properties-id-put for descriptions of editable properties. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.key (string)
permissionLevel (string)
keyFilter (string)
get_rest_api_2_application_properties_advanced_settingsReturns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon Jira settings System, General Configuration and then click Advanced Settings in the upper right. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_2_application_properties_by_idChanges the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values. Advanced settings The advanced settings below are also accessible in Jirahttps://confluence.atlassian.com/x/vYXKM. | Key | Description | Default value | | -- | -- | -- | | jira.clone.prefix | The string of text pid (string)
data: {
. id (string)
. value (string)
} (object) required
get_rest_api_2_applicationroleReturns all application roles. In Jira, application roles are managed using the Application access configurationhttps://confluence.atlassian.com/x/3YxjL page. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
get_rest_api_2_applicationrole_by_keyReturns an application role. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.key (string)
get_rest_api_2_attachment_content_by_idReturns the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to download. See the HTTP Range header standardhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range for details. To return a thumbnail of the attachment, use Get attachment thumbnail api-rest-api-2-attachment-thumbnail-id-get. This operation can be accessed anonymously. Permissions permissions required: For the issue containing the attachment: Browse projects projecid (string)
redirect (boolean)
get_rest_api_2_attachment_metaReturns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. Note that there are also project permissionshttps://confluence.atlassian.com/x/yodKLg that restrict whether users can create and delete attachments. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
get_rest_api_2_attachment_thumbnail_by_idReturns the thumbnail of an attachment. To return the attachment contents, use Get attachment content api-rest-api-2-attachment-content-id-get. This operation can be accessed anonymously. Permissions permissions required: For the issue containing the attachment: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission tid (string)
redirect (boolean)
fallbackToDefault (boolean)
width (integer)
height (integer)
delete_rest_api_2_attachment_by_idDeletes an attachment from an issue. This operation can be accessed anonymously. Permissions permissions required: For the project holding the issue containing the attachment: Delete own attachments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete an attachment created by the calling user. Delete all attachments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete an attachment created by any user.id (string)
get_rest_api_2_attachment_by_idReturns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If attachments are added in private comments, the comment-level restrictionid (string)
get_rest_api_2_attachment_by_id_expand_humanReturns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported. Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, useid (string)
get_rest_api_2_attachment_by_id_expand_rawReturns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported. Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use Get all metadata for an expanded attaid (string)
get_rest_api_2_auditing_recordReturns a list of audit records. The list can be filtered to include items: where each item in filter has at least one match in any of these fields: summary category eventSource objectItem.name If the object is a user, account ID is available to filter. objectItem.parentName objectItem.typeName changedValues.changedFrom changedValues.changedTo remoteAddress For example, if filter contains man ed, an audit record conoffset (integer)
limit (integer)
filter (string)
from (string)
to (string)
get_rest_api_2_avatar_by_type_systemReturns a list of system avatar details by owner type, where the owner types are issue type, project, user or priority. This operation can be accessed anonymously. Permissions permissions required: None.type (string)
post_rest_api_2_changelog_bulkfetchBulk fetch changelogs for multiple issues and filter by fields Returns a paginated list of all changelogs for given issues sorted by changelog date and issue IDs, starting from the oldest changelog and smallest issue ID. Issues are identified by their ID or key, and optionally changelogs can be filtered by their field IDs. You can request the changelogs of up to 1000 issues and can filter them by up to 10 field IDs. Permissions permissions required: Browse projects project permissionhttpsdata: {
. fieldIds (array)
. issueIdsOrKeys (array)
. maxResults (integer)
. nextPageToken (string)
} (object) required
get_rest_api_2_classification_levelsReturns all classification levels. Permissions permissions required: None.status (array)
orderBy (string)
post_rest_api_2_comment_listReturns a paginated pagination list of comments specified by a list of comment IDs. This operation can be accessed anonymously. Permissions permissions required: Comments are returned where the user: has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the comment. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restricexpand (string)
data: {
. ids (array)
} (object) required
get_rest_api_2_comment_by_comment_id_propertiesReturns the keys of all the properties of a comment. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.commentId (string)
delete_rest_api_2_comment_by_comment_id_properties_by_property_keyDeletes a comment property. Permissions permissions required: either of: Edit All Comments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete a property from any comment. Edit Own Comments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete a property from a comment created by the user.commentId (string)
propertyKey (string)
get_rest_api_2_comment_by_comment_id_properties_by_property_keyReturns the value of a comment property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.commentId (string)
propertyKey (string)
put_rest_api_2_comment_by_comment_id_properties_by_property_keyCreates or updates the value of a property for a comment. Use this resource to store custom data against a comment. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. Permissions permissions required: either of: Edit All Comments project permissionhttps://confluence.atlassian.com/x/yodKLg to create or update the value of a property on any comment. Edit Own Comments project permissionhttps://conflucommentId (string)
propertyKey (string)
data (undefined) required
get_rest_api_2_componentReturns a paginated pagination list of all components in a project, including global Compass components when applicable. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdsOrKeys (array)
startAt (integer)
maxResults (integer)
orderBy (string)
query (string)
post_rest_api_2_componentCreates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project. This operation can be accessed anonymously. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project in which the component is created or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. ari (string)
. assignee
. assigneeType (string)
. description (string)
. id (string)
. isAssigneeTypeValid (boolean)
. lead
. leadAccountId (string)
. leadUserName (string)
. metadata (object)
. name (string)
. project (string)
. projectId (integer)
. realAssignee
. realAssigneeType (string)
. self (string)
} (object) required
delete_rest_api_2_component_by_idDeletes a component. This operation can be accessed anonymously. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the component or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
moveIssuesTo (string)
get_rest_api_2_component_by_idReturns a component. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for project containing the component.id (string)
put_rest_api_2_component_by_idUpdates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string '' the component lead is removed. This operation can be accessed anonymously. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the component or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. ari (string)
. assignee
. assigneeType (string)
. description (string)
. id (string)
. isAssigneeTypeValid (boolean)
. lead
. leadAccountId (string)
. leadUserName (string)
. metadata (object)
. name (string)
. project (string)
. projectId (integer)
. realAssignee
. realAssigneeType (string)
. self (string)
} (object) required
get_rest_api_2_component_by_id_related_issue_countsReturns the counts of issues assigned to the component. This operation can be accessed anonymously. Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024. Classic: read:jira-work Granular: read:field:jira, read:project.component:jira Permissions permissions required: None.id (string)
get_rest_api_2_configurationReturns the global settingshttps://confluence.atlassian.com/x/qYXKM in Jira. These settings determine whether optional features for example, subtasks, time tracking, and others are enabled. If time tracking is enabled, this operation also returns the time tracking configuration. Permissions permissions required: Permission to access Jira.No parameters
get_rest_api_2_configuration_timetrackingReturns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_2_configuration_timetrackingSelects a time tracking provider. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. key (string)
. name (string)
. url (string)
} (object) required
get_rest_api_2_configuration_timetracking_listReturns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Providerhttps://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/ module. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlNo parameters
get_rest_api_2_configuration_timetracking_optionsReturns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_2_configuration_timetracking_optionsSets the time tracking settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultUnit (string)
. timeFormat (string)
. workingDaysPerWeek (number)
. workingHoursPerDay (number)
} (object) required
get_rest_api_2_custom_field_option_by_idReturns a custom field option. For example, an option in a select list. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource, it cannot be used with issue field select list options created by Connect apps. This operation can be accessed anonymously. Permissions permissions required: The custom field option is returned as follows: if the user has the Admiid (string)
get_rest_api_2_dashboardReturns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. This operation can be accessed anonymously. Permissions permissions required: None.filter (string)
startAt (integer)
maxResults (integer)
post_rest_api_2_dashboardCreates a dashboard. Permissions permissions required: None.extendAdminPermissions (boolean)
data: {
. description (string)
. editPermissions (array)
. name (string)
. sharePermissions (array)
} (object) required
put_rest_api_2_dashboard_bulk_editBulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100. Permissions permissions required: None The dashboards to be updated must be owned by the user, or the user must be an administrator.data: {
. action (string)
. changeOwnerDetails
. entityIds (array)
. extendAdminPermissions (boolean)
. permissionDetails
} (object) required
get_rest_api_2_dashboard_gadgetsGets a list of all available gadgets that can be added to all dashboards. Permissions permissions required: None.No parameters
get_rest_api_2_dashboard_searchReturns a paginated pagination list of dashboards. This operation is similar to Get dashboards api-rest-api-2-dashboard-get except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously. Permissions permissions required: The following dashboards that match the query parameters are returdashboardName (string)
accountId (string)
owner (string)
groupname (string)
groupId (string)
projectId (integer)
orderBy (string)
startAt (integer)
maxResults (integer)
status (string)
expand (string)
get_rest_api_2_dashboard_by_dashboard_id_gadgetReturns a list of dashboard gadgets on a dashboard. This operation returns: Gadgets from a list of IDs, when id is set. Gadgets with a module key, when moduleKey is set. Gadgets from a list of URIs, when uri is set. All gadgets, when no other parameters are set. This operation can be accessed anonymously. Permissions permissions required: None.dashboardId (integer)
moduleKey (array)
uri (array)
gadgetId (array)
post_rest_api_2_dashboard_by_dashboard_id_gadgetAdds a gadget to a dashboard. Permissions permissions required: None.dashboardId (integer)
data: {
. color (string)
. ignoreUriAndModuleKeyValidation (boolean)
. moduleKey (string)
. position
. title (string)
. uri (string)
} (object) required
delete_rest_api_2_dashboard_by_dashboard_id_gadget_by_gadget_idRemoves a dashboard gadget from a dashboard. When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position. Permissions permissions required: None.dashboardId (integer)
gadgetId (integer)
put_rest_api_2_dashboard_by_dashboard_id_gadget_by_gadget_idChanges the title, position, and color of the gadget on a dashboard. Permissions permissions required: None.dashboardId (integer)
gadgetId (integer)
data: {
. color (string)
. position
. title (string)
} (object) required
get_rest_api_2_dashboard_by_dashboard_id_items_by_item_id_propertiesReturns the keys of all properties for a dashboard item. This operation can be accessed anonymously. Permissions permissions required: The user must have read permission of the dashboard or have the dashboard shared with them.dashboardId (string)
itemId (string)
delete_rest_api_2_dashboard_by_dashboard_id_items_by_item_id_properties_by_property_keyDeletes a dashboard item property. This operation can be accessed anonymously. Permissions permissions required: The user must have edit permission of the dashboard.dashboardId (string)
itemId (string)
propertyKey (string)
get_rest_api_2_dashboard_by_dashboard_id_items_by_item_id_properties_by_property_keyReturns the key and value of a dashboard item property. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgetshttps://confluence.atlassian.com/x/7AeiLQ. When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or,dashboardId (string)
itemId (string)
propertyKey (string)
put_rest_api_2_dashboard_by_dashboard_id_items_by_item_id_properties_by_property_keySets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgetshttps://confluence.atlassian.com/x/7AeiLQ. When an app creates a dashboard item it registers a callback to receive the dashboarddashboardId (string)
itemId (string)
propertyKey (string)
data (undefined) required
delete_rest_api_2_dashboard_by_idDeletes a dashboard. Permissions permissions required: None The dashboard to be deleted must be owned by the user.id (string)
get_rest_api_2_dashboard_by_idReturns a dashboard. This operation can be accessed anonymously. Permissions permissions required: None. However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.id (string)
put_rest_api_2_dashboard_by_idUpdates a dashboard, replacing all the dashboard details with those provided. Permissions permissions required: None The dashboard to be updated must be owned by the user.id (string)
extendAdminPermissions (boolean)
data: {
. description (string)
. editPermissions (array)
. name (string)
. sharePermissions (array)
} (object) required
post_rest_api_2_dashboard_by_id_copyCopies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard. Permissions permissions required: None The dashboard to be copied must be owned by or shared with the user.id (string)
extendAdminPermissions (boolean)
data: {
. description (string)
. editPermissions (array)
. name (string)
. sharePermissions (array)
} (object) required
get_rest_api_2_data_policyReturns data policy for the workspace.No parameters
get_rest_api_2_data_policy_projectReturns data policies for the projects specified in the request.ids (string)
get_rest_api_2_eventsReturns all issue events. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
post_rest_api_2_expression_analyseAnalyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check the expressions. Learn more about Jira expressions in the documentationhttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/. Permissions permissions required: None.check (string)
data: {
. contextVariables (object)
. expressions (array)
} (object) required
post_rest_api_2_expression_evalEndpoint is currently being removed. More detailshttps://developer.atlassian.com/changelog/ CHANGE-2046 Evaluates a Jira expression and returns its value. This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentationhttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/ for more details. Context variables The following context variables are available to Jira expressionexpand (string)
data: {
. context
. expression (string)
} (object) required
post_rest_api_2_expression_evaluateEvaluates 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. This API is eventually consistent, unlike the strongly consistent eval API. This allows for better performance and scalability. In addition, this API's response for JQL evaluation is based on a scrolling view backed by a nextPageToken instead of a paginated view backed by startAt and totalCount. This resource can be used to testexpand (string)
data: {
. context
. expression (string)
} (object) required
get_rest_api_2_fieldReturns system and custom issue fields according to the following rules: Fields that cannot be added to the issue navigator are always returned. Fields that cannot be placed on an issue screen are always returned. Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches. For all other fields, this operation only returns the fields that the user has permission to view that is, the field is usedNo parameters
post_rest_api_2_fieldCreates a custom field. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
. searcherKey (string)
. type (string)
} (object) required
delete_rest_api_2_field_associationUnassociates a set of fields with a project and issue type context. Fields will be unassociated with all projects/issue types that share the same field configuration which the provided project and issue types are using. This means that while the field will be unassociated with the provided project and issue types, it will also be unassociated with any other projects and issue types that share the same field configuration. If a success response is returned it means that the field association hadata: {
. associationContexts (array)
. fields (array)
} (object) required
put_rest_api_2_field_associationAssociates fields with projects. Fields will be associated with each issue type on the requested projects. Fields will be associated with all projects that share the same field configuration which the provided projects are using. This means that while the field will be associated with the requested projects, it will also be associated with any other projects that share the same field configuration. If a success response is returned it means that the field association has been created in any adata: {
. associationContexts (array)
. fields (array)
} (object) required
get_rest_api_2_field_searchReturns a paginated pagination list of fields for Classic Jira projects. The list can include: all fields specific fields, by defining id fields that contain a string in the field name or description, by defining query specific fields that contain a string in the field name or description, by defining id and query Use type must be set to custom to show custom fields only. Permissions permissions required: Permission to access Jira.startAt (integer)
maxResults (integer)
type (array)
id (array)
query (string)
orderBy (string)
expand (string)
projectIds (array)
get_rest_api_2_field_search_trashedReturns a paginated pagination list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string. Only custom fields can be queried, type must be set to custom. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
query (string)
expand (string)
orderBy (string)
put_rest_api_2_field_by_field_idUpdates a custom field. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
data: {
. description (string)
. name (string)
. searcherKey (string)
} (object) required
get_rest_api_2_field_by_field_id_contextReturns a paginated pagination list of contextshttps://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html for a custom field. Contexts can be returned as follows: With no other parameters set, all contexts. By defining id only, all contexts from the list of IDs. By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types true or those that apply to only a subset of issue types false By defining isGfieldId (string)
isAnyIssueType (boolean)
isGlobalContext (boolean)
contextId (array)
startAt (integer)
maxResults (integer)
post_rest_api_2_field_by_field_id_contextCreates a custom field context. If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
data: {
. description (string)
. id (string)
. issueTypeIds (array)
. name (string)
. projectIds (array)
} (object) required
get_rest_api_2_field_by_field_id_context_default_valueReturns a paginated pagination list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned. The returned object depends on type of the custom field: CustomFieldContextDefaultValueDate type datepicker for date fields. CustomFieldContextDefaultValueDateTime type datetimepicker for date-time fields. CustomFieldContextDefaultValueSingleOption type option.single for single choicfieldId (string)
contextId (array)
startAt (integer)
maxResults (integer)
put_rest_api_2_field_by_field_id_context_default_valueSets default for contexts of a custom field. Default are defined using these objects: CustomFieldContextDefaultValueDate type datepicker for date fields. CustomFieldContextDefaultValueDateTime type datetimepicker for date-time fields. CustomFieldContextDefaultValueSingleOption type option.single for single choice select lists and radio buttons. CustomFieldContextDefaultValueMultipleOption type option.multiple for multiple choice select lists and checkboxes. CustomFieldContextDefafieldId (string)
data: {
. defaultValues (array)
} (object) required
get_rest_api_2_field_by_field_id_context_issuetypemappingReturns a paginated pagination 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. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (array)
startAt (integer)
maxResults (integer)
post_rest_api_2_field_by_field_id_context_mappingReturns a paginated pagination list of project and issue type mappings and, for each mapping, the ID of a custom field contexthttps://confluence.atlassian.com/x/k44fOw that applies to the project and issue type. If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null.fieldId (string)
startAt (integer)
maxResults (integer)
data: {
. mappings (array)
} (object) required
get_rest_api_2_field_by_field_id_context_projectmappingReturns a paginated pagination 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. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (array)
startAt (integer)
maxResults (integer)
delete_rest_api_2_field_by_field_id_context_by_context_idDeletes a custom field contexthttps://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
put_rest_api_2_field_by_field_id_context_by_context_idUpdates a custom field contexthttps://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_field_by_field_id_context_by_context_id_issuetypeAdds issue types to a custom field context, appending the issue types to the issue types list. A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types. If any of the issue types exists in the custom field context, the operation fails and no issue types are added. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dfieldId (string)
contextId (integer)
data: {
. issueTypeIds (array)
} (object) required
post_rest_api_2_field_by_field_id_context_by_context_id_issuetype_removeRemoves issue types from a custom field context. A custom field context without any issue types applies to all issue types. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. issueTypeIds (array)
} (object) required
get_rest_api_2_field_by_field_id_context_by_context_id_optionReturns a paginated pagination list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options apps api-group-issue-custom-field-options--apps- operations. Permissions permissions required: Administer Jira global permissionhfieldId (string)
contextId (integer)
optionId (integer)
onlyOptions (boolean)
startAt (integer)
maxResults (integer)
post_rest_api_2_field_by_field_id_context_by_context_id_optionCreates 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. The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom fifieldId (string)
contextId (integer)
data: {
. options (array)
} (object) required
put_rest_api_2_field_by_field_id_context_by_context_id_optionUpdates the options of a custom field. If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource, it cannot be used with issue field select list options created by Connect apps. PermissiofieldId (string)
contextId (integer)
data: {
. options (array)
} (object) required
put_rest_api_2_field_by_field_id_context_by_context_id_option_moveChanges the order of custom field options or cascading options in a context. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options apps api-group-issue-custom-field-options--apps- operations. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. after (string)
. customFieldOptionIds (array)
. position (string)
} (object) required
delete_rest_api_2_field_by_field_id_context_by_context_id_option_by_option_idDeletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options apps api-group-issue-custom-field-options--apps- operations. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dfieldId (string)
contextId (integer)
optionId (integer)
delete_rest_api_2_field_by_field_id_context_by_context_id_option_by_option_id_issueReplaces the options of a custom field. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource, it cannot be used with issue field select list options created by Connect or Forge apps. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
optionId (integer)
contextId (integer)
replaceWith (integer)
jql (string)
put_rest_api_2_field_by_field_id_context_by_context_id_projectAssigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. projectIds (array)
} (object) required
post_rest_api_2_field_by_field_id_context_by_context_id_project_removeRemoves a custom field context from projects. A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects. If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. projectIds (array)
} (object) required
get_rest_api_2_field_by_field_id_contextsReturns a paginated pagination list of the contexts a field is used in. Deprecated, use Get custom field contexts api-rest-api-2-field-fieldId-context-get. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
startAt (integer)
maxResults (integer)
get_rest_api_2_field_by_field_id_screensReturns a paginated pagination list of the screens a field is used in. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
startAt (integer)
maxResults (integer)
expand (string)
get_rest_api_2_field_by_field_key_optionReturns a paginated pagination list of all the options of a select list issue field. A select list issue field is a type of issue fieldhttps://developer.atlassian.com/cloud/jira/platform/modules/issue-field/ that enables a user to select a value from a list of options. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-grofieldKey (string)
startAt (integer)
maxResults (integer)
post_rest_api_2_field_by_field_key_optionCreates an option for a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes. Permissions permissions required: Administer Jira global permissionhttps://conffieldKey (string)
data: {
. config
. properties (object)
. value (string)
} (object) required
get_rest_api_2_field_by_field_key_option_suggestions_editReturns a paginated pagination list of options for a select list issue field that can be viewed and selected by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Permission to access Jira.fieldKey (string)
startAt (integer)
maxResults (integer)
projectId (integer)
get_rest_api_2_field_by_field_key_option_suggestions_searchReturns a paginated pagination list of options for a select list issue field that can be viewed by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Permission to access Jira.fieldKey (string)
startAt (integer)
maxResults (integer)
projectId (integer)
delete_rest_api_2_field_by_field_key_option_by_option_idDeletes an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Jira permissions are not required for the app providing the field.fieldKey (string)
optionId (integer)
get_rest_api_2_field_by_field_key_option_by_option_idReturns an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Jira permissions are not required for the app providing the field.fieldKey (string)
optionId (integer)
put_rest_api_2_field_by_field_key_option_by_option_idUpdates 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. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field optiofieldKey (string)
optionId (integer)
data: {
. config
. id (integer)
. properties (object)
. value (string)
} (object) required
delete_rest_api_2_field_by_field_key_option_by_option_id_issueDeselects 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. Connect and Forge app users with Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag. This is an asynchronous operation async. The response objfieldKey (string)
optionId (integer)
replaceWith (integer)
jql (string)
overrideScreenSecurity (boolean)
overrideEditableFlag (boolean)
delete_rest_api_2_field_by_idDeletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom fieldhttps://confluence.atlassian.com/x/Z44fOw for more information on trashing and deleting custom fields. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://conflueid (string)
post_rest_api_2_field_by_id_restoreRestores a custom field from trash. See Edit or delete a custom fieldhttps://confluence.atlassian.com/x/Z44fOw for more information on trashing and deleting custom fields. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
post_rest_api_2_field_by_id_trashMoves a custom field to trash. See Edit or delete a custom fieldhttps://confluence.atlassian.com/x/Z44fOw for more information on trashing and deleting custom fields. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
get_rest_api_2_fieldconfigurationReturns a paginated pagination list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: a list of field configuration item IDs. whether the field configuration is a default. whether the field configuration name or description contains a query string. Only field configurations used in company-managed classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://costartAt (integer)
maxResults (integer)
id (array)
isDefault (boolean)
query (string)
post_rest_api_2_fieldconfigurationCreates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
delete_rest_api_2_fieldconfiguration_by_idDeletes a field configuration. This operation can only delete configurations used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
put_rest_api_2_fieldconfiguration_by_idUpdates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_2_fieldconfiguration_by_id_fieldsReturns a paginated pagination list of all fields for a configuration. Only the fields from configurations used in company-managed classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
startAt (integer)
maxResults (integer)
put_rest_api_2_fieldconfiguration_by_id_fieldsUpdates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed classic projects. The operation can set the renderer for text fields to the default text renderer text-renderer or wiki style renderer wiki-renderer. However, the renderer cannot be updated for fields using the autocomplete renderer autocomplete-renderer. Hiding a field deletes it from the fid (integer)
data: {
. fieldConfigurationItems (array)
} (object) required
get_rest_api_2_fieldconfigurationschemeReturns a paginated pagination list of field configuration schemes. Only field configuration schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
post_rest_api_2_fieldconfigurationschemeCreates a field configuration scheme. This operation can only create field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
get_rest_api_2_fieldconfigurationscheme_mappingReturns a paginated pagination list of field configuration issue type items. Only items used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
fieldConfigurationSchemeId (array)
get_rest_api_2_fieldconfigurationscheme_projectReturns a paginated pagination list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
projectId (array) required
put_rest_api_2_fieldconfigurationscheme_projectAssigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. fieldConfigurationSchemeId (string)
. projectId (string)
} (object) required
delete_rest_api_2_fieldconfigurationscheme_by_idDeletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
put_rest_api_2_fieldconfigurationscheme_by_idUpdates a field configuration scheme. This operation can only update field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_fieldconfigurationscheme_by_id_mappingAssigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. mappings (array)
} (object) required
post_rest_api_2_fieldconfigurationscheme_by_id_mapping_deleteRemoves issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. issueTypeIds (array)
} (object) required
post_rest_api_2_filterCreates a filter. The filter is shared according to the default share scope api-rest-api-2-filter-post. The filter is not selected as a favorite. Permissions permissions required: Permission to access Jira.expand (string)
overrideSharePermissions (boolean)
data: {
. approximateLastUsed (string)
. description (string)
. editPermissions (array)
. favourite (boolean)
. favouritedCount (integer)
. id (string)
. jql (string)
. name (string)
. owner
. searchUrl (string)
. self (string)
. sharePermissions (array)
. sharedUsers
. subscriptions
. viewUrl (string)
} (object) required
get_rest_api_2_filter_default_share_scopeReturns the default sharing settings for new filters and dashboards for a user. Permissions permissions required: Permission to access Jira.No parameters
put_rest_api_2_filter_default_share_scopeSets the default sharing for new filters and dashboards for a user. Permissions permissions required: Permission to access Jira.data: {
. scope (string)
} (object) required
get_rest_api_2_filter_favouriteReturns the visible favorite filters of the user. This operation can be accessed anonymously. Permissions permissions required: A favorite filter is only visible to the user where the filter is: owned by the user. shared with a group that the user is a member of. shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. shared with a public project. shared with the public. For example, if the user favoritesexpand (string)
get_rest_api_2_filter_myReturns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned. Permissions permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is: owned by the user. shared with a group that the user is a member of. shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. shared with a public projeexpand (string)
includeFavourites (boolean)
get_rest_api_2_filter_searchReturns a paginated pagination list of filters. Use this operation to get: specific filters, by defining id only. filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously. Permissions permissions required: None, however, only the following filters that match the query parameters are returfilterName (string)
accountId (string)
owner (string)
groupname (string)
groupId (string)
projectId (integer)
id (array)
orderBy (string)
startAt (integer)
maxResults (integer)
expand (string)
overrideSharePermissions (boolean)
isSubstringMatch (boolean)
delete_rest_api_2_filter_by_idDelete a filter. Permissions permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_2_filter_by_idReturns a filter. This operation can be accessed anonymously. Permissions permissions required: None, however, the filter is only returned where it is: owned by the user. shared with a group that the user is a member of. shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. shared with a public project. shared with the public.id (integer)
expand (string)
overrideSharePermissions (boolean)
put_rest_api_2_filter_by_idUpdates a filter. Use this operation to update a filter's name, description, JQL, or sharing. Permissions permissions required: Permission to access Jira, however the user must own the filter.id (integer)
expand (string)
overrideSharePermissions (boolean)
data: {
. approximateLastUsed (string)
. description (string)
. editPermissions (array)
. favourite (boolean)
. favouritedCount (integer)
. id (string)
. jql (string)
. name (string)
. owner
. searchUrl (string)
. self (string)
. sharePermissions (array)
. sharedUsers
. subscriptions
. viewUrl (string)
} (object) required
delete_rest_api_2_filter_by_id_columnsReset the user's column configuration for the filter to the default. Permissions permissions required: Permission to access Jira, however, columns are only reset for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. filters shared with a public project. filters shared with the public.id (integer)
get_rest_api_2_filter_by_id_columnsReturns 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. This operation can be accessed anonymously. Permissions permissions required: None, however, column details are only returned for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browse projects project permissionhttps://confluence.atlid (integer)
put_rest_api_2_filter_by_id_columnsSets the columns for a filter. Only navigable fields can be set as columns. Use Get fields api-rest-api-2-field-get to get the list fields in Jira. A navigable field has navigable set to true. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns Permissions permissions required: Permission to access Jira, however, columns are only set for:id (integer)
data: {
. columns (array)
} (object) required
delete_rest_api_2_filter_by_id_favouriteRemoves 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. For example, if the user favorites a public filter that is subsequently made private and is therefore no longer visible on their favorites list they cannot remove it from their favorites list. Permissions permissions required: Permission to access Jira.id (integer)
expand (string)
put_rest_api_2_filter_by_id_favouriteAdd a filter as a favorite for the user. Permissions permissions required: Permission to access Jira, however, the user can only favorite: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. filters shared with a public project. filters shared with the public.id (integer)
expand (string)
put_rest_api_2_filter_by_id_ownerChanges the owner of the filter. Permissions permissions required: Permission to access Jira. However, the user must own the filter or have the Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. accountId (string)
} (object) required
get_rest_api_2_filter_by_id_permissionReturns 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. This operation can be accessed anonymously. Permissions permissions required: None, however, share permissions are only returned for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Bid (integer)
post_rest_api_2_filter_by_id_permissionAdd 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. Be aware that this operation uses different objects for updating share permissions compared to Update filter api-rest-api-2-filter-id-put. Permissions permissions required: Share dashboards and filters global permissionhttps://confluence.atlassian.com/x/x4dKLg and the user must own the filter.id (integer)
data: {
. accountId (string)
. groupId (string)
. groupname (string)
. projectId (string)
. projectRoleId (string)
. rights (integer)
. type (string)
} (object) required
delete_rest_api_2_filter_by_id_permission_by_permission_idDeletes a share permission from a filter. Permissions permissions required: Permission to access Jira and the user must own the filter.id (integer)
permissionId (integer)
get_rest_api_2_filter_by_id_permission_by_permission_idReturns 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. This operation can be accessed anonymously. Permissions permissions required: None, however, a share permission is only returned for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browid (integer)
permissionId (integer)
delete_rest_api_2_groupDeletes a group. Permissions permissions required: Site administration that is, member of the site-admin strategic grouphttps://confluence.atlassian.com/x/24xjL.groupname (string)
groupId (string)
swapGroup (string)
swapGroupId (string)
get_rest_api_2_groupThis operation is deprecated, use group/member api-rest-api-2-group-member-get. Returns all users in a group. Permissions permissions required: either of: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.groupname (string)
groupId (string)
expand (string)
post_rest_api_2_groupCreates a group. Permissions permissions required: Site administration that is, member of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.data: {
. name (string)
} (object) required
get_rest_api_2_group_bulkReturns a paginated pagination list of groups. Permissions permissions required: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
groupId (array)
groupName (array)
accessType (string)
applicationKey (string)
get_rest_api_2_group_memberReturns a paginated pagination list of all users in a group. Note that users are ordered by username, however the username is not returned in the results due to privacy reasons. Permissions permissions required: either of: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.groupname (string)
groupId (string)
includeInactiveUsers (boolean)
startAt (integer)
maxResults (integer)
delete_rest_api_2_group_userRemoves a user from a group. Permissions permissions required: Site administration that is, member of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.groupname (string)
groupId (string)
username (string)
accountId (string) required
post_rest_api_2_group_userAdds a user to a group. Permissions permissions required: Site administration that is, member of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.groupname (string)
groupId (string)
data: {
. accountId (string)
. name (string)
} (object) required
get_rest_api_2_groups_pickerReturns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matcaccountId (string)
query (string)
exclude (array)
excludeId (array)
maxResults (integer)
caseInsensitive (boolean)
userName (string)
get_rest_api_2_groupuserpickerReturns a list of users and groups matching a string. The string is used: for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required. for groups, to find a case-sensitive match with group name. For example, if the string tin is used, records with the display name Tina, email address sarah@tinplatetraining.query (string) required
maxResults (integer)
showAvatar (boolean)
fieldId (string)
projectId (array)
issueTypeId (array)
avatarSize (string)
caseInsensitive (boolean)
excludeConnectAddons (boolean)
get_rest_api_2_instance_licenseReturns licensing information about the Jira instance. Permissions permissions required: None.No parameters
post_rest_api_2_issueCreates 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. The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata api-rest-api-2-issue-createmeta-get. These are the same fields that appear on the issue's create supdateHistory (boolean)
data: {
. fields (object)
. historyMetadata
. properties (array)
. transition
. update (object)
} (object) required
post_rest_api_2_issue_archiveEnables 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. You can use the get taskhttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/ api-rest-api-3-task-taskid-get and cancel taskhttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/ api-rest-api-3-task-taskid-cancel-post APIs to manage the request. Note that: you can't archive subtasks directly, only throughdata: {
. jql (string)
} (object) required
put_rest_api_2_issue_archiveEnables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issues archived in the process and the errors encountered, if any. Note that: you can't archive subtasks directly, only through their parent issues you can only archive issues from software, service management, and business projects Permissions permissions required: Jira admin or site admin: global permissionhttps://confluence.atlassian.com/x/x4dKLg License required: Premium ordata: {
. issueIdsOrKeys (array)
} (object) required
post_rest_api_2_issue_bulkCreates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set. The content of each issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata api-rest-api-2-issue-createmeta-get. These are the same fields that appear on the issues'data: {
. issueUpdates (array)
} (object) required
post_rest_api_2_issue_bulkfetchReturns the details for a set of requested issues. You can request up to 100 issues. Each issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. Issues will be returned in ascending id order. If there are errors, Jira will return a list of issues which couldn't be fetched along with error messages.data: {
. expand (array)
. fields (array)
. fieldsByKeys (boolean)
. issueIdsOrKeys (array)
. properties (array)
} (object) required
get_rest_api_2_issue_createmetaReturns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue api-rest-api-2-issue-post and Create issues api-rest-api-2-issue-bulk-post. Deprecated, see Create Issue Meta Endpoint Deprecation Noticehttps://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-1304. The request can be restricted to specific projects or issue types using the query parprojectIds (array)
projectKeys (array)
issuetypeIds (array)
issuetypeNames (array)
expand (string)
get_rest_api_2_issue_createmeta_by_project_id_or_key_issuetypesReturns a page of issue type metadata for a specified project. Use the information to populate the requests in Create issue api-rest-api-2-issue-post and Create issues api-rest-api-2-issue-bulk-post. This operation can be accessed anonymously. Permissions permissions required: Create issues project permissionhttps://confluence.atlassian.com/x/yodKLg in the requested projects.projectIdOrKey (string)
startAt (integer)
maxResults (integer)
get_rest_api_2_issue_createmeta_by_project_id_or_key_issuetypes_by_issue_type_idReturns a page of field metadata for a specified project and issuetype id. Use the information to populate the requests in Create issue api-rest-api-2-issue-post and Create issues api-rest-api-2-issue-bulk-post. This operation can be accessed anonymously. Permissions permissions required: Create issues project permissionhttps://confluence.atlassian.com/x/yodKLg in the requested projects.projectIdOrKey (string)
issueTypeId (string)
startAt (integer)
maxResults (integer)
get_rest_api_2_issue_limit_reportReturns all issues breaching and approaching per-issue limits. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg is required for the project the issues are in. Results may be incomplete otherwise Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.isReturningKeys (boolean)
get_rest_api_2_issue_pickerReturns 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. This operation returns two lists: History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter. Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter. This operationquery (string)
currentJQL (string)
currentIssueKey (string)
currentProjectId (string)
showSubTasks (boolean)
showSubTaskParent (boolean)
post_rest_api_2_issue_propertiesSets 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. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously. This operation is: transactional, either all properties are updated in all eligdata: {
. entitiesIds (array)
. properties (object)
} (object) required
post_rest_api_2_issue_properties_multiSets 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. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON. This operation is: asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. non-transactional. Updating some entities maydata: {
. issues (array)
} (object) required
delete_rest_api_2_issue_properties_by_property_keyDeletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The criteria the filter used to identify eligible issues are: entityIds Only issues from this list are eligible. currentValue Only issues with the property set to this value are eligible. If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible. If no filter criteria are specified, all the issues visiblepropertyKey (string)
data: {
. currentValue
. entityIds (array)
} (object) required
put_rest_api_2_issue_properties_by_property_keySets a property value on multiple issues. The value set can be a constant or determined by a Jira expressionhttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictionshttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/ restrictions that apply to all Jira expressions. The issues to be updated can be specified by a filter. The fpropertyKey (string)
data: {
. expression (string)
. filter
. value
} (object) required
put_rest_api_2_issue_unarchiveEnables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issues unarchived in the process and the errors encountered, if any. Note that: you can't unarchive subtasks directly, only through their parent issues you can only unarchive issues from software, service management, and business projects Permissions permissions required: Jira admin or site admin: global permissionhttps://confluence.atlassian.com/x/x4dKLg License required: Predata: {
. issueIdsOrKeys (array)
} (object) required
post_rest_api_2_issue_watchingReturns, 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. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that tdata: {
. issueIds (array)
} (object) required
delete_rest_api_2_issue_by_issue_id_or_keyDeletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks. This causes the issue's subtasks to be deleted with the issue. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Delete issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-issueIdOrKey (string)
deleteSubtasks (string)
get_rest_api_2_issue_by_issue_id_or_keyReturns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atissueIdOrKey (string)
fields (array)
fieldsByKeys (boolean)
expand (string)
properties (array)
updateHistory (boolean)
failFast (boolean)
put_rest_api_2_issue_by_issue_id_or_keyEdits an issue. Issue properties may be updated as part of the edit. Please note that issue transition is not supported and is ignored here. To transition an issue, please use Transition issue api-rest-api-2-issue-issueIdOrKey-transitions-post. The edits to the issue's fields are defined using update and fields. The fields that can be edited are determined using Get edit issue metadata api-rest-api-2-issue-issueIdOrKey-editmeta-get. The parent field may be set by key or ID. For standard issueissueIdOrKey (string)
notifyUsers (boolean)
overrideScreenSecurity (boolean)
overrideEditableFlag (boolean)
returnIssue (boolean)
expand (string)
data: {
. fields (object)
. historyMetadata
. properties (array)
. transition
. update (object)
} (object) required
put_rest_api_2_issue_by_issue_id_or_key_assigneeAssigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in. If name or accountId is set to: '-1', the issue is assigned to the default assignee for the project. null, the issue is set to unassigned. This operation can be accessed anonymously. Permissions permissions required: Browse Projects and Assign Issues project permissionhttps://confluence.atlassian.comissueIdOrKey (string)
data: {
. accountId (string)
. accountType (string)
. active (boolean)
. applicationRoles
. avatarUrls
. displayName (string)
. emailAddress (string)
. expand (string)
. groups
. key (string)
. locale (string)
. name (string)
. self (string)
. timeZone (string)
} (object) required
post_rest_api_2_issue_by_issue_id_or_key_attachmentsAdds one or more attachments to an issue. Attachments are posted as multipart/form-data RFC 1867https://www.ietf.org/rfc/rfc1867.txt. Note that: The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers special-request-headers for more information. The name of the multipart/form-data parameter that contains the attachments must be file. The following examples upload a file called myfile.txt to the issue TEST-123: curl curl --loissueIdOrKey (string)
get_rest_api_2_issue_by_issue_id_or_key_changelogReturns a paginated pagination list of all changelogs for an issue sorted by date, starting from the oldest. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
startAt (integer)
maxResults (integer)
post_rest_api_2_issue_by_issue_id_or_key_changelog_listReturns changelogs for an issue specified by a list of changelog IDs. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
data: {
. changelogIds (array)
} (object) required
get_rest_api_2_issue_by_issue_id_or_key_commentReturns all comments for an issue. This operation can be accessed anonymously. Permissions permissions required: Comments are included in the response where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the comment. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, belongs to the group or haissueIdOrKey (string)
startAt (integer)
maxResults (integer)
orderBy (string)
expand (string)
post_rest_api_2_issue_by_issue_id_or_key_commentAdds a comment to an issue. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Add comments project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue containing the comment is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
expand (string)
data: {
. author
. body (string)
. created (string)
. id (string)
. jsdAuthorCanSeeRequest (boolean)
. jsdPublic (boolean)
. properties (array)
. renderedBody (string)
. self (string)
. updateAuthor
. updated (string)
. visibility
} (object) required
delete_rest_api_2_issue_by_issue_id_or_key_comment_by_idDeletes a comment. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue containing the comment is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. Delete all comments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete any comment or Delete own comments to delete comment created by the user, IissueIdOrKey (string)
id (string)
get_rest_api_2_issue_by_issue_id_or_key_comment_by_idReturns a comment. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the comment. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
id (string)
expand (string)
put_rest_api_2_issue_by_issue_id_or_key_comment_by_idUpdates a comment. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue containing the comment is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. Edit all comments project permissionhttps://confluence.atlassian.com/x/yodKLg to update any comment or Edit own comments toissueIdOrKey (string)
id (string)
notifyUsers (boolean)
overrideEditableFlag (boolean)
expand (string)
data: {
. author
. body (string)
. created (string)
. id (string)
. jsdAuthorCanSeeRequest (boolean)
. jsdPublic (boolean)
. properties (array)
. renderedBody (string)
. self (string)
. updateAuthor
. updated (string)
. visibility
} (object) required
get_rest_api_2_issue_by_issue_id_or_key_editmetaReturns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue api-rest-api-2-issue-issueIdOrKey-put. This endpoint will check for these conditions: 1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. overrideScreenSecurity=true skips this condition. 2. Field is visible in the field configurationhttps://support.atlassian.comissueIdOrKey (string)
overrideScreenSecurity (boolean)
overrideEditableFlag (boolean)
post_rest_api_2_issue_by_issue_id_or_key_notifyCreates an email notification for an issue and adds it to the mail queue. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
data: {
. htmlBody (string)
. restrict
. subject (string)
. textBody (string)
. to
} (object) required
get_rest_api_2_issue_by_issue_id_or_key_propertiesReturns the URLs and keys of an issue's properties. This operation can be accessed anonymously. Permissions permissions required: Property details are only returned where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
delete_rest_api_2_issue_by_issue_id_or_key_properties_by_property_keyDeletes an issue's property. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Edit issues project permissionshttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
propertyKey (string)
get_rest_api_2_issue_by_issue_id_or_key_properties_by_property_keyReturns the key and value of an issue's property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
propertyKey (string)
put_rest_api_2_issue_by_issue_id_or_key_properties_by_property_keySets the value of an issue's property. Use this resource to store custom data against an issue. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Edit issues project permissionshttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.aissueIdOrKey (string)
propertyKey (string)
data (undefined) required
delete_rest_api_2_issue_by_issue_id_or_key_remotelinkDeletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support and id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Link issuissueIdOrKey (string)
globalId (string) required
get_rest_api_2_issue_by_issue_id_or_key_remotelinkReturns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support and id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. ThisissueIdOrKey (string)
globalId (string)
post_rest_api_2_issue_by_issue_id_or_key_remotelinkCreates or updates a remote issue link for an issue. If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Link issues project permissionhttps://confluence.atlissueIdOrKey (string)
data: {
. application
. globalId (string)
. object
. relationship (string)
} (object) required
delete_rest_api_2_issue_by_issue_id_or_key_remotelink_by_link_idDeletes a remote issue link from an issue. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects, Edit issues, and Link issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
linkId (string)
get_rest_api_2_issue_by_issue_id_or_key_remotelink_by_link_idReturns a remote issue link for an issue. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
linkId (string)
put_rest_api_2_issue_by_issue_id_or_key_remotelink_by_link_idUpdates a remote issue link for an issue. Note: Fields without values in the request are set to null. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Link issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-lissueIdOrKey (string)
linkId (string)
data: {
. application
. globalId (string)
. object
. relationship (string)
} (object) required
get_rest_api_2_issue_by_issue_id_or_key_transitionsReturns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status. Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list. This operation can be accessed anonymously. Permissions permissions required: A list or transition is returned only when the user has: Browse projects project permissionhttps://confluence.atlassian.issueIdOrKey (string)
expand (string)
transitionId (string)
skipRemoteOnlyCondition (boolean)
includeUnavailableTransitions (boolean)
sortByOpsBarAndStatus (boolean)
post_rest_api_2_issue_by_issue_id_or_key_transitionsPerforms an issue transition and, if the transition has a screen, updates the fields from the transition screen. sortByCategory To update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using Get transitions api-rest-api-2-issue-issueIdOrKey-transitions-get with the transitions.fields expand. This operation can be accessed anonymously. Permissions permissions required: Browse projects and TransitissueIdOrKey (string)
data: {
. fields (object)
. historyMetadata
. properties (array)
. transition
. update (object)
} (object) required
delete_rest_api_2_issue_by_issue_id_or_key_votesDeletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-leissueIdOrKey (string)
get_rest_api_2_issue_by_issue_id_or_key_votesReturns details about the votes on an issue. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is ini If issue-level securityhttps:/issueIdOrKey (string)
post_rest_api_2_issue_by_issue_id_or_key_votesAdds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level sissueIdOrKey (string)
delete_rest_api_2_issue_by_issue_id_or_key_watchersDeletes a user as a watcher of an issue. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, iissueIdOrKey (string)
username (string)
accountId (string)
get_rest_api_2_issue_by_issue_id_or_key_watchersReturns the watchers for an issue. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is ini If issue-level securityhttps://confluence.issueIdOrKey (string)
post_rest_api_2_issue_by_issue_id_or_key_watchersAdds a user as a watcher of an issue by passing the account ID of the user. For example, '5b10ac8d82e05b22cc7d4ef5'. If no user is specified the calling user is added. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yoissueIdOrKey (string)
data (string) required
delete_rest_api_2_issue_by_issue_id_or_key_worklogDeletes a list of worklogs from an issue. This is an experimental API with limitations: You can't delete more than 5000 worklogs at once. No notifications will be sent for deleted worklogs. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the projissueIdOrKey (string)
adjustEstimate (string)
overrideEditableFlag (boolean)
data: {
. ids (array)
} (object) required
get_rest_api_2_issue_by_issue_id_or_key_worklogReturns 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. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Workloads are only returned where the user has: Browse projects project permissionhttps://conflissueIdOrKey (string)
startAt (integer)
maxResults (integer)
startedAfter (integer)
startedBefore (integer)
expand (string)
post_rest_api_2_issue_by_issue_id_or_key_worklogAdds a worklog to an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Work on issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configurissueIdOrKey (string)
notifyUsers (boolean)
adjustEstimate (string)
newEstimate (string)
reduceBy (string)
expand (string)
overrideEditableFlag (boolean)
data: {
. author
. comment (string)
. created (string)
. id (string)
. issueId (string)
. properties (array)
. self (string)
. started (string)
. timeSpent (string)
. timeSpentSeconds (integer)
. updateAuthor
. updated (string)
. visibility
} (object) required
post_rest_api_2_issue_by_issue_id_or_key_worklog_moveMoves a list of worklogs from one issue to another. This is an experimental API with several limitations: You can't move more than 5000 worklogs at once. You can't move worklogs containing an attachment. You can't move worklogs restricted by project roles. No notifications will be sent for moved worklogs. No webhooks or events will be sent for moved worklogs. No issue history will be recorded for moved worklogs. Time tracking must be enabled in Jira, otherwise this operationissueIdOrKey (string)
adjustEstimate (string)
overrideEditableFlag (boolean)
data: {
. ids (array)
. issueIdOrKey (string)
} (object) required
delete_rest_api_2_issue_by_issue_id_or_key_worklog_by_idDeletes a worklog from an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-leveissueIdOrKey (string)
id (string)
notifyUsers (boolean)
adjustEstimate (string)
newEstimate (string)
increaseBy (string)
overrideEditableFlag (boolean)
get_rest_api_2_issue_by_issue_id_or_key_worklog_by_idReturns a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security perissueIdOrKey (string)
id (string)
expand (string)
put_rest_api_2_issue_by_issue_id_or_key_worklog_by_idUpdates a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security perissueIdOrKey (string)
id (string)
notifyUsers (boolean)
adjustEstimate (string)
newEstimate (string)
expand (string)
overrideEditableFlag (boolean)
data: {
. author
. comment (string)
. created (string)
. id (string)
. issueId (string)
. properties (array)
. self (string)
. started (string)
. timeSpent (string)
. timeSpentSeconds (integer)
. updateAuthor
. updated (string)
. visibility
} (object) required
get_rest_api_2_issue_by_issue_id_or_key_worklog_by_worklog_id_propertiesReturns the keys of all properties for a worklog. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
worklogId (string)
delete_rest_api_2_issue_by_issue_id_or_key_worklog_by_worklog_id_properties_by_property_keyDeletes a worklog property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
worklogId (string)
propertyKey (string)
get_rest_api_2_issue_by_issue_id_or_key_worklog_by_worklog_id_properties_by_property_keyReturns the value of a worklog property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
worklogId (string)
propertyKey (string)
put_rest_api_2_issue_by_issue_id_or_key_worklog_by_worklog_id_properties_by_property_keySets the value of a worklog property. Use this operation to store custom data against the worklog. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/xissueIdOrKey (string)
worklogId (string)
propertyKey (string)
data (undefined) required
post_rest_api_2_issue_linkCreates 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. To use this resource the site must have Issue Linkinghttps://confluence.atlassian.com/x/yoXKM enabled. This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/2/issue/linked issue key?fields=issuelinks. If the link request duplicates a link, the respodata: {
. comment
. inwardIssue
. outwardIssue
. type
} (object) required
delete_rest_api_2_issue_link_by_link_idDeletes an issue link. This operation can be accessed anonymously. Permissions permissions required: Browse project project permissionhttps://confluence.atlassian.com/x/yodKLg for all the projects containing the issues in the link. Link issues project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one of the projects containing issues in the link. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, permission to view both of the issues.linkId (string)
get_rest_api_2_issue_link_by_link_idReturns an issue link. This operation can be accessed anonymously. Permissions permissions required: Browse project project permissionhttps://confluence.atlassian.com/x/yodKLg for all the projects containing the linked issues. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, permission to view both of the issues.linkId (string)
get_rest_api_2_issue_link_typeReturns a list of all issue link types. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for a project in the site.No parameters
post_rest_api_2_issue_link_typeCreates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. id (string)
. inward (string)
. name (string)
. outward (string)
. self (string)
} (object) required
delete_rest_api_2_issue_link_type_by_issue_link_type_idDeletes an issue link type. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueLinkTypeId (string)
get_rest_api_2_issue_link_type_by_issue_link_type_idReturns an issue link type. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for a project in the site.issueLinkTypeId (string)
put_rest_api_2_issue_link_type_by_issue_link_type_idUpdates an issue link type. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueLinkTypeId (string)
data: {
. id (string)
. inward (string)
. name (string)
. outward (string)
. self (string)
} (object) required
put_rest_api_2_issues_archive_exportEnables 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. Note that this API only exports the values of system fields and archival-specific fields ArchivedBy and ArchivedDate. Custom fields aren't supported. Permissions permissions required: Jira admin or site admin: global permissionhttps://confluence.atlassian.com/x/x4dKLg License required: Premium or Enterdata: {
. archivedBy (array)
. archivedDateRange
. issueTypes (array)
. projects (array)
. reporters (array)
} (object) required
get_rest_api_2_issuesecurityschemesReturns all issue security schemeshttps://confluence.atlassian.com/x/J4lKLg. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
post_rest_api_2_issuesecurityschemesCreates 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. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. levels (array)
. name (string)
} (object) required
get_rest_api_2_issuesecurityschemes_levelReturns a paginated pagination list of issue security levels. Only issue security levels in the context of classic projects are returned. Filtering using IDs is inclusive: if you specify both security scheme IDs and level IDs, the result will include both specified issue security levels and all issue security levels from the specified schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
id (array)
schemeId (array)
onlyDefault (boolean)
put_rest_api_2_issuesecurityschemes_level_defaultSets default issue security levels for schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultValues (array)
} (object) required
get_rest_api_2_issuesecurityschemes_level_memberReturns a paginated pagination list of issue security level members. Only issue security level members in the context of classic projects are returned. Filtering using parameters is inclusive: if you specify both security scheme IDs and level IDs, the result will include all issue security level members from the specified schemes and levels. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
id (array)
schemeId (array)
levelId (array)
expand (string)
get_rest_api_2_issuesecurityschemes_projectReturns a paginated pagination mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Only issue security schemes in the context of classic projects are supported. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
issueSecuritySchemeId (array)
projectId (array)
put_rest_api_2_issuesecurityschemes_projectAssociates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. oldToNewSecurityLevelMappings (array)
. projectId (string)
. schemeId (string)
} (object) required
get_rest_api_2_issuesecurityschemes_searchReturns a paginated pagination list of issue security schemes. If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you filter by. Use to obtain all projects related to scheme. Only issue security schemes in the context of classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
id (array)
projectId (array)
get_rest_api_2_issuesecurityschemes_by_idReturns an issue security scheme along with its security levels. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for a project that uses the requested issue security scheme.id (integer)
put_rest_api_2_issuesecurityschemes_by_idUpdates the issue security scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_2_issuesecurityschemes_by_issue_security_scheme_id_membersReturns issue security level members. Only issue security level members in context of classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueSecuritySchemeId (integer)
startAt (integer)
maxResults (integer)
issueSecurityLevelId (array)
expand (string)
delete_rest_api_2_issuesecurityschemes_by_scheme_idDeletes an issue security scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
put_rest_api_2_issuesecurityschemes_by_scheme_id_levelAdds levels and levels' members to the issue security scheme. You can add up to 100 levels per request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
data: {
. levels (array)
} (object) required
delete_rest_api_2_issuesecurityschemes_by_scheme_id_level_by_level_idDeletes an issue security level. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
replaceWith (string)
put_rest_api_2_issuesecurityschemes_by_scheme_id_level_by_level_idUpdates the issue security level. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_issuesecurityschemes_by_scheme_id_level_by_level_id_memberAdds members to the issue security level. You can add up to 100 members per request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
data: {
. members (array)
} (object) required
delete_rest_api_2_issuesecurityschemes_by_scheme_id_level_by_level_id_member_by_member_idRemoves an issue security level member from an issue security scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
memberId (string)
get_rest_api_2_issuetypeReturns all issue types. This operation can be accessed anonymously. Permissions permissions required: Issue types are only returned as follows: if the user has the Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, all issue types are returned. if the user has the Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for one or more projects, the issue types associated with the projects the user has permission to browse are returned. ifNo parameters
post_rest_api_2_issuetypeCreates an issue type and adds it to the default issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. hierarchyLevel (integer)
. name (string)
. type (string)
} (object) required
get_rest_api_2_issuetype_projectReturns issue types for a project. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg in the relevant project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectId (integer) required
level (integer)
delete_rest_api_2_issuetype_by_idDeletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type alternativeIssueTypeId. A list of alternative issue types are obtained from the Get alternative issue types api-rest-api-2-issuetype-id-alternatives-get resource. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
alternativeIssueTypeId (string)
get_rest_api_2_issuetype_by_idReturns an issue type. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg in a project the issue type is associated with or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
put_rest_api_2_issuetype_by_idUpdates the issue type. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. avatarId (integer)
. description (string)
. name (string)
} (object) required
get_rest_api_2_issuetype_by_id_alternativesReturns 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. This operation can be accessed anonymously. Permissions permissions required: None.id (string)
post_rest_api_2_issuetype_by_id_avatar2Loads an avatar for the issue type. Specify the avatar's local file location in the body of the request. Also, include the following headers: X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers special-request-headers. Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:api_token --header 'X-Atlassian-Token: no-check' --header 'Content-Typeid (string)
x (integer)
y (integer)
size (integer) required
get_rest_api_2_issuetype_by_issue_type_id_propertiesReturns all the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties keys of the issue type. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg to get the property keys of any issue type. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg to get the property kissueTypeId (string)
delete_rest_api_2_issuetype_by_issue_type_id_properties_by_property_keyDeletes the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeId (string)
propertyKey (string)
get_rest_api_2_issuetype_by_issue_type_id_properties_by_property_keyReturns the key and value of the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg to get the details of any issue type. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg to get the details of any issue tissueTypeId (string)
propertyKey (string)
put_rest_api_2_issuetype_by_issue_type_id_properties_by_property_keyCreates or updates the value of the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. Use this resource to store and update data against an issue type. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.issueTypeId (string)
propertyKey (string)
data (undefined) required
get_rest_api_2_issuetypeschemeReturns a paginated pagination list of issue type schemes. Only issue type schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
orderBy (string)
expand (string)
queryString (string)
post_rest_api_2_issuetypeschemeCreates an issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultIssueTypeId (string)
. description (string)
. issueTypeIds (array)
. name (string)
} (object) required
get_rest_api_2_issuetypescheme_mappingReturns a paginated pagination list of issue type scheme items. Only issue type scheme items used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
issueTypeSchemeId (array)
get_rest_api_2_issuetypescheme_projectReturns a paginated pagination list of issue type schemes and, for each issue type scheme, a list of the projects that use it. Only issue type schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
projectId (array) required
put_rest_api_2_issuetypescheme_projectAssigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme. Issue type schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. issueTypeSchemeId (string)
. projectId (string)
} (object) required
delete_rest_api_2_issuetypescheme_by_issue_type_scheme_idDeletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Any projects assigned to the scheme are reassigned to the default issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
put_rest_api_2_issuetypescheme_by_issue_type_scheme_idUpdates an issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
data: {
. defaultIssueTypeId (string)
. description (string)
. name (string)
} (object) required
put_rest_api_2_issuetypescheme_by_issue_type_scheme_id_issuetypeAdds issue types to an issue type scheme. The added issue types are appended to the issue types list. If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
data: {
. issueTypeIds (array)
} (object) required
put_rest_api_2_issuetypescheme_by_issue_type_scheme_id_issuetype_moveChanges the order of issue types in an issue type scheme. The request body parameters must meet the following requirements: all of the issue types must belong to the issue type scheme. either after or position must be provided. the issue type in after must not be in the issue type list. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
data: {
. after (string)
. issueTypeIds (array)
. position (string)
} (object) required
delete_rest_api_2_issuetypescheme_by_issue_type_scheme_id_issuetype_by_issue_type_idRemoves an issue type from an issue type scheme. This operation cannot remove: any issue type used by issues. any issue types from the default issue type scheme. the last standard issue type from an issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
issueTypeId (integer)
get_rest_api_2_issuetypescreenschemeReturns a paginated pagination list of issue type screen schemes. Only issue type screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
queryString (string)
orderBy (string)
expand (string)
post_rest_api_2_issuetypescreenschemeCreates an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. issueTypeMappings (array)
. name (string)
} (object) required
get_rest_api_2_issuetypescreenscheme_mappingReturns a paginated pagination list of issue type screen scheme items. Only issue type screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
issueTypeScreenSchemeId (array)
get_rest_api_2_issuetypescreenscheme_projectReturns a paginated pagination list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it. Only issue type screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
projectId (array) required
put_rest_api_2_issuetypescreenscheme_projectAssigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. issueTypeScreenSchemeId (string)
. projectId (string)
} (object) required
delete_rest_api_2_issuetypescreenscheme_by_issue_type_screen_scheme_idDeletes an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
put_rest_api_2_issuetypescreenscheme_by_issue_type_screen_scheme_idUpdates an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_issuetypescreenscheme_by_issue_type_screen_scheme_id_mappingAppends issue type to screen scheme mappings to an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. issueTypeMappings (array)
} (object) required
put_rest_api_2_issuetypescreenscheme_by_issue_type_screen_scheme_id_mapping_defaultUpdates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. screenSchemeId (string)
} (object) required
post_rest_api_2_issuetypescreenscheme_by_issue_type_screen_scheme_id_mapping_removeRemoves issue type to screen scheme mappings from an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. issueTypeIds (array)
} (object) required
get_rest_api_2_issuetypescreenscheme_by_issue_type_screen_scheme_id_projectReturns a paginated pagination list of projects associated with an issue type screen scheme. Only company-managed projects associated with an issue type screen scheme are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (integer)
startAt (integer)
maxResults (integer)
query (string)
get_rest_api_2_jql_autocompletedataReturns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields referencehttps://confluence.atlassian.com/x/gwORLQ and Advanced searching - functions referencehttps://confluence.atlassian.com/x/hgORLQ, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. To filter visible field details by project or coNo parameters
post_rest_api_2_jql_autocompletedataReturns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields referencehttps://confluence.atlassian.com/x/gwORLQ and Advanced searching - functions referencehttps://confluence.atlassian.com/x/hgORLQ, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. This operation can filter the custom fields retudata: {
. includeCollapsedFields (boolean)
. projectIds (array)
} (object) required
get_rest_api_2_jql_autocompletedata_suggestionsReturns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: fieldName to get a list of all values for the field. fieldName and fieldValue to get a list of values containing the text in fieldValue. fieldName and predicateName to get a list of all predicate values for the field. fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue. This operation can be accessed anonymously.fieldName (string)
fieldValue (string)
predicateName (string)
predicateValue (string)
get_rest_api_2_jql_function_computationReturns the list of a function's precomputations along with information about when they were created, updated, and last used. Each precomputation has a value - the JQL fragment to replace the custom function clause with. Permissions permissions required: This API is only accessible to apps and apps can only inspect their own functions. The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list becfunctionKey (array)
startAt (integer)
maxResults (integer)
orderBy (string)
post_rest_api_2_jql_function_computationUpdate the precomputation value of a function created by a Forge/Connect app. Permissions permissions required: An API for apps to update their own precomputations. The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.skipNotFoundPrecomputations (boolean)
data: {
. values (array)
} (object) required
post_rest_api_2_jql_function_computation_searchReturns function precomputations by IDs, along with information about when they were created, updated, and last used. Each precomputation has a value - the JQL fragment to replace the custom function clause with. Permissions permissions required: This API is only accessible to apps and apps can only inspect their own functions. The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because weorderBy (string)
data: {
. precomputationIDs (array)
} (object) required
post_rest_api_2_jql_matchChecks whether one or more issues would be returned by one or more JQL queries. Permissions permissions required: None, however, issues are only matched against JQL queries where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.data: {
. issueIds (array)
. jqls (array)
} (object) required
post_rest_api_2_jql_parseParses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. Permissions permissions required: None.validation (string) required
data: {
. queries (array)
} (object) required
post_rest_api_2_jql_pdcleanerConverts one or more JQL queries with user identifiers username or user key to equivalent JQL queries with account IDs. You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guidehttps://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/. Permissions permissions required: Permission to access Jira.data: {
. queryStrings (array)
} (object) required
post_rest_api_2_jql_sanitizeSanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity. For example, if the query contains the clause project = 'Secret project', and a user does not have browse permission for the project 'Secret project', the sanitized query replaces the clause with project = 12345' where 12345 is the ID of the project. If a user has the required permission, the clause is not sanitized. If the account ID is null, sanitizing is performedata: {
. queries (array)
} (object) required
get_rest_api_2_labelReturns a paginated pagination list of labels.startAt (integer)
maxResults (integer)
get_rest_api_2_license_approximate_license_countReturns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
get_rest_api_2_license_approximate_license_count_product_by_application_keyReturns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.applicationKey (string)
get_rest_api_2_mypermissionsReturns 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. The user is reported as having a project permission: in the global context, if the user has the project permission in any project. for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project pprojectKey (string)
projectId (string)
issueKey (string)
issueId (string)
permissions (string)
projectUuid (string)
projectConfigurationUuid (string)
commentId (string)
delete_rest_api_2_mypreferencesDeletes a preference of the user, which restores the default value of system defined settings. Note that these keys are deprecated: jira.user.locale The locale of the user. By default, not set. The user takes the instance locale. jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone. Use Update a user profilehttps://developer.atlassian.com/cloud/admin/user-management/rest/ api-users-account-id-manage-profile-patch from the user managemekey (string) required
get_rest_api_2_mypreferencesReturns the value of a preference of the current user. Note that these keys are deprecated: jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance. jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance. These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not have any impact on Notification behaviour.key (string) required
put_rest_api_2_mypreferencesCreates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created: user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html. user.default.share.private Whether new filtershttps://confluence.atlassian.com/x/eQiiLQ are set to prkey (string) required
data (string) required
get_rest_api_2_mypreferences_localeReturns the locale for the user. If the user has no language preference set which is the default setting or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
put_rest_api_2_mypreferences_localeDeprecated, use Update a user profilehttps://developer.atlassian.com/cloud/admin/user-management/rest/ api-users-account-id-manage-profile-patch from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the instance of Jira. Permissions permissions required: Permission to access Jira.data: {
. locale (string)
} (object) required
get_rest_api_2_myselfReturns details for the current user. Permissions permissions required: Permission to access Jira.expand (string)
get_rest_api_2_notificationschemeReturns a paginated pagination list of notification schemeshttps://confluence.atlassian.com/x/8YdKLg ordered by the display name. Note that you should allow for events without recipients to appear in responses. Permissions permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.startAt (string)
maxResults (string)
id (array)
projectId (array)
onlyDefault (boolean)
expand (string)
post_rest_api_2_notificationschemeCreates a notification scheme with notifications. You can create up to 1000 notifications per request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
. notificationSchemeEvents (array)
} (object) required
get_rest_api_2_notificationscheme_projectReturns a paginated pagination 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. Note that only company-managed classic projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId. Permissions permissions required: Permission to accessstartAt (string)
maxResults (string)
notificationSchemeId (array)
projectId (array)
get_rest_api_2_notificationscheme_by_idReturns a notification schemehttps://confluence.atlassian.com/x/8YdKLg, including the list of events and the recipients who will receive notifications for those events. Permissions permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.id (integer)
expand (string)
put_rest_api_2_notificationscheme_by_idUpdates a notification scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_notificationscheme_by_id_notificationAdds notifications to a notification scheme. You can add up to 1000 notifications per request. Deprecated: The notification type EmailAddress is no longer supported in Cloud. Refer to the changeloghttps://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-1031 for more details. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. notificationSchemeEvents (array)
} (object) required
delete_rest_api_2_notificationscheme_by_notification_scheme_idDeletes a notification scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.notificationSchemeId (string)
delete_rest_api_2_notificationscheme_by_notification_scheme_id_notification_by_notification_idRemoves a notification from a notification scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.notificationSchemeId (string)
notificationId (string)
get_rest_api_2_permissionsReturns all permissions, including: global permissions. project permissions. global permissions added by plugins. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
post_rest_api_2_permissions_checkReturns: for a list of global permissions, the global permissions granted to a user. for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate. If no account ID is provided, the operation returns details for the logged in user. Note that: Invalid project and issue IDs are ignored. A maximum of 1000 projects and 1000 issues can be checked. Null values in globalPermissions, prdata: {
. accountId (string)
. globalPermissions (array)
. projectPermissions (array)
} (object) required
post_rest_api_2_permissions_projectReturns all the projects where the user is granted a list of project permissions. This operation can be accessed anonymously. Permissions permissions required: None.data: {
. permissions (array)
} (object) required
get_rest_api_2_permissionschemeReturns all permission schemes. About permission schemes and grants A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission. Holder object The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is 'type': 'group', and the parameter is the group name,expand (string)
post_rest_api_2_permissionschemeCreates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.expand (string)
data: {
. description (string)
. expand (string)
. id (integer)
. name (string)
. permissions (array)
. scope
. self (string)
} (object) required
delete_rest_api_2_permissionscheme_by_scheme_idDeletes a permission scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
get_rest_api_2_permissionscheme_by_scheme_idReturns a permission scheme. Permissions permissions required: Permission to access Jira.schemeId (integer)
expand (string)
put_rest_api_2_permissionscheme_by_scheme_idUpdates a permission scheme. Below are some important things to note when using this resource: If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants. If you want to update only the name and description, then do not send a permissions list in the request. Sending an empty list will remove all permission grants from the permission scheme. If you want to add or delete a permission grant instead of updating the whole listschemeId (integer)
expand (string)
data: {
. description (string)
. expand (string)
. id (integer)
. name (string)
. permissions (array)
. scope
. self (string)
} (object) required
get_rest_api_2_permissionscheme_by_scheme_id_permissionReturns all permission grants for a permission scheme. Permissions permissions required: Permission to access Jira.schemeId (integer)
expand (string)
post_rest_api_2_permissionscheme_by_scheme_id_permissionCreates a permission grant in a permission scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
expand (string)
data: {
. holder
. id (integer)
. permission (string)
. self (string)
} (object) required
delete_rest_api_2_permissionscheme_by_scheme_id_permission_by_permission_idDeletes a permission grant from a permission scheme. See About permission schemes and grants../api-group-permission-schemes/ about-permission-schemes-and-grants for more details. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
permissionId (integer)
get_rest_api_2_permissionscheme_by_scheme_id_permission_by_permission_idReturns a permission grant. Permissions permissions required: Permission to access Jira.schemeId (integer)
permissionId (integer)
expand (string)
get_rest_api_2_plans_planReturns a paginated pagination list of plans. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.includeTrashed (boolean)
includeArchived (boolean)
cursor (string)
maxResults (integer)
post_rest_api_2_plans_planCreates a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.useGroupId (boolean)
data: {
. crossProjectReleases (array)
. customFields (array)
. exclusionRules
. issueSources (array)
. leadAccountId (string)
. name (string)
. permissions (array)
. scheduling
} (object) required
get_rest_api_2_plans_plan_by_plan_idReturns a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
useGroupId (boolean)
put_rest_api_2_plans_plan_by_plan_idUpdates any of the following details of a plan using JSON Patchhttps://datatracker.ietf.org/doc/html/rfc6902. name leadAccountId scheduling estimation with StoryPoints, Days or Hours as possible values startDate type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values dateCustomFieldId endDate type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible valuesplanId (integer)
useGroupId (boolean)
put_rest_api_2_plans_plan_by_plan_id_archiveArchives a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
post_rest_api_2_plans_plan_by_plan_id_duplicateDuplicates a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
data: {
. name (string)
} (object) required
get_rest_api_2_plans_plan_by_plan_id_teamReturns a paginated pagination list of plan-only and Atlassian teams in a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
cursor (string)
maxResults (integer)
post_rest_api_2_plans_plan_by_plan_id_team_atlassianAdds an existing Atlassian team to a plan and configures their plannning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
data: {
. capacity (number)
. id (string)
. issueSourceId (integer)
. planningStyle (string)
. sprintLength (integer)
} (object) required
delete_rest_api_2_plans_plan_by_plan_id_team_atlassian_by_atlassian_team_idRemoves an Atlassian team from a plan and deletes their planning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
atlassianTeamId (string)
get_rest_api_2_plans_plan_by_plan_id_team_atlassian_by_atlassian_team_idReturns planning settings for an Atlassian team in a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
atlassianTeamId (string)
put_rest_api_2_plans_plan_by_plan_id_team_atlassian_by_atlassian_team_idUpdates any of the following planning settings of an Atlassian team in a plan using JSON Patchhttps://datatracker.ietf.org/doc/html/rfc6902. planningStyle issueSourceId sprintLength capacity Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Note that 'add' operations do not respect array indexes in target locations. Call the 'Get Atlassian team in plan' endpoint to find out the order of array elements.planId (integer)
atlassianTeamId (string)
post_rest_api_2_plans_plan_by_plan_id_team_planonlyCreates a plan-only team and configures their planning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
data: {
. capacity (number)
. issueSourceId (integer)
. memberAccountIds (array)
. name (string)
. planningStyle (string)
. sprintLength (integer)
} (object) required
delete_rest_api_2_plans_plan_by_plan_id_team_planonly_by_plan_only_team_idDeletes a plan-only team and their planning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
planOnlyTeamId (integer)
get_rest_api_2_plans_plan_by_plan_id_team_planonly_by_plan_only_team_idReturns planning settings for a plan-only team. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
planOnlyTeamId (integer)
put_rest_api_2_plans_plan_by_plan_id_team_planonly_by_plan_only_team_idUpdates any of the following planning settings of a plan-only team using JSON Patchhttps://datatracker.ietf.org/doc/html/rfc6902. name planningStyle issueSourceId sprintLength capacity memberAccountIds Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Note that 'add' operations do not respect array indexes in target locations. Call the 'Get plan-only team' endpoint to find out the order of array elements.planId (integer)
planOnlyTeamId (integer)
put_rest_api_2_plans_plan_by_plan_id_trashMoves a plan to trash. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
get_rest_api_2_priorityReturns the list of all issue priorities. Permissions permissions required: Permission to access Jira.No parameters
post_rest_api_2_priorityCreates an issue priority. Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changeloghttps://developer.atlassian.com/changelog/ CHANGE-1525. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. avatarId (integer)
. description (string)
. iconUrl (string)
. name (string)
. statusColor (string)
} (object) required
put_rest_api_2_priority_defaultSets default issue priority. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. id (string)
} (object) required
put_rest_api_2_priority_moveChanges the order of issue priorities. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. after (string)
. ids (array)
. position (string)
} (object) required
get_rest_api_2_priority_searchReturns a paginated pagination list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria: a list of priority IDs. Any invalid priority IDs are ignored. a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored. whether the field configuration is a default. This returns priorities from company-managed classic projects only, as there is no concept of default pstartAt (string)
maxResults (string)
id (array)
projectId (array)
priorityName (string)
onlyDefault (boolean)
expand (string)
delete_rest_api_2_priority_by_idDeletes an issue priority. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
get_rest_api_2_priority_by_idReturns an issue priority. Permissions permissions required: Permission to access Jira.id (string)
put_rest_api_2_priority_by_idUpdates an issue priority. At least one request body parameter must be defined. Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changeloghttps://developer.atlassian.com/changelog/ CHANGE-1525. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. avatarId (integer)
. description (string)
. iconUrl (string)
. name (string)
. statusColor (string)
} (object) required
get_rest_api_2_priorityschemeReturns a paginated pagination list of priority schemes. Permissions permissions required: Permission to access Jira.startAt (string)
maxResults (string)
priorityId (array)
schemeId (array)
schemeName (string)
onlyDefault (boolean)
orderBy (string)
expand (string)
post_rest_api_2_priorityschemeCreates a new priority scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultPriorityId (integer)
. description (string)
. mappings
. name (string)
. priorityIds (array)
. projectIds (array)
} (object) required
post_rest_api_2_priorityscheme_mappingsReturns a paginated pagination list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme. Permissions permissions required: Permission to access Jira.data: {
. maxResults (integer)
. priorities
. projects
. schemeId (integer)
. startAt (integer)
} (object) required
get_rest_api_2_priorityscheme_priorities_availableReturns a paginated pagination list of priorities available for adding to a priority scheme. Permissions permissions required: Permission to access Jira.startAt (string)
maxResults (string)
query (string)
schemeId (string) required
exclude (array)
delete_rest_api_2_priorityscheme_by_scheme_idDeletes a priority scheme. This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
put_rest_api_2_priorityscheme_by_scheme_idUpdates a priority scheme. This includes its details, the lists of priorities and projects in it Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
data: {
. defaultPriorityId (integer)
. description (string)
. mappings
. name (string)
. priorities
. projects
} (object) required
get_rest_api_2_priorityscheme_by_scheme_id_prioritiesReturns a paginated pagination list of priorities by scheme. Permissions permissions required: Permission to access Jira.schemeId (string)
startAt (string)
maxResults (string)
get_rest_api_2_priorityscheme_by_scheme_id_projectsReturns a paginated pagination list of projects by scheme. Permissions permissions required: Permission to access Jira.schemeId (string)
startAt (string)
maxResults (string)
projectId (array)
query (string)
get_rest_api_2_projectReturns all projects visible to the user. Deprecated, use Get projects paginated api-rest-api-2-project-search-get that supports search and pagination. This operation can be accessed anonymously. Permissions permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.expand (string)
recent (integer)
properties (array)
post_rest_api_2_projectCreates a project based on a project type template, as shown in the following table: | Project Type Key | Project Template Key | |--|--| | business | com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-cordata: {
. assigneeType (string)
. avatarId (integer)
. categoryId (integer)
. description (string)
. fieldConfigurationScheme (integer)
. issueSecurityScheme (integer)
. issueTypeScheme (integer)
. issueTypeScreenScheme (integer)
. key (string)
. lead (string)
. leadAccountId (string)
. name (string)
. notificationScheme (integer)
. permissionScheme (integer)
. projectTemplateKey (string)
. projectTypeKey (string)
. url (string)
. workflowScheme (integer)
} (object) required
post_rest_api_2_project_templateCreates a project based on a custom template provided in the request. The request body should contain the project details and the capabilities that comprise the project: details - represents the project details settings template - represents a list of capabilities responsible for creating specific parts of a project A capability is defined as a unit of configuration for the project you want to create. This operation is: asynchronous async. Follow the Location link in the response hdata: {
. details
. template
} (object) required
put_rest_api_2_project_template_edit_templateEdit custom template This API endpoint allows you to edit an existing customised template. Note: Custom Templates are only supported for Jira Enterprise edition.data: {
. templateDescription (string)
. templateGenerationOptions
. templateKey (string)
. templateName (string)
} (object) required
get_rest_api_2_project_template_live_templateGet custom template This API endpoint allows you to get a live custom project template details by either templateKey or projectId Note: Custom Templates are only supported for Jira Enterprise edition.projectId (string)
templateKey (string)
delete_rest_api_2_project_template_remove_templateRemove custom template This API endpoint allows you to remove a specified customised template Note: Custom Templates are only supported for Jira Enterprise edition.templateKey (string) required
post_rest_api_2_project_template_save_templateSave custom template This API endpoint allows you to save a customised template Note: Custom Templates are only supported for Jira Enterprise edition.data: {
. templateDescription (string)
. templateFromProjectRequest
. templateName (string)
} (object) required
get_rest_api_2_project_recentReturns a list of up to 20 projects recently viewed by the user that are still visible to the user. This operation can be accessed anonymously. Permissions permissions required: Projects are returned only where the user has one of: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Jira global permissionhttps://confluence.atlassian.com/expand (string)
properties (array)
get_rest_api_2_project_searchReturns a paginated pagination list of projects visible to the user. This operation can be accessed anonymously. Permissions permissions required: Projects are returned only where the user has one of: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
orderBy (string)
id (array)
keys (array)
query (string)
typeKey (string)
categoryId (integer)
action (string)
expand (string)
status (array)
properties (array)
propertyQuery (string)
get_rest_api_2_project_typeReturns all project typeshttps://confluence.atlassian.com/x/Var1Nw, whether or not the instance has a valid license for each type. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
get_rest_api_2_project_type_accessibleReturns all project typeshttps://confluence.atlassian.com/x/Var1Nw with a valid license.No parameters
get_rest_api_2_project_type_by_project_type_keyReturns a project typehttps://confluence.atlassian.com/x/Var1Nw. This operation can be accessed anonymously. Permissions permissions required: None.projectTypeKey (string)
get_rest_api_2_project_type_by_project_type_key_accessibleReturns a project typehttps://confluence.atlassian.com/x/Var1Nw if it is accessible to the user. Permissions permissions required: Permission to access Jira.projectTypeKey (string)
delete_rest_api_2_project_by_project_id_or_keyDeletes a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
enableUndo (boolean)
get_rest_api_2_project_by_project_id_or_keyReturns the project detailshttps://confluence.atlassian.com/x/ahLpNw for a project. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
expand (string)
properties (array)
put_rest_api_2_project_by_project_id_or_keyUpdates the project detailshttps://confluence.atlassian.com/x/ahLpNw of a project. All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. is only needed when changing the schemes or project key. Otherwise you will only need Administer Projects project permissionhttps://conflueprojectIdOrKey (string)
expand (string)
data: {
. assigneeType (string)
. avatarId (integer)
. categoryId (integer)
. description (string)
. issueSecurityScheme (integer)
. key (string)
. lead (string)
. leadAccountId (string)
. name (string)
. notificationScheme (integer)
. permissionScheme (integer)
. releasedProjectKeys (array)
. url (string)
} (object) required
post_rest_api_2_project_by_project_id_or_key_archiveArchives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
put_rest_api_2_project_by_project_id_or_key_avatarSets the avatar displayed for a project. Use Load project avatar api-rest-api-2-project-projectIdOrKey-avatar2-post to store avatars against the project, before using this operation to set the displayed avatar. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectIdOrKey (string)
data: {
. fileName (string)
. id (string)
. isDeletable (boolean)
. isSelected (boolean)
. isSystemAvatar (boolean)
. owner (string)
. urls (object)
} (object) required
delete_rest_api_2_project_by_project_id_or_key_avatar_by_idDeletes a custom avatar from a project. Note that system avatars cannot be deleted. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectIdOrKey (string)
id (integer)
post_rest_api_2_project_by_project_id_or_key_avatar2Loads an avatar for a project. Specify the avatar's local file location in the body of the request. Also, include the following headers: X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers special-request-headers. Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:api_token --header 'X-Atlassian-Token: no-check' --header 'Content-Type:projectIdOrKey (string)
x (integer)
y (integer)
size (integer)
get_rest_api_2_project_by_project_id_or_key_avatarsReturns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
delete_rest_api_2_project_by_project_id_or_key_classification_level_defaultRemove the default data classification level for a project. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
get_rest_api_2_project_by_project_id_or_key_classification_level_defaultReturns the default data classification for a project. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
put_rest_api_2_project_by_project_id_or_key_classification_level_defaultUpdates the default data classification level for a project. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
data: {
. id (string)
} (object) required
get_rest_api_2_project_by_project_id_or_key_componentReturns a paginated pagination list of all components in a project. See the Get project components api-rest-api-2-project-projectIdOrKey-components-get resource if you want to get a full list of versions without pagination. If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassiaprojectIdOrKey (string)
startAt (integer)
maxResults (integer)
orderBy (string)
componentSource (string)
query (string)
get_rest_api_2_project_by_project_id_or_key_componentsReturns all components in a project. See the Get project components paginated api-rest-api-2-project-projectIdOrKey-component-get resource if you want to get a full list of components with pagination. If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLprojectIdOrKey (string)
componentSource (string)
post_rest_api_2_project_by_project_id_or_key_deleteDeletes a project asynchronously. This operation is: transactional, that is, if part of the delete fails the project is not deleted. asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
get_rest_api_2_project_by_project_id_or_key_featuresReturns the list of features for a project.projectIdOrKey (string)
put_rest_api_2_project_by_project_id_or_key_features_by_feature_keySets the state of a project feature.projectIdOrKey (string)
featureKey (string)
data: {
. state (string)
} (object) required
get_rest_api_2_project_by_project_id_or_key_propertiesReturns all project propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties keys for the project. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
delete_rest_api_2_project_by_project_id_or_key_properties_by_property_keyDeletes the propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties from a project. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the property.projectIdOrKey (string)
propertyKey (string)
get_rest_api_2_project_by_project_id_or_key_properties_by_property_keyReturns the value of a project propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the property.projectIdOrKey (string)
propertyKey (string)
put_rest_api_2_project_by_project_id_or_key_properties_by_property_keySets the value of the project propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. You can use project properties to store custom data against the project. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permprojectIdOrKey (string)
propertyKey (string)
data (undefined) required
post_rest_api_2_project_by_project_id_or_key_restoreRestores a project that has been archived or placed in the Jira recycle bin. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLgfor Company managed projects. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project for Team managed projects.projectIdOrKey (string)
get_rest_api_2_project_by_project_id_or_key_roleReturns a list of project roleshttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/ for the project returning the name and self URL for each role. Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles api-rest-api-2-role-get for more information. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for any project onprojectIdOrKey (string)
delete_rest_api_2_project_by_project_id_or_key_role_by_idDeletes actors from a project role for the project. To remove default actors from the project role, use Delete default actors from project role api-rest-api-2-role-id-actors-delete. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
id (integer)
user (string)
group (string)
groupId (string)
get_rest_api_2_project_by_project_id_or_key_role_by_idReturns a project role's details and actors associated with the project. The list of actors is sorted by display name. To check whether a user belongs to a role based on their group memberships, use Get user api-rest-api-2-user-get with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluprojectIdOrKey (string)
id (integer)
excludeInactiveUsers (boolean)
post_rest_api_2_project_by_project_id_or_key_role_by_idAdds actors to a project role for the project. To replace all actors for the project, use Set actors for project role api-rest-api-2-project-projectIdOrKey-role-id-put. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
id (integer)
data: {
. group (array)
. groupId (array)
. user (array)
} (object) required
put_rest_api_2_project_by_project_id_or_key_role_by_idSets the actors for a project role for a project, replacing all existing actors. To add actors to the project without overwriting the existing list, use Add actors to project role api-rest-api-2-project-projectIdOrKey-role-id-post. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
id (integer)
data: {
. categorisedActors (object)
. id (integer)
} (object) required
get_rest_api_2_project_by_project_id_or_key_roledetailsReturns all project roleshttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/ and the details for each role. Note that the list of project roles is common to all projects. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
currentMember (boolean)
excludeConnectAddons (boolean)
excludeOtherServiceRoles (boolean)
get_rest_api_2_project_by_project_id_or_key_statusesReturns 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. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
get_rest_api_2_project_by_project_id_or_key_versionReturns a paginated pagination list of all versions in a project. See the Get project versions api-rest-api-2-project-projectIdOrKey-versions-get resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
startAt (integer)
maxResults (integer)
orderBy (string)
query (string)
status (string)
expand (string)
get_rest_api_2_project_by_project_id_or_key_versionsReturns all versions in a project. The response is not paginated. Use Get project versions paginated api-rest-api-2-project-projectIdOrKey-version-get if you want to get the versions in a project with pagination. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
expand (string)
get_rest_api_2_project_by_project_id_emailReturns the project's sender email addresshttps://confluence.atlassian.com/x/dolKLg. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectId (integer)
put_rest_api_2_project_by_project_id_emailSets the project's sender email addresshttps://confluence.atlassian.com/x/dolKLg. If emailAddress is an empty string, the default email address is restored. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permission.https://confluence.atlassian.com/x/yodKLgprojectId (integer)
data: {
. emailAddress (string)
. emailAddressStatus (array)
} (object) required
get_rest_api_2_project_by_project_id_hierarchyGet the issue type hierarchy for a next-gen project. The issue type hierarchy for a project consists of: Epic at level 1 optional. One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic. Subtask at level -1 optional. This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue. Permissions permiprojectId (integer)
get_rest_api_2_project_by_project_key_or_id_issuesecuritylevelschemeReturns the issue security schemehttps://confluence.atlassian.com/x/J4lKLg associated with the project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or the Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectKeyOrId (string)
get_rest_api_2_project_by_project_key_or_id_notificationschemeGets a notification schemehttps://confluence.atlassian.com/x/8YdKLg associated with the project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectKeyOrId (string)
expand (string)
get_rest_api_2_project_by_project_key_or_id_permissionschemeGets the permission schemehttps://confluence.atlassian.com/x/yodKLg associated with the project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectKeyOrId (string)
expand (string)
put_rest_api_2_project_by_project_key_or_id_permissionschemeAssigns a permission scheme with a project. See Managing project permissionshttps://confluence.atlassian.com/x/yodKLg for more information about permission schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLgprojectKeyOrId (string)
expand (string)
data: {
. id (integer)
} (object) required
get_rest_api_2_project_by_project_key_or_id_securitylevelReturns all issue securityhttps://confluence.atlassian.com/x/J4lKLg levels for the project that the user has access to. This operation can be accessed anonymously. Permissions permissions required: Browse projects global permissionhttps://confluence.atlassian.com/x/x4dKLg for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permissionhttps://confluence.atlassian.com/x/x4dKLg for the project.projectKeyOrId (string)
get_rest_api_2_project_categoryReturns all project categories. Permissions permissions required: Permission to access Jira.No parameters
post_rest_api_2_project_categoryCreates a project category. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. id (string)
. name (string)
. self (string)
} (object) required
delete_rest_api_2_project_category_by_idDeletes a project category. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_2_project_category_by_idReturns a project category. Permissions permissions required: Permission to access Jira.id (integer)
put_rest_api_2_project_category_by_idUpdates a project category. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. id (string)
. name (string)
. self (string)
} (object) required
get_rest_api_2_projectvalidate_keyValidates a project key by confirming the key is a valid string and not in use. Permissions permissions required: None.key (string)
get_rest_api_2_projectvalidate_valid_project_keyValidates a project key and, if the key is invalid or in use, generates a valid random string for the project key. Permissions permissions required: None.key (string)
get_rest_api_2_projectvalidate_valid_project_nameChecks 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. If a valid project name cannot be generated, a 404 response is returned. Permissions permissions required: None.name (string) required
post_rest_api_2_redactSubmit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously. The redaction status can be polled using the job id.data: {
. redactions (array)
} (object) required
get_rest_api_2_redact_status_by_job_idRetrieves the current status of a redaction job ID. The jobStatus will be one of the following: IN_PROGRESS - The redaction job is currently in progress COMPLETED - The redaction job has completed successfully. PENDING - The redaction job has not started yetjobId (string)
get_rest_api_2_resolutionReturns a list of all issue resolution values. Permissions permissions required: Permission to access Jira.No parameters
post_rest_api_2_resolutionCreates an issue resolution. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_resolution_defaultSets default issue resolution. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. id (string)
} (object) required
put_rest_api_2_resolution_moveChanges the order of issue resolutions. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. after (string)
. ids (array)
. position (string)
} (object) required
get_rest_api_2_resolution_searchReturns a paginated pagination list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria: a list of resolutions IDs. whether the field configuration is a default. This returns resolutions from company-managed classic projects only, as there is no concept of default resolutions in team-managed projects. Permissions permissions required: Permission to access Jira.startAt (string)
maxResults (string)
id (array)
onlyDefault (boolean)
delete_rest_api_2_resolution_by_idDeletes an issue resolution. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
replaceWith (string) required
get_rest_api_2_resolution_by_idReturns an issue resolution value. Permissions permissions required: Permission to access Jira.id (string)
put_rest_api_2_resolution_by_idUpdates an issue resolution. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_2_roleGets a list of all project roles, complete with project role details and default actors. About project roles Project roleshttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/ are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it unlike groups, which have the same membership throughout all Jira apNo parameters
post_rest_api_2_roleCreates a new project role with no default actors api-rest-api-2-resolution-get. You can use the Add default actors to project role api-rest-api-2-role-id-actors-post operation to add default actors to the project role after creating it. Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created. Permissions permissions required: Administerdata: {
. description (string)
. name (string)
} (object) required
delete_rest_api_2_role_by_idDeletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
swap (integer)
get_rest_api_2_role_by_idGets the project role details and the default actors associated with the role. The list of default actors is sorted by display name. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
post_rest_api_2_role_by_idUpdates either the project role's name or its description. You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_2_role_by_idUpdates the project role's name and description. You must include both a name and a description in the request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
delete_rest_api_2_role_by_id_actorsDeletes the default actors api-rest-api-2-resolution-get from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request. Changing a project role's default actors does not affect project role members for projects already created. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
user (string)
groupId (string)
group (string)
get_rest_api_2_role_by_id_actorsReturns the default actors api-rest-api-2-resolution-get for the project role. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
post_rest_api_2_role_by_id_actorsAdds default actors api-rest-api-2-resolution-get to a role. You may add groups or users, but you cannot add groups and users in the same request. Changing a project role's default actors does not affect project role members for projects already created. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. group (array)
. groupId (array)
. user (array)
} (object) required
get_rest_api_2_screensReturns a paginated pagination list of all screens or those specified by one or more screen IDs. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
queryString (string)
scope (array)
orderBy (string)
post_rest_api_2_screensCreates a screen with a default field tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
post_rest_api_2_screens_add_to_default_by_field_idAdds a field to the default tab of the default screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
get_rest_api_2_screens_tabsReturns the list of tabs for a bulk of screens. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (array)
tabId (array)
startAt (integer)
maxResult (integer)
delete_rest_api_2_screens_by_screen_idDeletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only screens used in classic projects can be deleted.screenId (integer)
put_rest_api_2_screens_by_screen_idUpdates a screen. Only screens used in classic projects can be updated. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_2_screens_by_screen_id_available_fieldsReturns the fields that can be added to a tab on a screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
get_rest_api_2_screens_by_screen_id_tabsReturns the list of tabs for a screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.screenId (integer)
projectKey (string)
post_rest_api_2_screens_by_screen_id_tabsCreates a tab for a screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
data: {
. id (integer)
. name (string)
} (object) required
delete_rest_api_2_screens_by_screen_id_tabs_by_tab_idDeletes a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
put_rest_api_2_screens_by_screen_id_tabs_by_tab_idUpdates the name of a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
data: {
. id (integer)
. name (string)
} (object) required
get_rest_api_2_screens_by_screen_id_tabs_by_tab_id_fieldsReturns all fields for a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.screenId (integer)
tabId (integer)
projectKey (string)
post_rest_api_2_screens_by_screen_id_tabs_by_tab_id_fieldsAdds a field to a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
data: {
. fieldId (string)
} (object) required
delete_rest_api_2_screens_by_screen_id_tabs_by_tab_id_fields_by_idRemoves a field from a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
id (string)
post_rest_api_2_screens_by_screen_id_tabs_by_tab_id_fields_by_id_moveMoves a screen tab field. If after and position are provided in the request, position is ignored. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
id (string)
data: {
. after (string)
. position (string)
} (object) required
post_rest_api_2_screens_by_screen_id_tabs_by_tab_id_move_by_posMoves a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
pos (integer)
get_rest_api_2_screenschemeReturns a paginated pagination list of screen schemes. Only screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
expand (string)
queryString (string)
orderBy (string)
post_rest_api_2_screenschemeCreates a screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
. screens
} (object) required
delete_rest_api_2_screenscheme_by_screen_scheme_idDeletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenSchemeId (string)
put_rest_api_2_screenscheme_by_screen_scheme_idUpdates a screen scheme. Only screen schemes used in classic projects can be updated. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenSchemeId (string)
data: {
. description (string)
. name (string)
. screens
} (object) required
get_rest_api_2_searchEndpoint is currently being removed. More detailshttps://developer.atlassian.com/changelog/ CHANGE-2046 Searches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. If the JQL query expression is too large to be encoded as a query parameter, use the POST api-rest-api-2-search-post version of this resource. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browse projects project permissionhttpsjql (string)
startAt (integer)
maxResults (integer)
validateQuery (string)
fields (array)
expand (string)
properties (array)
fieldsByKeys (boolean)
failFast (boolean)
post_rest_api_2_searchEndpoint is currently being removed. More detailshttps://developer.atlassian.com/changelog/ CHANGE-2046 Searches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. There is a GET api-rest-api-2-search-get version of this resource that can be used for smaller JQL query expressions. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browse projects project permissionhttps://confluence.atlassian.cdata: {
. expand (array)
. fields (array)
. fieldsByKeys (boolean)
. jql (string)
. maxResults (integer)
. properties (array)
. startAt (integer)
. validateQuery (string)
} (object) required
post_rest_api_2_search_approximate_countProvide an estimated count of the issues that match the JQLhttps://confluence.atlassian.com/x/egORLQ. Recent updates might not be immediately visible in the returned output. This endpoint requires JQL to be bounded. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttpdata: {
. jql (string)
} (object) required
get_rest_api_2_search_jqlSearches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. Recent updates might not be immediately visible in the returned search results. If you need read-after-writehttps://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/ consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously. If the JQL query expression is too large to be encoded as a query parameter, use the POST api-rest-jql (string)
nextPageToken (string)
maxResults (integer)
fields (array)
expand (string)
properties (array)
fieldsByKeys (boolean)
failFast (boolean)
reconcileIssues (array)
post_rest_api_2_search_jqlSearches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. Recent updates might not be immediately visible in the returned search results. If you need read-after-writehttps://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/ consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browsdata: {
. expand (string)
. fields (array)
. fieldsByKeys (boolean)
. jql (string)
. maxResults (integer)
. nextPageToken (string)
. properties (array)
. reconcileIssues (array)
} (object) required
get_rest_api_2_securitylevel_by_idReturns details of an issue security level. Use Get issue security scheme api-rest-api-2-issuesecurityschemes-id-get to obtain the IDs of issue security levels associated with the issue security scheme. This operation can be accessed anonymously. Permissions permissions required: None.id (string)
get_rest_api_2_server_infoReturns information about the Jira instance. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
get_rest_api_2_settings_columnsReturns the default issue navigator columns. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_2_settings_columnsSets the default issue navigator columns. The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns If no column details are sent, then all default columns are removed. A navigable field is one that can be used as a column on the issue navigator. Find details ofNo parameters
get_rest_api_2_statusReturns a list of all statuses associated with active workflows. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/ for the project.No parameters
get_rest_api_2_status_by_id_or_nameReturns a status. The status must be associated with an active workflow to be returned. If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/ for the project.idOrName (string)
get_rest_api_2_statuscategoryReturns a list of all status categories. Permissions permissions required: Permission to access Jira.No parameters
get_rest_api_2_statuscategory_by_id_or_keyReturns a status category. Status categories provided a mechanism for categorizing statuses api-rest-api-2-status-idOrName-get. Permissions permissions required: Permission to access Jira.idOrKey (string)
delete_rest_api_2_statusesDeletes statuses by ID. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgid (array) required
get_rest_api_2_statusesReturns a list of the statuses specified by one or more status IDs. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgid (array) required
post_rest_api_2_statusesCreates statuses for a global or project scope. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgdata: {
. scope
. statuses (array)
} (object) required
put_rest_api_2_statusesUpdates statuses by ID. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgdata: {
. statuses (array)
} (object) required
get_rest_api_2_statuses_by_namesReturns a list of the statuses specified by one or more status names. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLg Browse projects project permission.https://confluence.atlassian.com/x/yodKLgname (array) required
projectId (string)
get_rest_api_2_statuses_searchReturns a paginatedhttps://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/ pagination list of statuses that match a search on name or project. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgprojectId (string)
startAt (integer)
maxResults (integer)
searchString (string)
statusCategory (string)
get_rest_api_2_statuses_by_status_id_project_by_project_id_issue_type_usagesReturns a page of issue types in a project using a given status.statusId (string)
projectId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_2_statuses_by_status_id_project_usagesReturns a page of projects using a given status.statusId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_2_statuses_by_status_id_workflow_usagesReturns a page of workflows using a given status.statusId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_2_task_by_task_idReturns the status of a long-running asynchronous task async. When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice. Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024. read:jira-work Permissions permissions rtaskId (string)
post_rest_api_2_task_by_task_id_cancelCancels a task. Permissions permissions required: either of: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Creator of the task.taskId (string)
get_rest_api_2_ui_modificationsGets UI modifications. UI modifications can only be retrieved by Forge apps. Permissions permissions required: None. The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.startAt (integer)
maxResults (integer)
expand (string)
post_rest_api_2_ui_modificationsCreates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. Permissions permissions required: None if the UI modification is created without contexts. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for one or more projects, if the UI modification is created with contexts. Thdata: {
. contexts (array)
. data (string)
. description (string)
. name (string)
} (object) required
delete_rest_api_2_ui_modifications_by_ui_modification_idDeletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps. Permissions permissions required: None. The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.uiModificationId (string)
put_rest_api_2_ui_modifications_by_ui_modification_idUpdates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. Permissions permissions required: None if the UI modification is created without contexts. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for one or more projects, if the UI modification is created with contexts. The new write:app-data:jira OAuth scope is 100% optuiModificationId (string)
data: {
. contexts (array)
. data (string)
. description (string)
. name (string)
} (object) required
get_rest_api_2_universal_avatar_type_by_type_owner_by_entity_idReturns the system and custom avatars for a project, issue type or priority. This operation can be accessed anonymously. Permissions permissions required: for custom project avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the avatar belongs to. for custom issue type avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one project the issue type is used in. for system avatars, none. fotype (string)
entityId (string)
post_rest_api_2_universal_avatar_type_by_type_owner_by_entity_idLoads a custom avatar for a project, issue type or priority. Specify the avatar's local file location in the body of the request. Also, include the following headers: X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers special-request-headers. Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:api_token --header 'X-Atlassian-Token: no-chetype (string)
entityId (string)
x (integer)
y (integer)
size (integer) required
delete_rest_api_2_universal_avatar_type_by_type_owner_by_owning_object_id_avatar_by_idDeletes an avatar from a project, issue type or priority. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.type (string)
owningObjectId (string)
id (integer)
get_rest_api_2_universal_avatar_view_type_by_typeReturns the default project, issue type or priority avatar image. This operation can be accessed anonymously. Permissions permissions required: None.type (string)
size (string)
format (string)
get_rest_api_2_universal_avatar_view_type_by_type_avatar_by_idReturns a project, issue type or priority avatar image by ID. This operation can be accessed anonymously. Permissions permissions required: For system avatars, none. For custom project avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the avatar belongs to. For custom issue type avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one project the issue type is used in. For priority avattype (string)
id (integer)
size (string)
format (string)
get_rest_api_2_universal_avatar_view_type_by_type_owner_by_entity_idReturns the avatar image for a project, issue type or priority. This operation can be accessed anonymously. Permissions permissions required: For system avatars, none. For custom project avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the avatar belongs to. For custom issue type avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one project the issue type is used in. For priority avtype (string)
entityId (string)
size (string)
format (string)
delete_rest_api_2_userDeletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account. Permissions permissions required: Site administration that is, membership of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.accountId (string) required
username (string)
key (string)
get_rest_api_2_userReturns a user. Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overviewhttps://developer.atlassian.com/cloud/jira/platform/profile-visibility/ for more details. Permissions permissions required: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg.accountId (string)
username (string)
key (string)
expand (string)
post_rest_api_2_userCreates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. applicationKeys (array)
. displayName (string)
. emailAddress (string)
. key (string)
. name (string)
. password (string)
. products (array)
. self (string)
} (object) required
get_rest_api_2_user_assignable_multi_project_searchReturns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, use Getquery (string)
username (string)
accountId (string)
projectKeys (string) required
startAt (integer)
maxResults (integer)
get_rest_api_2_user_assignable_searchReturns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to: a new issue, by providing the projectKeyOrId. an updated issue, by providing the issueKey or issueId. to an issue during a transition workflow action, by providing the issueKey or issueId and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of Get issue api-restquery (string)
sessionId (string)
username (string)
accountId (string)
project (string)
issueKey (string)
issueId (string)
startAt (integer)
maxResults (integer)
actionDescriptorId (integer)
recommend (boolean)
get_rest_api_2_user_bulkReturns a paginated pagination list of the users specified by one or more account IDs. Permissions permissions required: Permission to access Jira.startAt (integer)
maxResults (integer)
username (array)
key (array)
accountId (array) required
get_rest_api_2_user_bulk_migrationReturns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified. Permissions permissions required: Permission to access Jira.startAt (integer)
maxResults (integer)
username (array)
key (array)
delete_rest_api_2_user_columnsResets the default issue table columnshttps://confluence.atlassian.com/x/XYdKLg for the user to the system default. If accountId is not passed, the calling user's default columns are reset. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to set the columns on any user. Permission to access Jira, to set the calling user's columns.accountId (string)
username (string)
get_rest_api_2_user_columnsReturns the default issue table columnshttps://confluence.atlassian.com/x/XYdKLg for the user. If accountId is not passed in the request, the calling user's details are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLgl, to get the column details for any user. Permission to access Jira, to get the calling user's column details.accountId (string)
username (string)
put_rest_api_2_user_columnsSets the default issue table columnshttps://confluence.atlassian.com/x/XYdKLg for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5' Permissions permissionsaccountId (string)
get_rest_api_2_user_emailReturns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelineshttps://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603. For Forge apps, this API only supports access via asApp requests.accountId (string) required
get_rest_api_2_user_email_bulkReturns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelineshttps://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603. For Forge apps, this API only supports access via asApp requests.accountId (array) required
get_rest_api_2_user_groupsReturns the groups to which a user belongs. Permissions permissions required: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg.accountId (string) required
username (string)
key (string)
get_rest_api_2_user_permission_searchReturns a list of users who fulfill these criteria: their user attributes match a search string. they have a set of permissions for a project or issue. If no search string is provided, a list of all users with the permissions is returned. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operatioquery (string)
username (string)
accountId (string)
permissions (string) required
issueKey (string)
projectKey (string)
startAt (integer)
maxResults (integer)
get_rest_api_2_user_pickerReturns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results. This operation takes the users in the range defined by maxResults, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in maxResultquery (string) required
maxResults (integer)
showAvatar (boolean)
exclude (array)
excludeAccountIds (array)
avatarSize (string)
excludeConnectUsers (boolean)
get_rest_api_2_user_propertiesReturns the keys of all properties for a user. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to access the property keys on any user. Access to Jira, to access the calling user's property keys.accountId (string)
userKey (string)
username (string)
delete_rest_api_2_user_properties_by_property_keyDeletes a property from a user. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to delete a property from any user. Access to Jira, to delete a property from the calling user's record.propertyKey (string)
accountId (string)
userKey (string)
username (string)
get_rest_api_2_user_properties_by_property_keyReturns the value of a user's property. If no property key is provided Get user property keys api-rest-api-2-user-properties-get is called. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to get a property from any user. Access to Jira, to get a property from the calling user's record.propertyKey (string)
accountId (string)
userKey (string)
username (string)
put_rest_api_2_user_properties_by_property_keySets the value of a user's property. Use this resource to store custom data against a user. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to set a property on any user. Access to Jira, to set a property on the calling user's record.propertyKey (string)
accountId (string)
userKey (string)
username (string)
data (undefined) required
get_rest_api_2_user_searchReturns a list of active users that match the search string and property. This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users api-rest-api-2-users-search-get and filter the records in your code. This operation can be accessed anonymously. Privacy controls are applied to the respoquery (string)
username (string)
accountId (string)
startAt (integer)
maxResults (integer)
property (string)
get_rest_api_2_user_search_queryFinds users with a structured query and returns a paginated pagination list of user details. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users api-rest-api-2-users-search-get and filter the records in your coquery (string) required
startAt (integer)
maxResults (integer)
get_rest_api_2_user_search_query_keyFinds users with a structured query and returns a paginated pagination list of user keys. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users api-rest-api-2-users-search-get and filter the records in your code.query (string) required
startAt (integer)
maxResult (integer)
get_rest_api_2_user_viewissue_searchReturns a list of users who fulfill these criteria: their user attributes match a search string. they have permission to browse issues. Use this resource to find users who can browse: an issue, by providing the issueKey. any issue in a project, by providing the projectKey. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browquery (string)
username (string)
accountId (string)
issueKey (string)
projectKey (string)
startAt (integer)
maxResults (integer)
get_rest_api_2_usersReturns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account. Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overviewhttps://developer.atlassian.com/cloud/jira/platform/profile-visibility/ for more details. Permissions permissions required: Browse users and groups global permissionhttps://confluence.astartAt (integer)
maxResults (integer)
get_rest_api_2_users_searchReturns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account. Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overviewhttps://developer.atlassian.com/cloud/jira/platform/profile-visibility/ for more details. Permissions permissions required: Browse users and groups global permissionhttps://confluence.astartAt (integer)
maxResults (integer)
post_rest_api_2_versionCreates a project version. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the version is added to.data: {
. approvers (array)
. archived (boolean)
. description (string)
. driver (string)
. expand (string)
. id (string)
. issuesStatusForFixVersion
. moveUnfixedIssuesTo (string)
. name (string)
. operations (array)
. overdue (boolean)
. project (string)
. projectId (integer)
. releaseDate (string)
. released (boolean)
. self (string)
. startDate (string)
. userReleaseDate (string)
. userStartDate (string)
} (object) required
delete_rest_api_2_version_by_idDeletes a project version. Deprecated, use Delete and replace version api-rest-api-2-version-id-removeAndSwap-post that supports swapping version values in custom fields, in addition to the swapping for fixVersion and affectedVersion provided in this resource. Alternative versions can be provided to update issues that use the deleted version in fixVersion or affectedVersion. If alternatives are not provided, occurrences of fixVersion and affectedVersion that contain the deleted version are clid (string)
moveFixIssuesTo (string)
moveAffectedIssuesTo (string)
get_rest_api_2_version_by_idReturns a project version. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the version.id (string)
expand (string)
put_rest_api_2_version_by_idUpdates a project version. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that contains the version.id (string)
data: {
. approvers (array)
. archived (boolean)
. description (string)
. driver (string)
. expand (string)
. id (string)
. issuesStatusForFixVersion
. moveUnfixedIssuesTo (string)
. name (string)
. operations (array)
. overdue (boolean)
. project (string)
. projectId (integer)
. releaseDate (string)
. released (boolean)
. self (string)
. startDate (string)
. userReleaseDate (string)
. userStartDate (string)
} (object) required
put_rest_api_2_version_by_id_mergeto_by_move_issues_toMerges 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. Consider using Delete and replace version api-rest-api-2-version-id-removeAndSwap-post instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissiid (string)
moveIssuesTo (string)
post_rest_api_2_version_by_id_moveModifies the version's sequence within the project, which affects the display order of the versions in Jira. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permission for the project that contains the version.id (string)
data: {
. after (string)
. position (string)
} (object) required
get_rest_api_2_version_by_id_related_issue_countsReturns the following counts for a version: Number of issues where the fixVersion is set to the version. Number of issues where the affectedVersion is set to the version. Number of issues where a version custom field is set to the version. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permission for the project that contains the version.id (string)
get_rest_api_2_version_by_id_relatedworkReturns related work items for the given version id. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the version.id (string)
post_rest_api_2_version_by_id_relatedworkCreates 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. This operation can be accessed anonymously. Permissions permissions required: Resolve issues: and Edit issues Managing project permissionshttps://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html for the project that contains the version.id (string)
data: {
. category (string)
. issueId (integer)
. relatedWorkId (string)
. title (string)
. url (string)
} (object) required
put_rest_api_2_version_by_id_relatedworkUpdates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited. This operation can be accessed anonymously. Permissions permissions required: Resolve issues: and Edit issues Managing project permissionshttps://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html for the project that contains the version.id (string)
data: {
. category (string)
. issueId (integer)
. relatedWorkId (string)
. title (string)
. url (string)
} (object) required
post_rest_api_2_version_by_id_remove_and_swapDeletes a project version. Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonid (string)
data: {
. customFieldReplacementList (array)
. moveAffectedIssuesTo (integer)
. moveFixIssuesTo (integer)
} (object) required
get_rest_api_2_version_by_id_unresolved_issue_countReturns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permission for the project that contains the version.id (string)
delete_rest_api_2_version_by_version_id_relatedwork_by_related_work_idDeletes the given related work for the given version. This operation can be accessed anonymously. Permissions permissions required: Resolve issues: and Edit issues Managing project permissionshttps://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html for the project that contains the version.versionId (string)
relatedWorkId (string)
delete_rest_api_2_webhookRemoves webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.data: {
. webhookIds (array)
} (object) required
get_rest_api_2_webhookReturns a paginated pagination list of the webhooks registered by the calling app. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.startAt (integer)
maxResults (integer)
post_rest_api_2_webhookRegisters webhooks. NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.data: {
. url (string)
. webhooks (array)
} (object) required
get_rest_api_2_webhook_failedReturns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries. After 72 hours the failure may no longer be returned by this operation. The oldest failure is returned first. This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next. Permissions permissions required: Only Connect appshttps://developer.atlassian.com/cloudmaxResults (integer)
after (integer)
put_rest_api_2_webhook_refreshExtends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive. Unrecognized webhook IDs those that are not found or belong to other apps are ignored. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.data: {
. webhookIds (array)
} (object) required
get_rest_api_2_workflowThis will be removed on February 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2567; use Search workflows api-rest-api-2-workflows-search-get instead. Returns all workflows in Jira or a workflow. If the workflowName parameter is specified, the workflow is returned as an object not in an array. Otherwise, an array of workflow objects is returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.workflowName (string)
post_rest_api_2_workflowThis will be removed on February 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2568; use Bulk create workflows api-rest-api-2-workflows-create-post to create both team and company-managed scoped workflows. Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Condidata: {
. description (string)
. name (string)
. statuses (array)
. transitions (array)
} (object) required
get_rest_api_2_workflow_rule_configReturns a paginated pagination list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules: of one or more transition rule types, such as workflow post functionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/. matching one or more transition rule keys. Only workflows containing transition rules created by the calling Connecthttps://developer.atlassian.com/cloud/jira/platform/index/ costartAt (integer)
maxResults (integer)
types (array) required
keys (array)
workflowNames (array)
withTags (array)
draft (boolean)
expand (string)
put_rest_api_2_workflow_rule_configUpdates configuration of workflow transition rules. The following rule types are supported: post functionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/ conditionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/ validatorshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/ Only rules created by the calling Connecthttps://developer.atlassian.com/cloud/jira/platform/index/ connect-apps or Fordata: {
. workflows (array)
} (object) required
put_rest_api_2_workflow_rule_config_deleteDeletes workflow transition rules from one or more workflows. These rule types are supported: post functionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/ conditionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/ validatorshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/ Only rules created by the calling Connect app can be deleted. Permissions permissions required: Only Connect apps cadata: {
. workflows (array)
} (object) required
get_rest_api_2_workflow_searchThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2569; use Search workflows api-rest-api-2-workflows-search-get instead. Returns a paginated pagination list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned. This operation does not return next-gen workflows. Permissions permissions required: Administer Jira global permissionstartAt (integer)
maxResults (integer)
workflowName (array)
expand (string)
queryString (string)
orderBy (string)
isActive (boolean)
delete_rest_api_2_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; delete transition properties using Bulk update workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-update-post instead. Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition propertieshttps://confluence.atlassian.com/x/zIhKtransitionId (integer)
key (string) required
workflowName (string) required
workflowMode (string)
get_rest_api_2_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; fetch transition properties from Bulk get workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-post instead. Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition propertieshttps://confluence.atlassian.com/x/zIhKLg AdvancetransitionId (integer)
includeReservedKeys (boolean)
key (string)
workflowName (string) required
workflowMode (string)
post_rest_api_2_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; add transition properties using Bulk update workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-update-post instead. Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition propertieshttps://confluence.atlassian.com/x/zIhKLg AdvantransitionId (integer)
key (string) required
workflowName (string) required
workflowMode (string)
data: {
. id (string)
. key (string)
. value (string)
} (object) required
put_rest_api_2_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; update transition properties using Bulk update workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-update-post instead. Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to chatransitionId (integer)
key (string) required
workflowName (string) required
workflowMode (string)
data: {
. id (string)
. key (string)
. value (string)
} (object) required
delete_rest_api_2_workflow_by_entity_idDeletes a workflow. The workflow cannot be deleted if it is: an active workflow. a system workflow. associated with any workflow scheme. associated with any draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.entityId (string)
get_rest_api_2_workflow_by_workflow_id_project_by_project_id_issue_type_usagesReturns a page of issue types using a given workflow within a project.workflowId (string)
projectId (integer)
nextPageToken (string)
maxResults (integer)
get_rest_api_2_workflow_by_workflow_id_project_usagesReturns a page of projects using a given workflow.workflowId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_2_workflow_by_workflow_id_workflow_schemesReturns a page of workflow schemes using a given workflow.workflowId (string)
nextPageToken (string)
maxResults (integer)
post_rest_api_2_workflowsReturns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types. Permissions permissions required: Administer Jira global permission to access all, including project-scoped, workflows At least one of the Administer projects and View read-only workflow project permissions to access project-scoped workflowsuseApprovalConfiguration (boolean)
data: {
. projectAndIssueTypes (array)
. workflowIds (array)
. workflowNames (array)
} (object) required
get_rest_api_2_workflows_capabilitiesGet the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories conditions, validators, actions, triggers, screens as well as the source location Atlassian-provided, Connect, Forge. Permissions permissions required: AdminworkflowId (string)
projectId (string)
issueTypeId (string)
post_rest_api_2_workflows_createCreate workflows and related statuses. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. scope
. statuses (array)
. workflows (array)
} (object) required
post_rest_api_2_workflows_create_validationValidate the payload for bulk create workflows. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. payload
. validationOptions
} (object) required
get_rest_api_2_workflows_default_editorGet the user's default workflow editor. This can be either the new editor or the legacy editor.No parameters
post_rest_api_2_workflows_previewReturns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details. Permissions permissions required: At least one of the Administer projects and View read-only workflow project permissionsdata: {
. issueTypeIds (array)
. projectId (string)
. workflowIds (array)
. workflowNames (array)
} (object) required
get_rest_api_2_workflows_searchReturns a paginated pagination list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned. Permissions permissions required: Administer Jira global permission to access all, including project-scoped, workflows At least one of the Administer projects and View read-only workflow project permissions to access project-scoped workflowsstartAt (integer)
maxResults (integer)
expand (string)
queryString (string)
orderBy (string)
scope (string)
isActive (boolean)
post_rest_api_2_workflows_updateUpdate workflows and related statuses. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. statuses (array)
. workflows (array)
} (object) required
post_rest_api_2_workflows_update_validationValidate the payload for bulk update workflows. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. payload
. validationOptions
} (object) required
get_rest_api_2_workflowschemeReturns a paginated pagination list of all workflow schemes, not including draft workflow schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
post_rest_api_2_workflowschemeCreates a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultWorkflow (string)
. description (string)
. draft (boolean)
. id (integer)
. issueTypeMappings (object)
. issueTypes (object)
. lastModified (string)
. lastModifiedUser
. name (string)
. originalDefaultWorkflow (string)
. originalIssueTypeMappings (object)
. self (string)
. updateDraftIfNeeded (boolean)
} (object) required
get_rest_api_2_workflowscheme_projectReturns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned. If the project is associated with the Default Workflow Scheme no ID is returned. This is because the way the Default Workflow Scheme is stored means it has no ID. Permissions permissions required: Administer Jira global permissionhttpprojectId (array) required
put_rest_api_2_workflowscheme_projectAssigns a workflow scheme to a project. This operation is performed only when there are no issues in the project. Workflow schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. projectId (string)
. workflowSchemeId (string)
} (object) required
post_rest_api_2_workflowscheme_readReturns a list of workflow schemes by providing workflow scheme IDs or project IDs. Permissions permissions required: Administer Jira global permission to access all, including project-scoped, workflow schemes Administer projects project permissions to access project-scoped workflow schemesdata: {
. projectIds (array)
. workflowSchemeIds (array)
} (object) required
post_rest_api_2_workflowscheme_updateUpdates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an asynchronous task async migrates the issues as defined in the provided mappings. Permissions permissions required: Administer Jira project permission to update all, including global-scoped, workflow schemes. Administer projects project permission to update pdata: {
. defaultWorkflowId (string)
. description (string)
. id (string)
. name (string)
. statusMappingsByIssueTypeOverride (array)
. statusMappingsByWorkflows (array)
. version
. workflowsForIssueTypes (array)
} (object) required
post_rest_api_2_workflowscheme_update_mappingsGets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both. Permissions permissions required: Administer Jira permission to update all, including global-scoped, workflow schemes. Administer projects project permission to update project-scoped workflow schemes.data: {
. defaultWorkflowId (string)
. id (string)
. workflowsForIssueTypes (array)
} (object) required
delete_rest_api_2_workflowscheme_by_idDeletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active that is, being used by at least one project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_2_workflowscheme_by_idReturns a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
returnDraftIfExists (boolean)
put_rest_api_2_workflowscheme_by_idUpdates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active that is, being used by at least one project, then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. defaultWorkflow (string)
. description (string)
. draft (boolean)
. id (integer)
. issueTypeMappings (object)
. issueTypes (object)
. lastModified (string)
. lastModifiedUser
. name (string)
. originalDefaultWorkflow (string)
. originalIssueTypeMappings (object)
. self (string)
. updateDraftIfNeeded (boolean)
} (object) required
post_rest_api_2_workflowscheme_by_id_createdraftCreate a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
delete_rest_api_2_workflowscheme_by_id_defaultResets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow the jira workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
updateDraftIfNeeded (boolean)
get_rest_api_2_workflowscheme_by_id_defaultReturns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
returnDraftIfExists (boolean)
put_rest_api_2_workflowscheme_by_id_defaultSets the default workflow for a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_2_workflowscheme_by_id_draftDeletes a draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_2_workflowscheme_by_id_draftReturns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemeshttps://confluence.atlassian.com/x/tohKLg for more information. Note that: Only active workflow schemes can have draft workflow schemes. An activeid (integer)
put_rest_api_2_workflowscheme_by_id_draftUpdates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. defaultWorkflow (string)
. description (string)
. draft (boolean)
. id (integer)
. issueTypeMappings (object)
. issueTypes (object)
. lastModified (string)
. lastModifiedUser
. name (string)
. originalDefaultWorkflow (string)
. originalIssueTypeMappings (object)
. self (string)
. updateDraftIfNeeded (boolean)
} (object) required
delete_rest_api_2_workflowscheme_by_id_draft_defaultResets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow the jira workflow. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_2_workflowscheme_by_id_draft_defaultReturns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
put_rest_api_2_workflowscheme_by_id_draft_defaultSets the default workflow for a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_2_workflowscheme_by_id_draft_issuetype_by_issue_typeDeletes the issue type-workflow mapping for an issue type in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
get_rest_api_2_workflowscheme_by_id_draft_issuetype_by_issue_typeReturns the issue type-workflow mapping for an issue type in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
put_rest_api_2_workflowscheme_by_id_draft_issuetype_by_issue_typeSets the workflow for an issue type in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
data: {
. issueType (string)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
post_rest_api_2_workflowscheme_by_id_draft_publishPublishes a draft workflow scheme. Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-2-task-taskId-get to obtain updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4id (integer)
validateOnly (boolean)
data: {
. statusMappings (array)
} (object) required
delete_rest_api_2_workflowscheme_by_id_draft_workflowDeletes the workflow-issue type mapping for a workflow in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string) required
get_rest_api_2_workflowscheme_by_id_draft_workflowReturns the workflow-issue type mappings for a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string)
put_rest_api_2_workflowscheme_by_id_draft_workflowSets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string) required
data: {
. defaultMapping (boolean)
. issueTypes (array)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_2_workflowscheme_by_id_issuetype_by_issue_typeDeletes the issue type-workflow mapping for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
updateDraftIfNeeded (boolean)
get_rest_api_2_workflowscheme_by_id_issuetype_by_issue_typeReturns the issue type-workflow mapping for an issue type in a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
returnDraftIfExists (boolean)
put_rest_api_2_workflowscheme_by_id_issuetype_by_issue_typeSets the workflow for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
data: {
. issueType (string)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_2_workflowscheme_by_id_workflowDeletes the workflow-issue type mapping for a workflow in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string) required
updateDraftIfNeeded (boolean)
get_rest_api_2_workflowscheme_by_id_workflowReturns the workflow-issue type mappings for a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string)
returnDraftIfExists (boolean)
put_rest_api_2_workflowscheme_by_id_workflowSets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira. Permissions permissiid (integer)
workflowName (string) required
data: {
. defaultMapping (boolean)
. issueTypes (array)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
get_rest_api_2_workflowscheme_by_workflow_scheme_id_project_usagesReturns a page of projects using a given workflow scheme.workflowSchemeId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_2_worklog_deletedReturns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs. This resource does not return worklogs delsince (integer)
post_rest_api_2_worklog_listReturns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items. Permissions permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true: the worklog is set as Viewable by All Users. the user is a member of a project role or group with permission to view the worklog.expand (string)
data: {
. ids (array)
} (object) required
get_rest_api_2_worklog_updatedReturns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs. This resource does not return worklogs updsince (integer)
expand (string)
get_rest_atlassian_connect_1_addons_by_addon_key_propertiesGets all the properties of an app. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
delete_rest_atlassian_connect_1_addons_by_addon_key_properties_by_property_keyDeletes an app's property. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
propertyKey (string)
get_rest_atlassian_connect_1_addons_by_addon_key_properties_by_property_keyReturns the key and value of an app's property. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
propertyKey (string)
put_rest_atlassian_connect_1_addons_by_addon_key_properties_by_property_keySets the value of an app's property. Use this resource to store custom data for your app. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
propertyKey (string)
data (undefined) required
delete_rest_atlassian_connect_1_app_module_dynamicRemove all or a list of modules registered by the calling app. Permissions permissions required: Only Connect apps can make this request.moduleKey (array)
get_rest_atlassian_connect_1_app_module_dynamicReturns all modules registered dynamically by the calling app. Permissions permissions required: Only Connect apps can make this request.No parameters
post_rest_atlassian_connect_1_app_module_dynamicRegisters a list of modules. Permissions permissions required: Only Connect apps can make this request.data: {
. modules (array)
} (object) required
put_rest_atlassian_connect_1_migration_fieldUpdates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated. Permissions permissions required: Only Connect apps can make this requestAtlassian-Transfer-Id (string) required
data: {
. updateValueList (array)
} (object) required
put_rest_atlassian_connect_1_migration_properties_by_entity_typeUpdates 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.entityType (string)
Atlassian-Transfer-Id (string) required
data (array) required
post_rest_atlassian_connect_1_migration_workflow_rule_searchReturns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.Atlassian-Transfer-Id (string) required
data: {
. expand (string)
. ruleIds (array)
. workflowEntityId (string)
} (object) required
get_rest_atlassian_connect_1_service_registryRetrieve the attributes of given service registries. Permissions permissions required: Only Connect apps can make this request and the servicesIds belong to the tenant you are requestingserviceIds (array) required
get_rest_forge_1_app_propertiesReturns all property keys for the Forge app. Permissions permissions required: Only Forge apps can make this request. This API can only be accessed using asApphttps://developer.atlassian.com/platform/forge/apis-reference/fetch-api-product.requestjira/ method-signature requests from Forge.No parameters
delete_rest_forge_1_app_properties_by_property_keyDeletes a Forge app's property. Permissions permissions required: Only Forge apps can make this request. This API can only be accessed using asApphttps://developer.atlassian.com/platform/forge/apis-reference/fetch-api-product.requestjira/ method-signature requests from Forge. The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.propertyKey (string)
get_rest_forge_1_app_properties_by_property_keyReturns the value of a Forge app's property. Permissions permissions required: Only Forge apps can make this request. This API can only be accessed using asApphttps://developer.atlassian.com/platform/forge/apis-reference/fetch-api-product.requestjira/ method-signature requests from Forge.propertyKey (string)
put_rest_forge_1_app_properties_by_property_keySets the value of a Forge app's property. These values can be retrieved in Jira expressions/cloud/jira/platform/jira-expressions/ through the app context variable/cloud/jira/platform/jira-expressions/ context-variables. They are also available in entity property display conditions/platform/forge/manifest-reference/display-conditions/entity-property-conditions/. For other use cases, use the Storage API/platform/forge/runtime-reference/storage-api/. The value of the request body must be a validhpropertyKey (string)
data (undefined) required
post_rest_internal_api_latest_worklog_bulkReturns worklog details for a list of issue ID and worklog ID pairs. This is an internal API for bulk fetching worklogs by their issue and worklog IDs. Worklogs that don't exist will be filtered out from the response. The returned list of worklogs is limited to 1000 items. Permissions permissions required: This is an internal service-to-service API that requires ASAP authentication. No user permission checks are performed as this bypasses normal user context.data: {
. requests (array)
} (object) required
get_rest_api_3_announcement_bannerReturns the current announcement banner configuration. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_3_announcement_bannerUpdates the announcement banner configuration. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. isDismissible (boolean)
. isEnabled (boolean)
. message (string)
. visibility (string)
} (object) required
post_rest_api_3_app_field_context_configuration_listReturns a paginated pagination list of configurations for list of custom fields of a typehttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ created by a Forge apphttps://developer.atlassian.com/platform/forge/. The result can be filtered by one of these criteria: id. fieldContextId. issueId. projectKeyOrId and issueTypeId. Otherwise, all configurations for the provided list of custom fields are returned. Permissions permissions requiid (array)
fieldContextId (array)
issueId (integer)
projectKeyOrId (string)
issueTypeId (string)
startAt (integer)
maxResults (integer)
data: {
. fieldIdsOrKeys (array)
} (object) required
post_rest_api_3_app_field_valueUpdates 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. Apps can only perform this operation on custom fieldshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/ and custom field typeshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ declared in their own manifests. Permissions permissions required: Only the app that ogenerateChangelog (boolean)
data: {
. updates (array)
} (object) required
get_rest_api_3_app_field_by_field_id_or_key_context_configurationReturns a paginated pagination list of configurations for a custom field of a typehttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ created by a Forge apphttps://developer.atlassian.com/platform/forge/. The result can be filtered by one of these criteria: id. fieldContextId. issueId. projectKeyOrId and issueTypeId. Otherwise, all configurations are returned. Permissions permissions required: Administer Jira global permissionhttps://fieldIdOrKey (string)
id (array)
fieldContextId (array)
issueId (integer)
projectKeyOrId (string)
issueTypeId (string)
startAt (integer)
maxResults (integer)
put_rest_api_3_app_field_by_field_id_or_key_context_configurationUpdate the configuration for contexts of a custom field of a typehttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ created by a Forge apphttps://developer.atlassian.com/platform/forge/. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Jira permissions are not required for the Forge app that created the custom field type.fieldIdOrKey (string)
data: {
. configurations (array)
} (object) required
put_rest_api_3_app_field_by_field_id_or_key_valueUpdates the value of a custom field on one or more issues. Apps can only perform this operation on custom fieldshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/ and custom field typeshttps://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/ declared in their own manifests. Permissions permissions required: Only the app that owns the custom field or custom field type can update its values with this operation. TfieldIdOrKey (string)
generateChangelog (boolean)
data: {
. updates (array)
} (object) required
get_rest_api_3_application_propertiesReturns all application properties or an application property. If you specify a value for the key parameter, then an application property is returned as an object not in an array. Otherwise, an array of all editable application properties is returned. See Set application property api-rest-api-3-application-properties-id-put for descriptions of editable properties. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.key (string)
permissionLevel (string)
keyFilter (string)
get_rest_api_3_application_properties_advanced_settingsReturns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon Jira settings System, General Configuration and then click Advanced Settings in the upper right. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_3_application_properties_by_idChanges the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values. Advanced settings The advanced settings below are also accessible in Jirahttps://confluence.atlassian.com/x/vYXKM. | Key | Description | Default value | | -- | -- | -- | | jira.clone.prefix | The string of text pid (string)
data: {
. id (string)
. value (string)
} (object) required
get_rest_api_3_applicationroleReturns all application roles. In Jira, application roles are managed using the Application access configurationhttps://confluence.atlassian.com/x/3YxjL page. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
get_rest_api_3_applicationrole_by_keyReturns an application role. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.key (string)
get_rest_api_3_attachment_content_by_idReturns the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to download. See the HTTP Range header standardhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range for details. To return a thumbnail of the attachment, use Get attachment thumbnail api-rest-api-3-attachment-thumbnail-id-get. This operation can be accessed anonymously. Permissions permissions required: For the issue containing the attachment: Browse projects projecid (string)
redirect (boolean)
get_rest_api_3_attachment_metaReturns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. Note that there are also project permissionshttps://confluence.atlassian.com/x/yodKLg that restrict whether users can create and delete attachments. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
get_rest_api_3_attachment_thumbnail_by_idReturns the thumbnail of an attachment. To return the attachment contents, use Get attachment content api-rest-api-3-attachment-content-id-get. This operation can be accessed anonymously. Permissions permissions required: For the issue containing the attachment: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission tid (string)
redirect (boolean)
fallbackToDefault (boolean)
width (integer)
height (integer)
delete_rest_api_3_attachment_by_idDeletes an attachment from an issue. This operation can be accessed anonymously. Permissions permissions required: For the project holding the issue containing the attachment: Delete own attachments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete an attachment created by the calling user. Delete all attachments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete an attachment created by any user.id (string)
get_rest_api_3_attachment_by_idReturns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If attachments are added in private comments, the comment-level restrictionid (string)
get_rest_api_3_attachment_by_id_expand_humanReturns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported. Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, useid (string)
get_rest_api_3_attachment_by_id_expand_rawReturns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported. Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use Get all metadata for an expanded attaid (string)
get_rest_api_3_auditing_recordReturns a list of audit records. The list can be filtered to include items: where each item in filter has at least one match in any of these fields: summary category eventSource objectItem.name If the object is a user, account ID is available to filter. objectItem.parentName objectItem.typeName changedValues.changedFrom changedValues.changedTo remoteAddress For example, if filter contains man ed, an audit record conoffset (integer)
limit (integer)
filter (string)
from (string)
to (string)
get_rest_api_3_avatar_by_type_systemReturns a list of system avatar details by owner type, where the owner types are issue type, project, user or priority. This operation can be accessed anonymously. Permissions permissions required: None.type (string)
post_rest_api_3_bulk_issues_deleteUse this API to submit a bulk delete request. You can delete up to 1,000 issues in a single operation. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. Delete issues permissionhttps://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/ Delete-issues/ in all projects that contain the selected issues. Browse project permissionhttps://support.adata: {
. selectedIssueIdsOrKeys (array)
. sendBulkNotification (boolean)
} (object) required
get_rest_api_3_bulk_issues_fieldsUse 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. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. Browse project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/missueIdsOrKeys (string) required
searchText (string)
endingBefore (string)
startingAfter (string)
post_rest_api_3_bulk_issues_fieldsUse 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. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. Browse project permissionhttps://support.atlassian.com/jira-cloud-administration/dodata: {
. editedFieldsInput
. selectedActions (array)
. selectedIssueIdsOrKeys (array)
. sendBulkNotification (boolean)
} (object) required
post_rest_api_3_bulk_issues_moveUse 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. You can't move more than 1000 issues including subtasks at once. Scenarios: This is an early version of the API and it doesn't have full feature parity with the Bulk Move UI experience. Moving issue of type A to issue of type B in the same project or a different project: SUPPORTED Movidata: {
. sendBulkNotification (boolean)
. targetToSourcesMapping (object)
} (object) required
get_rest_api_3_bulk_issues_transitionUse 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. The response will provide the available transitions for issues, organized by their respective workflows. Only the transitions that are common among the issues within that workflow and do not involve any additional field updates will be included. For bulk transitions thatissueIdsOrKeys (string) required
endingBefore (string)
startingAfter (string)
post_rest_api_3_bulk_issues_transitionUse 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. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. Transition issues permissionhttps://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/ Transidata: {
. bulkTransitionInputs (array)
. sendBulkNotification (boolean)
} (object) required
post_rest_api_3_bulk_issues_unwatchUse this API to submit a bulk unwatch request. You can unwatch up to 1,000 issues in a single operation. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. Browse project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/ in all projects that contain the selected issues. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg isdata: {
. selectedIssueIdsOrKeys (array)
} (object) required
post_rest_api_3_bulk_issues_watchUse this API to submit a bulk watch request. You can watch up to 1,000 issues in a single operation. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. Browse project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/ in all projects that contain the selected issues. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is confdata: {
. selectedIssueIdsOrKeys (array)
} (object) required
get_rest_api_3_bulk_queue_by_task_idUse this to get the progress state for the specified bulk operation taskId. Permissions permissions required: Global bulk change permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/. If the task is running, this resource will return: 'taskId':'10779','status':'RUNNING','progressPercent':65,'submittedBy':'accountId':'5b10a2844c20165700ede21g','created':1690180055963,'started':1690180056206,'updated':169018005829 If the task has completed, ttaskId (string)
post_rest_api_3_changelog_bulkfetchBulk fetch changelogs for multiple issues and filter by fields Returns a paginated list of all changelogs for given issues sorted by changelog date and issue IDs, starting from the oldest changelog and smallest issue ID. Issues are identified by their ID or key, and optionally changelogs can be filtered by their field IDs. You can request the changelogs of up to 1000 issues and can filter them by up to 10 field IDs. Permissions permissions required: Browse projects project permissionhttpsdata: {
. fieldIds (array)
. issueIdsOrKeys (array)
. maxResults (integer)
. nextPageToken (string)
} (object) required
get_rest_api_3_classification_levelsReturns all classification levels. Permissions permissions required: None.status (array)
orderBy (string)
post_rest_api_3_comment_listReturns a paginated pagination list of comments specified by a list of comment IDs. This operation can be accessed anonymously. Permissions permissions required: Comments are returned where the user: has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the comment. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restricexpand (string)
data: {
. ids (array)
} (object) required
get_rest_api_3_comment_by_comment_id_propertiesReturns the keys of all the properties of a comment. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.commentId (string)
delete_rest_api_3_comment_by_comment_id_properties_by_property_keyDeletes a comment property. Permissions permissions required: either of: Edit All Comments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete a property from any comment. Edit Own Comments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete a property from a comment created by the user.commentId (string)
propertyKey (string)
get_rest_api_3_comment_by_comment_id_properties_by_property_keyReturns the value of a comment property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.commentId (string)
propertyKey (string)
put_rest_api_3_comment_by_comment_id_properties_by_property_keyCreates or updates the value of a property for a comment. Use this resource to store custom data against a comment. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. Permissions permissions required: either of: Edit All Comments project permissionhttps://confluence.atlassian.com/x/yodKLg to create or update the value of a property on any comment. Edit Own Comments project permissionhttps://conflucommentId (string)
propertyKey (string)
data (undefined) required
get_rest_api_3_componentReturns a paginated pagination list of all components in a project, including global Compass components when applicable. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdsOrKeys (array)
startAt (integer)
maxResults (integer)
orderBy (string)
query (string)
post_rest_api_3_componentCreates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project. This operation can be accessed anonymously. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project in which the component is created or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. ari (string)
. assignee
. assigneeType (string)
. description (string)
. id (string)
. isAssigneeTypeValid (boolean)
. lead
. leadAccountId (string)
. leadUserName (string)
. metadata (object)
. name (string)
. project (string)
. projectId (integer)
. realAssignee
. realAssigneeType (string)
. self (string)
} (object) required
delete_rest_api_3_component_by_idDeletes a component. This operation can be accessed anonymously. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the component or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
moveIssuesTo (string)
get_rest_api_3_component_by_idReturns a component. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for project containing the component.id (string)
put_rest_api_3_component_by_idUpdates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string '' the component lead is removed. This operation can be accessed anonymously. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the component or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. ari (string)
. assignee
. assigneeType (string)
. description (string)
. id (string)
. isAssigneeTypeValid (boolean)
. lead
. leadAccountId (string)
. leadUserName (string)
. metadata (object)
. name (string)
. project (string)
. projectId (integer)
. realAssignee
. realAssigneeType (string)
. self (string)
} (object) required
get_rest_api_3_component_by_id_related_issue_countsReturns the counts of issues assigned to the component. This operation can be accessed anonymously. Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024. Classic: read:jira-work Granular: read:field:jira, read:project.component:jira Permissions permissions required: None.id (string)
get_rest_api_3_configurationReturns the global settingshttps://confluence.atlassian.com/x/qYXKM in Jira. These settings determine whether optional features for example, subtasks, time tracking, and others are enabled. If time tracking is enabled, this operation also returns the time tracking configuration. Permissions permissions required: Permission to access Jira.No parameters
get_rest_api_3_configuration_timetrackingReturns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_3_configuration_timetrackingSelects a time tracking provider. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. key (string)
. name (string)
. url (string)
} (object) required
get_rest_api_3_configuration_timetracking_listReturns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Providerhttps://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/ module. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlNo parameters
get_rest_api_3_configuration_timetracking_optionsReturns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_3_configuration_timetracking_optionsSets the time tracking settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultUnit (string)
. timeFormat (string)
. workingDaysPerWeek (number)
. workingHoursPerDay (number)
} (object) required
get_rest_api_3_custom_field_option_by_idReturns a custom field option. For example, an option in a select list. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource, it cannot be used with issue field select list options created by Connect apps. This operation can be accessed anonymously. Permissions permissions required: The custom field option is returned as follows: if the user has the Admiid (string)
get_rest_api_3_dashboardReturns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. This operation can be accessed anonymously. Permissions permissions required: None.filter (string)
startAt (integer)
maxResults (integer)
post_rest_api_3_dashboardCreates a dashboard. Permissions permissions required: None.extendAdminPermissions (boolean)
data: {
. description (string)
. editPermissions (array)
. name (string)
. sharePermissions (array)
} (object) required
put_rest_api_3_dashboard_bulk_editBulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100. Permissions permissions required: None The dashboards to be updated must be owned by the user, or the user must be an administrator.data: {
. action (string)
. changeOwnerDetails
. entityIds (array)
. extendAdminPermissions (boolean)
. permissionDetails
} (object) required
get_rest_api_3_dashboard_gadgetsGets a list of all available gadgets that can be added to all dashboards. Permissions permissions required: None.No parameters
get_rest_api_3_dashboard_searchReturns a paginated pagination list of dashboards. This operation is similar to Get dashboards api-rest-api-3-dashboard-get except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously. Permissions permissions required: The following dashboards that match the query parameters are returdashboardName (string)
accountId (string)
owner (string)
groupname (string)
groupId (string)
projectId (integer)
orderBy (string)
startAt (integer)
maxResults (integer)
status (string)
expand (string)
get_rest_api_3_dashboard_by_dashboard_id_gadgetReturns a list of dashboard gadgets on a dashboard. This operation returns: Gadgets from a list of IDs, when id is set. Gadgets with a module key, when moduleKey is set. Gadgets from a list of URIs, when uri is set. All gadgets, when no other parameters are set. This operation can be accessed anonymously. Permissions permissions required: None.dashboardId (integer)
moduleKey (array)
uri (array)
gadgetId (array)
post_rest_api_3_dashboard_by_dashboard_id_gadgetAdds a gadget to a dashboard. Permissions permissions required: None.dashboardId (integer)
data: {
. color (string)
. ignoreUriAndModuleKeyValidation (boolean)
. moduleKey (string)
. position
. title (string)
. uri (string)
} (object) required
delete_rest_api_3_dashboard_by_dashboard_id_gadget_by_gadget_idRemoves a dashboard gadget from a dashboard. When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position. Permissions permissions required: None.dashboardId (integer)
gadgetId (integer)
put_rest_api_3_dashboard_by_dashboard_id_gadget_by_gadget_idChanges the title, position, and color of the gadget on a dashboard. Permissions permissions required: None.dashboardId (integer)
gadgetId (integer)
data: {
. color (string)
. position
. title (string)
} (object) required
get_rest_api_3_dashboard_by_dashboard_id_items_by_item_id_propertiesReturns the keys of all properties for a dashboard item. This operation can be accessed anonymously. Permissions permissions required: The user must have read permission of the dashboard or have the dashboard shared with them.dashboardId (string)
itemId (string)
delete_rest_api_3_dashboard_by_dashboard_id_items_by_item_id_properties_by_property_keyDeletes a dashboard item property. This operation can be accessed anonymously. Permissions permissions required: The user must have edit permission of the dashboard.dashboardId (string)
itemId (string)
propertyKey (string)
get_rest_api_3_dashboard_by_dashboard_id_items_by_item_id_properties_by_property_keyReturns the key and value of a dashboard item property. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgetshttps://confluence.atlassian.com/x/7AeiLQ. When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or,dashboardId (string)
itemId (string)
propertyKey (string)
put_rest_api_3_dashboard_by_dashboard_id_items_by_item_id_properties_by_property_keySets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgetshttps://confluence.atlassian.com/x/7AeiLQ. When an app creates a dashboard item it registers a callback to receive the dashboarddashboardId (string)
itemId (string)
propertyKey (string)
data (undefined) required
delete_rest_api_3_dashboard_by_idDeletes a dashboard. Permissions permissions required: None The dashboard to be deleted must be owned by the user.id (string)
get_rest_api_3_dashboard_by_idReturns a dashboard. This operation can be accessed anonymously. Permissions permissions required: None. However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.id (string)
put_rest_api_3_dashboard_by_idUpdates a dashboard, replacing all the dashboard details with those provided. Permissions permissions required: None The dashboard to be updated must be owned by the user.id (string)
extendAdminPermissions (boolean)
data: {
. description (string)
. editPermissions (array)
. name (string)
. sharePermissions (array)
} (object) required
post_rest_api_3_dashboard_by_id_copyCopies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard. Permissions permissions required: None The dashboard to be copied must be owned by or shared with the user.id (string)
extendAdminPermissions (boolean)
data: {
. description (string)
. editPermissions (array)
. name (string)
. sharePermissions (array)
} (object) required
get_rest_api_3_data_policyReturns data policy for the workspace.No parameters
get_rest_api_3_data_policy_projectReturns data policies for the projects specified in the request.ids (string)
get_rest_api_3_eventsReturns all issue events. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
post_rest_api_3_expression_analyseAnalyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check the expressions. Learn more about Jira expressions in the documentationhttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/. Permissions permissions required: None.check (string)
data: {
. contextVariables (object)
. expressions (array)
} (object) required
post_rest_api_3_expression_evalEndpoint is currently being removed. More detailshttps://developer.atlassian.com/changelog/ CHANGE-2046 Evaluates a Jira expression and returns its value. This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentationhttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/ for more details. Context variables The following context variables are available to Jira expressionexpand (string)
data: {
. context
. expression (string)
} (object) required
post_rest_api_3_expression_evaluateEvaluates 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. This API is eventually consistent, unlike the strongly consistent eval API. This allows for better performance and scalability. In addition, this API's response for JQL evaluation is based on a scrolling view backed by a nextPageToken instead of a paginated view backed by startAt and totalCount. This resource can be used to testexpand (string)
data: {
. context
. expression (string)
} (object) required
get_rest_api_3_fieldReturns system and custom issue fields according to the following rules: Fields that cannot be added to the issue navigator are always returned. Fields that cannot be placed on an issue screen are always returned. Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches. For all other fields, this operation only returns the fields that the user has permission to view that is, the field is usedNo parameters
post_rest_api_3_fieldCreates a custom field. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
. searcherKey (string)
. type (string)
} (object) required
delete_rest_api_3_field_associationUnassociates a set of fields with a project and issue type context. Fields will be unassociated with all projects/issue types that share the same field configuration which the provided project and issue types are using. This means that while the field will be unassociated with the provided project and issue types, it will also be unassociated with any other projects and issue types that share the same field configuration. If a success response is returned it means that the field association hadata: {
. associationContexts (array)
. fields (array)
} (object) required
put_rest_api_3_field_associationAssociates fields with projects. Fields will be associated with each issue type on the requested projects. Fields will be associated with all projects that share the same field configuration which the provided projects are using. This means that while the field will be associated with the requested projects, it will also be associated with any other projects that share the same field configuration. If a success response is returned it means that the field association has been created in any adata: {
. associationContexts (array)
. fields (array)
} (object) required
get_rest_api_3_field_searchReturns a paginated pagination list of fields for Classic Jira projects. The list can include: all fields specific fields, by defining id fields that contain a string in the field name or description, by defining query specific fields that contain a string in the field name or description, by defining id and query Use type must be set to custom to show custom fields only. Permissions permissions required: Permission to access Jira.startAt (integer)
maxResults (integer)
type (array)
id (array)
query (string)
orderBy (string)
expand (string)
projectIds (array)
get_rest_api_3_field_search_trashedReturns a paginated pagination list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string. Only custom fields can be queried, type must be set to custom. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
query (string)
expand (string)
orderBy (string)
put_rest_api_3_field_by_field_idUpdates a custom field. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
data: {
. description (string)
. name (string)
. searcherKey (string)
} (object) required
get_rest_api_3_field_by_field_id_contextReturns a paginated pagination list of contextshttps://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html for a custom field. Contexts can be returned as follows: With no other parameters set, all contexts. By defining id only, all contexts from the list of IDs. By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types true or those that apply to only a subset of issue types false By defining isGfieldId (string)
isAnyIssueType (boolean)
isGlobalContext (boolean)
contextId (array)
startAt (integer)
maxResults (integer)
post_rest_api_3_field_by_field_id_contextCreates a custom field context. If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
data: {
. description (string)
. id (string)
. issueTypeIds (array)
. name (string)
. projectIds (array)
} (object) required
get_rest_api_3_field_by_field_id_context_default_valueReturns a paginated pagination list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned. The returned object depends on type of the custom field: CustomFieldContextDefaultValueDate type datepicker for date fields. CustomFieldContextDefaultValueDateTime type datetimepicker for date-time fields. CustomFieldContextDefaultValueSingleOption type option.single for single choicfieldId (string)
contextId (array)
startAt (integer)
maxResults (integer)
put_rest_api_3_field_by_field_id_context_default_valueSets default for contexts of a custom field. Default are defined using these objects: CustomFieldContextDefaultValueDate type datepicker for date fields. CustomFieldContextDefaultValueDateTime type datetimepicker for date-time fields. CustomFieldContextDefaultValueSingleOption type option.single for single choice select lists and radio buttons. CustomFieldContextDefaultValueMultipleOption type option.multiple for multiple choice select lists and checkboxes. CustomFieldContextDefafieldId (string)
data: {
. defaultValues (array)
} (object) required
get_rest_api_3_field_by_field_id_context_issuetypemappingReturns a paginated pagination 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. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (array)
startAt (integer)
maxResults (integer)
post_rest_api_3_field_by_field_id_context_mappingReturns a paginated pagination list of project and issue type mappings and, for each mapping, the ID of a custom field contexthttps://confluence.atlassian.com/x/k44fOw that applies to the project and issue type. If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null.fieldId (string)
startAt (integer)
maxResults (integer)
data: {
. mappings (array)
} (object) required
get_rest_api_3_field_by_field_id_context_projectmappingReturns a paginated pagination 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. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (array)
startAt (integer)
maxResults (integer)
delete_rest_api_3_field_by_field_id_context_by_context_idDeletes a custom field contexthttps://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
put_rest_api_3_field_by_field_id_context_by_context_idUpdates a custom field contexthttps://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_field_by_field_id_context_by_context_id_issuetypeAdds issue types to a custom field context, appending the issue types to the issue types list. A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types. If any of the issue types exists in the custom field context, the operation fails and no issue types are added. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dfieldId (string)
contextId (integer)
data: {
. issueTypeIds (array)
} (object) required
post_rest_api_3_field_by_field_id_context_by_context_id_issuetype_removeRemoves issue types from a custom field context. A custom field context without any issue types applies to all issue types. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. issueTypeIds (array)
} (object) required
get_rest_api_3_field_by_field_id_context_by_context_id_optionReturns a paginated pagination list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options apps api-group-issue-custom-field-options--apps- operations. Permissions permissions required: Administer Jira global permissionhfieldId (string)
contextId (integer)
optionId (integer)
onlyOptions (boolean)
startAt (integer)
maxResults (integer)
post_rest_api_3_field_by_field_id_context_by_context_id_optionCreates 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. The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom fifieldId (string)
contextId (integer)
data: {
. options (array)
} (object) required
put_rest_api_3_field_by_field_id_context_by_context_id_optionUpdates the options of a custom field. If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource, it cannot be used with issue field select list options created by Connect apps. PermissiofieldId (string)
contextId (integer)
data: {
. options (array)
} (object) required
put_rest_api_3_field_by_field_id_context_by_context_id_option_moveChanges the order of custom field options or cascading options in a context. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options apps api-group-issue-custom-field-options--apps- operations. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. after (string)
. customFieldOptionIds (array)
. position (string)
} (object) required
delete_rest_api_3_field_by_field_id_context_by_context_id_option_by_option_idDeletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options apps api-group-issue-custom-field-options--apps- operations. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dfieldId (string)
contextId (integer)
optionId (integer)
delete_rest_api_3_field_by_field_id_context_by_context_id_option_by_option_id_issueReplaces the options of a custom field. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource, it cannot be used with issue field select list options created by Connect or Forge apps. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
optionId (integer)
contextId (integer)
replaceWith (integer)
jql (string)
put_rest_api_3_field_by_field_id_context_by_context_id_projectAssigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. projectIds (array)
} (object) required
post_rest_api_3_field_by_field_id_context_by_context_id_project_removeRemoves a custom field context from projects. A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects. If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
contextId (integer)
data: {
. projectIds (array)
} (object) required
get_rest_api_3_field_by_field_id_contextsReturns a paginated pagination list of the contexts a field is used in. Deprecated, use Get custom field contexts api-rest-api-3-field-fieldId-context-get. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
startAt (integer)
maxResults (integer)
get_rest_api_3_field_by_field_id_screensReturns a paginated pagination list of the screens a field is used in. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
startAt (integer)
maxResults (integer)
expand (string)
get_rest_api_3_field_by_field_key_optionReturns a paginated pagination list of all the options of a select list issue field. A select list issue field is a type of issue fieldhttps://developer.atlassian.com/cloud/jira/platform/modules/issue-field/ that enables a user to select a value from a list of options. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-grofieldKey (string)
startAt (integer)
maxResults (integer)
post_rest_api_3_field_by_field_key_optionCreates an option for a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes. Permissions permissions required: Administer Jira global permissionhttps://conffieldKey (string)
data: {
. config
. properties (object)
. value (string)
} (object) required
get_rest_api_3_field_by_field_key_option_suggestions_editReturns a paginated pagination list of options for a select list issue field that can be viewed and selected by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Permission to access Jira.fieldKey (string)
startAt (integer)
maxResults (integer)
projectId (integer)
get_rest_api_3_field_by_field_key_option_suggestions_searchReturns a paginated pagination list of options for a select list issue field that can be viewed by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Permission to access Jira.fieldKey (string)
startAt (integer)
maxResults (integer)
projectId (integer)
delete_rest_api_3_field_by_field_key_option_by_option_idDeletes an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Jira permissions are not required for the app providing the field.fieldKey (string)
optionId (integer)
get_rest_api_3_field_by_field_key_option_by_option_idReturns an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options api-group-Issue-custom-field-options resource. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Jira permissions are not required for the app providing the field.fieldKey (string)
optionId (integer)
put_rest_api_3_field_by_field_key_option_by_option_idUpdates 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. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field optiofieldKey (string)
optionId (integer)
data: {
. config
. id (integer)
. properties (object)
. value (string)
} (object) required
delete_rest_api_3_field_by_field_key_option_by_option_id_issueDeselects 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. Connect and Forge app users with Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag. This is an asynchronous operation async. The response objfieldKey (string)
optionId (integer)
replaceWith (integer)
jql (string)
overrideScreenSecurity (boolean)
overrideEditableFlag (boolean)
delete_rest_api_3_field_by_idDeletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom fieldhttps://confluence.atlassian.com/x/Z44fOw for more information on trashing and deleting custom fields. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://conflueid (string)
post_rest_api_3_field_by_id_restoreRestores a custom field from trash. See Edit or delete a custom fieldhttps://confluence.atlassian.com/x/Z44fOw for more information on trashing and deleting custom fields. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
post_rest_api_3_field_by_id_trashMoves a custom field to trash. See Edit or delete a custom fieldhttps://confluence.atlassian.com/x/Z44fOw for more information on trashing and deleting custom fields. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
get_rest_api_3_fieldconfigurationReturns a paginated pagination list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: a list of field configuration item IDs. whether the field configuration is a default. whether the field configuration name or description contains a query string. Only field configurations used in company-managed classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://costartAt (integer)
maxResults (integer)
id (array)
isDefault (boolean)
query (string)
post_rest_api_3_fieldconfigurationCreates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
delete_rest_api_3_fieldconfiguration_by_idDeletes a field configuration. This operation can only delete configurations used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
put_rest_api_3_fieldconfiguration_by_idUpdates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_3_fieldconfiguration_by_id_fieldsReturns a paginated pagination list of all fields for a configuration. Only the fields from configurations used in company-managed classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
startAt (integer)
maxResults (integer)
put_rest_api_3_fieldconfiguration_by_id_fieldsUpdates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed classic projects. The operation can set the renderer for text fields to the default text renderer text-renderer or wiki style renderer wiki-renderer. However, the renderer cannot be updated for fields using the autocomplete renderer autocomplete-renderer. Hiding a field deletes it from the fid (integer)
data: {
. fieldConfigurationItems (array)
} (object) required
get_rest_api_3_fieldconfigurationschemeReturns a paginated pagination list of field configuration schemes. Only field configuration schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
post_rest_api_3_fieldconfigurationschemeCreates a field configuration scheme. This operation can only create field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
get_rest_api_3_fieldconfigurationscheme_mappingReturns a paginated pagination list of field configuration issue type items. Only items used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
fieldConfigurationSchemeId (array)
get_rest_api_3_fieldconfigurationscheme_projectReturns a paginated pagination list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
projectId (array) required
put_rest_api_3_fieldconfigurationscheme_projectAssigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. fieldConfigurationSchemeId (string)
. projectId (string)
} (object) required
delete_rest_api_3_fieldconfigurationscheme_by_idDeletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
put_rest_api_3_fieldconfigurationscheme_by_idUpdates a field configuration scheme. This operation can only update field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_fieldconfigurationscheme_by_id_mappingAssigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. mappings (array)
} (object) required
post_rest_api_3_fieldconfigurationscheme_by_id_mapping_deleteRemoves issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. issueTypeIds (array)
} (object) required
post_rest_api_3_filterCreates a filter. The filter is shared according to the default share scope api-rest-api-3-filter-post. The filter is not selected as a favorite. Permissions permissions required: Permission to access Jira.expand (string)
overrideSharePermissions (boolean)
data: {
. approximateLastUsed (string)
. description (string)
. editPermissions (array)
. favourite (boolean)
. favouritedCount (integer)
. id (string)
. jql (string)
. name (string)
. owner
. searchUrl (string)
. self (string)
. sharePermissions (array)
. sharedUsers
. subscriptions
. viewUrl (string)
} (object) required
get_rest_api_3_filter_default_share_scopeReturns the default sharing settings for new filters and dashboards for a user. Permissions permissions required: Permission to access Jira.No parameters
put_rest_api_3_filter_default_share_scopeSets the default sharing for new filters and dashboards for a user. Permissions permissions required: Permission to access Jira.data: {
. scope (string)
} (object) required
get_rest_api_3_filter_favouriteReturns the visible favorite filters of the user. This operation can be accessed anonymously. Permissions permissions required: A favorite filter is only visible to the user where the filter is: owned by the user. shared with a group that the user is a member of. shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. shared with a public project. shared with the public. For example, if the user favoritesexpand (string)
get_rest_api_3_filter_myReturns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned. Permissions permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is: owned by the user. shared with a group that the user is a member of. shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. shared with a public projeexpand (string)
includeFavourites (boolean)
get_rest_api_3_filter_searchReturns a paginated pagination list of filters. Use this operation to get: specific filters, by defining id only. filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously. Permissions permissions required: None, however, only the following filters that match the query parameters are returfilterName (string)
accountId (string)
owner (string)
groupname (string)
groupId (string)
projectId (integer)
id (array)
orderBy (string)
startAt (integer)
maxResults (integer)
expand (string)
overrideSharePermissions (boolean)
isSubstringMatch (boolean)
delete_rest_api_3_filter_by_idDelete a filter. Permissions permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_3_filter_by_idReturns a filter. This operation can be accessed anonymously. Permissions permissions required: None, however, the filter is only returned where it is: owned by the user. shared with a group that the user is a member of. shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. shared with a public project. shared with the public.id (integer)
expand (string)
overrideSharePermissions (boolean)
put_rest_api_3_filter_by_idUpdates a filter. Use this operation to update a filter's name, description, JQL, or sharing. Permissions permissions required: Permission to access Jira, however the user must own the filter.id (integer)
expand (string)
overrideSharePermissions (boolean)
data: {
. approximateLastUsed (string)
. description (string)
. editPermissions (array)
. favourite (boolean)
. favouritedCount (integer)
. id (string)
. jql (string)
. name (string)
. owner
. searchUrl (string)
. self (string)
. sharePermissions (array)
. sharedUsers
. subscriptions
. viewUrl (string)
} (object) required
delete_rest_api_3_filter_by_id_columnsReset the user's column configuration for the filter to the default. Permissions permissions required: Permission to access Jira, however, columns are only reset for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. filters shared with a public project. filters shared with the public.id (integer)
get_rest_api_3_filter_by_id_columnsReturns 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. This operation can be accessed anonymously. Permissions permissions required: None, however, column details are only returned for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browse projects project permissionhttps://confluence.atlid (integer)
put_rest_api_3_filter_by_id_columnsSets the columns for a filter. Only navigable fields can be set as columns. Use Get fields api-rest-api-3-field-get to get the list fields in Jira. A navigable field has navigable set to true. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns Permissions permissions required: Permission to access Jira, however, columns are only set for:id (integer)
data: {
. columns (array)
} (object) required
delete_rest_api_3_filter_by_id_favouriteRemoves 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. For example, if the user favorites a public filter that is subsequently made private and is therefore no longer visible on their favorites list they cannot remove it from their favorites list. Permissions permissions required: Permission to access Jira.id (integer)
expand (string)
put_rest_api_3_filter_by_id_favouriteAdd a filter as a favorite for the user. Permissions permissions required: Permission to access Jira, however, the user can only favorite: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for. filters shared with a public project. filters shared with the public.id (integer)
expand (string)
put_rest_api_3_filter_by_id_ownerChanges the owner of the filter. Permissions permissions required: Permission to access Jira. However, the user must own the filter or have the Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. accountId (string)
} (object) required
get_rest_api_3_filter_by_id_permissionReturns 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. This operation can be accessed anonymously. Permissions permissions required: None, however, share permissions are only returned for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Bid (integer)
post_rest_api_3_filter_by_id_permissionAdd 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. Be aware that this operation uses different objects for updating share permissions compared to Update filter api-rest-api-3-filter-id-put. Permissions permissions required: Share dashboards and filters global permissionhttps://confluence.atlassian.com/x/x4dKLg and the user must own the filter.id (integer)
data: {
. accountId (string)
. groupId (string)
. groupname (string)
. projectId (string)
. projectRoleId (string)
. rights (integer)
. type (string)
} (object) required
delete_rest_api_3_filter_by_id_permission_by_permission_idDeletes a share permission from a filter. Permissions permissions required: Permission to access Jira and the user must own the filter.id (integer)
permissionId (integer)
get_rest_api_3_filter_by_id_permission_by_permission_idReturns 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. This operation can be accessed anonymously. Permissions permissions required: None, however, a share permission is only returned for: filters owned by the user. filters shared with a group that the user is a member of. filters shared with a private project that the user has Browid (integer)
permissionId (integer)
delete_rest_api_3_groupDeletes a group. Permissions permissions required: Site administration that is, member of the site-admin strategic grouphttps://confluence.atlassian.com/x/24xjL.groupname (string)
groupId (string)
swapGroup (string)
swapGroupId (string)
get_rest_api_3_groupThis operation is deprecated, use group/member api-rest-api-3-group-member-get. Returns all users in a group. Permissions permissions required: either of: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.groupname (string)
groupId (string)
expand (string)
post_rest_api_3_groupCreates a group. Permissions permissions required: Site administration that is, member of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.data: {
. name (string)
} (object) required
get_rest_api_3_group_bulkReturns a paginated pagination list of groups. Permissions permissions required: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
groupId (array)
groupName (array)
accessType (string)
applicationKey (string)
get_rest_api_3_group_memberReturns a paginated pagination list of all users in a group. Note that users are ordered by username, however the username is not returned in the results due to privacy reasons. Permissions permissions required: either of: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.groupname (string)
groupId (string)
includeInactiveUsers (boolean)
startAt (integer)
maxResults (integer)
delete_rest_api_3_group_userRemoves a user from a group. Permissions permissions required: Site administration that is, member of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.groupname (string)
groupId (string)
username (string)
accountId (string) required
post_rest_api_3_group_userAdds a user to a group. Permissions permissions required: Site administration that is, member of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.groupname (string)
groupId (string)
data: {
. accountId (string)
. name (string)
} (object) required
get_rest_api_3_groups_pickerReturns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matcaccountId (string)
query (string)
exclude (array)
excludeId (array)
maxResults (integer)
caseInsensitive (boolean)
userName (string)
get_rest_api_3_groupuserpickerReturns a list of users and groups matching a string. The string is used: for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required. for groups, to find a case-sensitive match with group name. For example, if the string tin is used, records with the display name Tina, email address sarah@tinplatetraining.query (string) required
maxResults (integer)
showAvatar (boolean)
fieldId (string)
projectId (array)
issueTypeId (array)
avatarSize (string)
caseInsensitive (boolean)
excludeConnectAddons (boolean)
get_rest_api_3_instance_licenseReturns licensing information about the Jira instance. Permissions permissions required: None.No parameters
post_rest_api_3_issueCreates 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. The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata api-rest-api-3-issue-createmeta-get. These are the same fields that appear on the issue's create supdateHistory (boolean)
data: {
. fields (object)
. historyMetadata
. properties (array)
. transition
. update (object)
} (object) required
post_rest_api_3_issue_archiveEnables 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. You can use the get taskhttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/ api-rest-api-3-task-taskid-get and cancel taskhttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/ api-rest-api-3-task-taskid-cancel-post APIs to manage the request. Note that: you can't archive subtasks directly, only throughdata: {
. jql (string)
} (object) required
put_rest_api_3_issue_archiveEnables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issues archived in the process and the errors encountered, if any. Note that: you can't archive subtasks directly, only through their parent issues you can only archive issues from software, service management, and business projects Permissions permissions required: Jira admin or site admin: global permissionhttps://confluence.atlassian.com/x/x4dKLg License required: Premium ordata: {
. issueIdsOrKeys (array)
} (object) required
post_rest_api_3_issue_bulkCreates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set. The content of each issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata api-rest-api-3-issue-createmeta-get. These are the same fields that appear on the issues'data: {
. issueUpdates (array)
} (object) required
post_rest_api_3_issue_bulkfetchReturns the details for a set of requested issues. You can request up to 100 issues. Each issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. Issues will be returned in ascending id order. If there are errors, Jira will return a list of issues which couldn't be fetched along with error messages.data: {
. expand (array)
. fields (array)
. fieldsByKeys (boolean)
. issueIdsOrKeys (array)
. properties (array)
} (object) required
get_rest_api_3_issue_createmetaReturns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue api-rest-api-3-issue-post and Create issues api-rest-api-3-issue-bulk-post. Deprecated, see Create Issue Meta Endpoint Deprecation Noticehttps://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-1304. The request can be restricted to specific projects or issue types using the query parprojectIds (array)
projectKeys (array)
issuetypeIds (array)
issuetypeNames (array)
expand (string)
get_rest_api_3_issue_createmeta_by_project_id_or_key_issuetypesReturns a page of issue type metadata for a specified project. Use the information to populate the requests in Create issue api-rest-api-3-issue-post and Create issues api-rest-api-3-issue-bulk-post. This operation can be accessed anonymously. Permissions permissions required: Create issues project permissionhttps://confluence.atlassian.com/x/yodKLg in the requested projects.projectIdOrKey (string)
startAt (integer)
maxResults (integer)
get_rest_api_3_issue_createmeta_by_project_id_or_key_issuetypes_by_issue_type_idReturns a page of field metadata for a specified project and issuetype id. Use the information to populate the requests in Create issue api-rest-api-3-issue-post and Create issues api-rest-api-3-issue-bulk-post. This operation can be accessed anonymously. Permissions permissions required: Create issues project permissionhttps://confluence.atlassian.com/x/yodKLg in the requested projects.projectIdOrKey (string)
issueTypeId (string)
startAt (integer)
maxResults (integer)
get_rest_api_3_issue_limit_reportReturns all issues breaching and approaching per-issue limits. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg is required for the project the issues are in. Results may be incomplete otherwise Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.isReturningKeys (boolean)
get_rest_api_3_issue_pickerReturns 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. This operation returns two lists: History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter. Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter. This operationquery (string)
currentJQL (string)
currentIssueKey (string)
currentProjectId (string)
showSubTasks (boolean)
showSubTaskParent (boolean)
post_rest_api_3_issue_propertiesSets 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. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously. This operation is: transactional, either all properties are updated in all eligdata: {
. entitiesIds (array)
. properties (object)
} (object) required
post_rest_api_3_issue_properties_multiSets 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. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON. This operation is: asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. non-transactional. Updating some entities maydata: {
. issues (array)
} (object) required
delete_rest_api_3_issue_properties_by_property_keyDeletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The criteria the filter used to identify eligible issues are: entityIds Only issues from this list are eligible. currentValue Only issues with the property set to this value are eligible. If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible. If no filter criteria are specified, all the issues visiblepropertyKey (string)
data: {
. currentValue
. entityIds (array)
} (object) required
put_rest_api_3_issue_properties_by_property_keySets a property value on multiple issues. The value set can be a constant or determined by a Jira expressionhttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictionshttps://developer.atlassian.com/cloud/jira/platform/jira-expressions/ restrictions that apply to all Jira expressions. The issues to be updated can be specified by a filter. The fpropertyKey (string)
data: {
. expression (string)
. filter
. value
} (object) required
put_rest_api_3_issue_unarchiveEnables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issues unarchived in the process and the errors encountered, if any. Note that: you can't unarchive subtasks directly, only through their parent issues you can only unarchive issues from software, service management, and business projects Permissions permissions required: Jira admin or site admin: global permissionhttps://confluence.atlassian.com/x/x4dKLg License required: Predata: {
. issueIdsOrKeys (array)
} (object) required
post_rest_api_3_issue_watchingReturns, 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. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that tdata: {
. issueIds (array)
} (object) required
delete_rest_api_3_issue_by_issue_id_or_keyDeletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks. This causes the issue's subtasks to be deleted with the issue. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Delete issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-issueIdOrKey (string)
deleteSubtasks (string)
get_rest_api_3_issue_by_issue_id_or_keyReturns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atissueIdOrKey (string)
fields (array)
fieldsByKeys (boolean)
expand (string)
properties (array)
updateHistory (boolean)
failFast (boolean)
put_rest_api_3_issue_by_issue_id_or_keyEdits an issue. Issue properties may be updated as part of the edit. Please note that issue transition is not supported and is ignored here. To transition an issue, please use Transition issue api-rest-api-3-issue-issueIdOrKey-transitions-post. The edits to the issue's fields are defined using update and fields. The fields that can be edited are determined using Get edit issue metadata api-rest-api-3-issue-issueIdOrKey-editmeta-get. The parent field may be set by key or ID. For standard issueissueIdOrKey (string)
notifyUsers (boolean)
overrideScreenSecurity (boolean)
overrideEditableFlag (boolean)
returnIssue (boolean)
expand (string)
data: {
. fields (object)
. historyMetadata
. properties (array)
. transition
. update (object)
} (object) required
put_rest_api_3_issue_by_issue_id_or_key_assigneeAssigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in. If name or accountId is set to: '-1', the issue is assigned to the default assignee for the project. null, the issue is set to unassigned. This operation can be accessed anonymously. Permissions permissions required: Browse Projects and Assign Issues project permissionhttps://confluence.atlassian.comissueIdOrKey (string)
data: {
. accountId (string)
. accountType (string)
. active (boolean)
. applicationRoles
. avatarUrls
. displayName (string)
. emailAddress (string)
. expand (string)
. groups
. key (string)
. locale (string)
. name (string)
. self (string)
. timeZone (string)
} (object) required
post_rest_api_3_issue_by_issue_id_or_key_attachmentsAdds one or more attachments to an issue. Attachments are posted as multipart/form-data RFC 1867https://www.ietf.org/rfc/rfc1867.txt. Note that: The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers special-request-headers for more information. The name of the multipart/form-data parameter that contains the attachments must be file. The following examples upload a file called myfile.txt to the issue TEST-123: curl curl --loissueIdOrKey (string)
get_rest_api_3_issue_by_issue_id_or_key_changelogReturns a paginated pagination list of all changelogs for an issue sorted by date, starting from the oldest. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
startAt (integer)
maxResults (integer)
post_rest_api_3_issue_by_issue_id_or_key_changelog_listReturns changelogs for an issue specified by a list of changelog IDs. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
data: {
. changelogIds (array)
} (object) required
get_rest_api_3_issue_by_issue_id_or_key_commentReturns all comments for an issue. This operation can be accessed anonymously. Permissions permissions required: Comments are included in the response where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the comment. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, belongs to the group or haissueIdOrKey (string)
startAt (integer)
maxResults (integer)
orderBy (string)
expand (string)
post_rest_api_3_issue_by_issue_id_or_key_commentAdds a comment to an issue. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Add comments project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue containing the comment is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
expand (string)
data: {
. author
. body
. created (string)
. id (string)
. jsdAuthorCanSeeRequest (boolean)
. jsdPublic (boolean)
. properties (array)
. renderedBody (string)
. self (string)
. updateAuthor
. updated (string)
. visibility
} (object) required
delete_rest_api_3_issue_by_issue_id_or_key_comment_by_idDeletes a comment. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue containing the comment is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. Delete all comments project permissionhttps://confluence.atlassian.com/x/yodKLg to delete any comment or Delete own comments to delete comment created by the user, IissueIdOrKey (string)
id (string)
get_rest_api_3_issue_by_issue_id_or_key_comment_by_idReturns a comment. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the comment. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
id (string)
expand (string)
put_rest_api_3_issue_by_issue_id_or_key_comment_by_idUpdates a comment. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue containing the comment is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. Edit all comments project permissionhttps://confluence.atlassian.com/x/yodKLg to update any comment or Edit own comments toissueIdOrKey (string)
id (string)
notifyUsers (boolean)
overrideEditableFlag (boolean)
expand (string)
data: {
. author
. body
. created (string)
. id (string)
. jsdAuthorCanSeeRequest (boolean)
. jsdPublic (boolean)
. properties (array)
. renderedBody (string)
. self (string)
. updateAuthor
. updated (string)
. visibility
} (object) required
get_rest_api_3_issue_by_issue_id_or_key_editmetaReturns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue api-rest-api-3-issue-issueIdOrKey-put. This endpoint will check for these conditions: 1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. overrideScreenSecurity=true skips this condition. 2. Field is visible in the field configurationhttps://support.atlassian.comissueIdOrKey (string)
overrideScreenSecurity (boolean)
overrideEditableFlag (boolean)
post_rest_api_3_issue_by_issue_id_or_key_notifyCreates an email notification for an issue and adds it to the mail queue. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
data: {
. htmlBody (string)
. restrict
. subject (string)
. textBody (string)
. to
} (object) required
get_rest_api_3_issue_by_issue_id_or_key_propertiesReturns the URLs and keys of an issue's properties. This operation can be accessed anonymously. Permissions permissions required: Property details are only returned where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
delete_rest_api_3_issue_by_issue_id_or_key_properties_by_property_keyDeletes an issue's property. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Edit issues project permissionshttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
propertyKey (string)
get_rest_api_3_issue_by_issue_id_or_key_properties_by_property_keyReturns the key and value of an issue's property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
propertyKey (string)
put_rest_api_3_issue_by_issue_id_or_key_properties_by_property_keySets the value of an issue's property. Use this resource to store custom data against an issue. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Edit issues project permissionshttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttps://confluence.aissueIdOrKey (string)
propertyKey (string)
data (undefined) required
delete_rest_api_3_issue_by_issue_id_or_key_remotelinkDeletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support and id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Link issuissueIdOrKey (string)
globalId (string) required
get_rest_api_3_issue_by_issue_id_or_key_remotelinkReturns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support and id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. ThisissueIdOrKey (string)
globalId (string)
post_rest_api_3_issue_by_issue_id_or_key_remotelinkCreates or updates a remote issue link for an issue. If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Link issues project permissionhttps://confluence.atlissueIdOrKey (string)
data: {
. application
. globalId (string)
. object
. relationship (string)
} (object) required
delete_rest_api_3_issue_by_issue_id_or_key_remotelink_by_link_idDeletes a remote issue link from an issue. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects, Edit issues, and Link issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
linkId (string)
get_rest_api_3_issue_by_issue_id_or_key_remotelink_by_link_idReturns a remote issue link for an issue. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.issueIdOrKey (string)
linkId (string)
put_rest_api_3_issue_by_issue_id_or_key_remotelink_by_link_idUpdates a remote issue link for an issue. Note: Fields without values in the request are set to null. This operation requires issue linking to be activehttps://confluence.atlassian.com/x/yoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Link issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-lissueIdOrKey (string)
linkId (string)
data: {
. application
. globalId (string)
. object
. relationship (string)
} (object) required
get_rest_api_3_issue_by_issue_id_or_key_transitionsReturns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status. Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list. This operation can be accessed anonymously. Permissions permissions required: A list or transition is returned only when the user has: Browse projects project permissionhttps://confluence.atlassian.issueIdOrKey (string)
expand (string)
transitionId (string)
skipRemoteOnlyCondition (boolean)
includeUnavailableTransitions (boolean)
sortByOpsBarAndStatus (boolean)
post_rest_api_3_issue_by_issue_id_or_key_transitionsPerforms an issue transition and, if the transition has a screen, updates the fields from the transition screen. sortByCategory To update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using Get transitions api-rest-api-3-issue-issueIdOrKey-transitions-get with the transitions.fields expand. This operation can be accessed anonymously. Permissions permissions required: Browse projects and TransitissueIdOrKey (string)
data: {
. fields (object)
. historyMetadata
. properties (array)
. transition
. update (object)
} (object) required
delete_rest_api_3_issue_by_issue_id_or_key_votesDeletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-leissueIdOrKey (string)
get_rest_api_3_issue_by_issue_id_or_key_votesReturns details about the votes on an issue. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is ini If issue-level securityhttps:/issueIdOrKey (string)
post_rest_api_3_issue_by_issue_id_or_key_votesAdds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level sissueIdOrKey (string)
delete_rest_api_3_issue_by_issue_id_or_key_watchersDeletes a user as a watcher of an issue. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, iissueIdOrKey (string)
username (string)
accountId (string)
get_rest_api_3_issue_by_issue_id_or_key_watchersReturns the watchers for an issue. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is ini If issue-level securityhttps://confluence.issueIdOrKey (string)
post_rest_api_3_issue_by_issue_id_or_key_watchersAdds a user as a watcher of an issue by passing the account ID of the user. For example, '5b10ac8d82e05b22cc7d4ef5'. If no user is specified the calling user is added. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application optionshttps://confluence.atlassian.com/x/uYXKM for details. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yoissueIdOrKey (string)
data (string) required
delete_rest_api_3_issue_by_issue_id_or_key_worklogDeletes a list of worklogs from an issue. This is an experimental API with limitations: You can't delete more than 5000 worklogs at once. No notifications will be sent for deleted worklogs. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the projissueIdOrKey (string)
adjustEstimate (string)
overrideEditableFlag (boolean)
data: {
. ids (array)
} (object) required
get_rest_api_3_issue_by_issue_id_or_key_worklogReturns 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. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Workloads are only returned where the user has: Browse projects project permissionhttps://conflissueIdOrKey (string)
startAt (integer)
maxResults (integer)
startedAfter (integer)
startedBefore (integer)
expand (string)
post_rest_api_3_issue_by_issue_id_or_key_worklogAdds a worklog to an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects and Work on issues project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configurissueIdOrKey (string)
notifyUsers (boolean)
adjustEstimate (string)
newEstimate (string)
reduceBy (string)
expand (string)
overrideEditableFlag (boolean)
data: {
. author
. comment
. created (string)
. id (string)
. issueId (string)
. properties (array)
. self (string)
. started (string)
. timeSpent (string)
. timeSpentSeconds (integer)
. updateAuthor
. updated (string)
. visibility
} (object) required
post_rest_api_3_issue_by_issue_id_or_key_worklog_moveMoves a list of worklogs from one issue to another. This is an experimental API with several limitations: You can't move more than 5000 worklogs at once. You can't move worklogs containing an attachment. You can't move worklogs restricted by project roles. No notifications will be sent for moved worklogs. No webhooks or events will be sent for moved worklogs. No issue history will be recorded for moved worklogs. Time tracking must be enabled in Jira, otherwise this operationissueIdOrKey (string)
adjustEstimate (string)
overrideEditableFlag (boolean)
data: {
. ids (array)
. issueIdOrKey (string)
} (object) required
delete_rest_api_3_issue_by_issue_id_or_key_worklog_by_idDeletes a worklog from an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-leveissueIdOrKey (string)
id (string)
notifyUsers (boolean)
adjustEstimate (string)
newEstimate (string)
increaseBy (string)
overrideEditableFlag (boolean)
get_rest_api_3_issue_by_issue_id_or_key_worklog_by_idReturns a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security perissueIdOrKey (string)
id (string)
expand (string)
put_rest_api_3_issue_by_issue_id_or_key_worklog_by_idUpdates a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time trackinghttps://confluence.atlassian.com/x/qoXKM. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security perissueIdOrKey (string)
id (string)
notifyUsers (boolean)
adjustEstimate (string)
newEstimate (string)
expand (string)
overrideEditableFlag (boolean)
data: {
. author
. comment
. created (string)
. id (string)
. issueId (string)
. properties (array)
. self (string)
. started (string)
. timeSpent (string)
. timeSpentSeconds (integer)
. updateAuthor
. updated (string)
. visibility
} (object) required
get_rest_api_3_issue_by_issue_id_or_key_worklog_by_worklog_id_propertiesReturns the keys of all properties for a worklog. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
worklogId (string)
delete_rest_api_3_issue_by_issue_id_or_key_worklog_by_worklog_id_properties_by_property_keyDeletes a worklog property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
worklogId (string)
propertyKey (string)
get_rest_api_3_issue_by_issue_id_or_key_worklog_by_worklog_id_properties_by_property_keyReturns the value of a worklog property. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue. If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.issueIdOrKey (string)
worklogId (string)
propertyKey (string)
put_rest_api_3_issue_by_issue_id_or_key_worklog_by_worklog_id_properties_by_property_keySets the value of a worklog property. Use this operation to store custom data against the worklog. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/xissueIdOrKey (string)
worklogId (string)
propertyKey (string)
data (undefined) required
post_rest_api_3_issue_linkCreates 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. To use this resource the site must have Issue Linkinghttps://confluence.atlassian.com/x/yoXKM enabled. This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/3/issue/linked issue key?fields=issuelinks. If the link request duplicates a link, the respodata: {
. comment
. inwardIssue
. outwardIssue
. type
} (object) required
delete_rest_api_3_issue_link_by_link_idDeletes an issue link. This operation can be accessed anonymously. Permissions permissions required: Browse project project permissionhttps://confluence.atlassian.com/x/yodKLg for all the projects containing the issues in the link. Link issues project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one of the projects containing issues in the link. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, permission to view both of the issues.linkId (string)
get_rest_api_3_issue_link_by_link_idReturns an issue link. This operation can be accessed anonymously. Permissions permissions required: Browse project project permissionhttps://confluence.atlassian.com/x/yodKLg for all the projects containing the linked issues. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, permission to view both of the issues.linkId (string)
get_rest_api_3_issue_link_typeReturns a list of all issue link types. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for a project in the site.No parameters
post_rest_api_3_issue_link_typeCreates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. id (string)
. inward (string)
. name (string)
. outward (string)
. self (string)
} (object) required
delete_rest_api_3_issue_link_type_by_issue_link_type_idDeletes an issue link type. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueLinkTypeId (string)
get_rest_api_3_issue_link_type_by_issue_link_type_idReturns an issue link type. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for a project in the site.issueLinkTypeId (string)
put_rest_api_3_issue_link_type_by_issue_link_type_idUpdates an issue link type. To use this operation, the site must have issue linkinghttps://confluence.atlassian.com/x/yoXKM enabled. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueLinkTypeId (string)
data: {
. id (string)
. inward (string)
. name (string)
. outward (string)
. self (string)
} (object) required
put_rest_api_3_issues_archive_exportEnables 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. Note that this API only exports the values of system fields and archival-specific fields ArchivedBy and ArchivedDate. Custom fields aren't supported. Permissions permissions required: Jira admin or site admin: global permissionhttps://confluence.atlassian.com/x/x4dKLg License required: Premium or Enterdata: {
. archivedBy (array)
. archivedDateRange
. issueTypes (array)
. projects (array)
. reporters (array)
} (object) required
get_rest_api_3_issuesecurityschemesReturns all issue security schemeshttps://confluence.atlassian.com/x/J4lKLg. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
post_rest_api_3_issuesecurityschemesCreates 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. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. levels (array)
. name (string)
} (object) required
get_rest_api_3_issuesecurityschemes_levelReturns a paginated pagination list of issue security levels. Only issue security levels in the context of classic projects are returned. Filtering using IDs is inclusive: if you specify both security scheme IDs and level IDs, the result will include both specified issue security levels and all issue security levels from the specified schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
id (array)
schemeId (array)
onlyDefault (boolean)
put_rest_api_3_issuesecurityschemes_level_defaultSets default issue security levels for schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultValues (array)
} (object) required
get_rest_api_3_issuesecurityschemes_level_memberReturns a paginated pagination list of issue security level members. Only issue security level members in the context of classic projects are returned. Filtering using parameters is inclusive: if you specify both security scheme IDs and level IDs, the result will include all issue security level members from the specified schemes and levels. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
id (array)
schemeId (array)
levelId (array)
expand (string)
get_rest_api_3_issuesecurityschemes_projectReturns a paginated pagination mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Only issue security schemes in the context of classic projects are supported. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
issueSecuritySchemeId (array)
projectId (array)
put_rest_api_3_issuesecurityschemes_projectAssociates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. oldToNewSecurityLevelMappings (array)
. projectId (string)
. schemeId (string)
} (object) required
get_rest_api_3_issuesecurityschemes_searchReturns a paginated pagination list of issue security schemes. If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you filter by. Use to obtain all projects related to scheme. Only issue security schemes in the context of classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (string)
maxResults (string)
id (array)
projectId (array)
get_rest_api_3_issuesecurityschemes_by_idReturns an issue security scheme along with its security levels. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for a project that uses the requested issue security scheme.id (integer)
put_rest_api_3_issuesecurityschemes_by_idUpdates the issue security scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_3_issuesecurityschemes_by_issue_security_scheme_id_membersReturns issue security level members. Only issue security level members in context of classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueSecuritySchemeId (integer)
startAt (integer)
maxResults (integer)
issueSecurityLevelId (array)
expand (string)
delete_rest_api_3_issuesecurityschemes_by_scheme_idDeletes an issue security scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
put_rest_api_3_issuesecurityschemes_by_scheme_id_levelAdds levels and levels' members to the issue security scheme. You can add up to 100 levels per request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
data: {
. levels (array)
} (object) required
delete_rest_api_3_issuesecurityschemes_by_scheme_id_level_by_level_idDeletes an issue security level. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
replaceWith (string)
put_rest_api_3_issuesecurityschemes_by_scheme_id_level_by_level_idUpdates the issue security level. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_issuesecurityschemes_by_scheme_id_level_by_level_id_memberAdds members to the issue security level. You can add up to 100 members per request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
data: {
. members (array)
} (object) required
delete_rest_api_3_issuesecurityschemes_by_scheme_id_level_by_level_id_member_by_member_idRemoves an issue security level member from an issue security scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (string)
levelId (string)
memberId (string)
get_rest_api_3_issuetypeReturns all issue types. This operation can be accessed anonymously. Permissions permissions required: Issue types are only returned as follows: if the user has the Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, all issue types are returned. if the user has the Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for one or more projects, the issue types associated with the projects the user has permission to browse are returned. ifNo parameters
post_rest_api_3_issuetypeCreates an issue type and adds it to the default issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. hierarchyLevel (integer)
. name (string)
. type (string)
} (object) required
get_rest_api_3_issuetype_projectReturns issue types for a project. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg in the relevant project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectId (integer) required
level (integer)
delete_rest_api_3_issuetype_by_idDeletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type alternativeIssueTypeId. A list of alternative issue types are obtained from the Get alternative issue types api-rest-api-3-issuetype-id-alternatives-get resource. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
alternativeIssueTypeId (string)
get_rest_api_3_issuetype_by_idReturns an issue type. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg in a project the issue type is associated with or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
put_rest_api_3_issuetype_by_idUpdates the issue type. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. avatarId (integer)
. description (string)
. name (string)
} (object) required
get_rest_api_3_issuetype_by_id_alternativesReturns 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. This operation can be accessed anonymously. Permissions permissions required: None.id (string)
post_rest_api_3_issuetype_by_id_avatar2Loads an avatar for the issue type. Specify the avatar's local file location in the body of the request. Also, include the following headers: X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers special-request-headers. Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:api_token --header 'X-Atlassian-Token: no-check' --header 'Content-Typeid (string)
x (integer)
y (integer)
size (integer) required
get_rest_api_3_issuetype_by_issue_type_id_propertiesReturns all the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties keys of the issue type. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg to get the property keys of any issue type. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg to get the property kissueTypeId (string)
delete_rest_api_3_issuetype_by_issue_type_id_properties_by_property_keyDeletes the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeId (string)
propertyKey (string)
get_rest_api_3_issuetype_by_issue_type_id_properties_by_property_keyReturns the key and value of the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg to get the details of any issue type. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg to get the details of any issue tissueTypeId (string)
propertyKey (string)
put_rest_api_3_issuetype_by_issue_type_id_properties_by_property_keyCreates or updates the value of the issue type propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. Use this resource to store and update data against an issue type. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.issueTypeId (string)
propertyKey (string)
data (undefined) required
get_rest_api_3_issuetypeschemeReturns a paginated pagination list of issue type schemes. Only issue type schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
orderBy (string)
expand (string)
queryString (string)
post_rest_api_3_issuetypeschemeCreates an issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultIssueTypeId (string)
. description (string)
. issueTypeIds (array)
. name (string)
} (object) required
get_rest_api_3_issuetypescheme_mappingReturns a paginated pagination list of issue type scheme items. Only issue type scheme items used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
issueTypeSchemeId (array)
get_rest_api_3_issuetypescheme_projectReturns a paginated pagination list of issue type schemes and, for each issue type scheme, a list of the projects that use it. Only issue type schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
projectId (array) required
put_rest_api_3_issuetypescheme_projectAssigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme. Issue type schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. issueTypeSchemeId (string)
. projectId (string)
} (object) required
delete_rest_api_3_issuetypescheme_by_issue_type_scheme_idDeletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Any projects assigned to the scheme are reassigned to the default issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
put_rest_api_3_issuetypescheme_by_issue_type_scheme_idUpdates an issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
data: {
. defaultIssueTypeId (string)
. description (string)
. name (string)
} (object) required
put_rest_api_3_issuetypescheme_by_issue_type_scheme_id_issuetypeAdds issue types to an issue type scheme. The added issue types are appended to the issue types list. If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
data: {
. issueTypeIds (array)
} (object) required
put_rest_api_3_issuetypescheme_by_issue_type_scheme_id_issuetype_moveChanges the order of issue types in an issue type scheme. The request body parameters must meet the following requirements: all of the issue types must belong to the issue type scheme. either after or position must be provided. the issue type in after must not be in the issue type list. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
data: {
. after (string)
. issueTypeIds (array)
. position (string)
} (object) required
delete_rest_api_3_issuetypescheme_by_issue_type_scheme_id_issuetype_by_issue_type_idRemoves an issue type from an issue type scheme. This operation cannot remove: any issue type used by issues. any issue types from the default issue type scheme. the last standard issue type from an issue type scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeSchemeId (integer)
issueTypeId (integer)
get_rest_api_3_issuetypescreenschemeReturns a paginated pagination list of issue type screen schemes. Only issue type screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
queryString (string)
orderBy (string)
expand (string)
post_rest_api_3_issuetypescreenschemeCreates an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. issueTypeMappings (array)
. name (string)
} (object) required
get_rest_api_3_issuetypescreenscheme_mappingReturns a paginated pagination list of issue type screen scheme items. Only issue type screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
issueTypeScreenSchemeId (array)
get_rest_api_3_issuetypescreenscheme_projectReturns a paginated pagination list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it. Only issue type screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
projectId (array) required
put_rest_api_3_issuetypescreenscheme_projectAssigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. issueTypeScreenSchemeId (string)
. projectId (string)
} (object) required
delete_rest_api_3_issuetypescreenscheme_by_issue_type_screen_scheme_idDeletes an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
put_rest_api_3_issuetypescreenscheme_by_issue_type_screen_scheme_idUpdates an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_issuetypescreenscheme_by_issue_type_screen_scheme_id_mappingAppends issue type to screen scheme mappings to an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. issueTypeMappings (array)
} (object) required
put_rest_api_3_issuetypescreenscheme_by_issue_type_screen_scheme_id_mapping_defaultUpdates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. screenSchemeId (string)
} (object) required
post_rest_api_3_issuetypescreenscheme_by_issue_type_screen_scheme_id_mapping_removeRemoves issue type to screen scheme mappings from an issue type screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (string)
data: {
. issueTypeIds (array)
} (object) required
get_rest_api_3_issuetypescreenscheme_by_issue_type_screen_scheme_id_projectReturns a paginated pagination list of projects associated with an issue type screen scheme. Only company-managed projects associated with an issue type screen scheme are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.issueTypeScreenSchemeId (integer)
startAt (integer)
maxResults (integer)
query (string)
get_rest_api_3_jql_autocompletedataReturns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields referencehttps://confluence.atlassian.com/x/gwORLQ and Advanced searching - functions referencehttps://confluence.atlassian.com/x/hgORLQ, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. To filter visible field details by project or coNo parameters
post_rest_api_3_jql_autocompletedataReturns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields referencehttps://confluence.atlassian.com/x/gwORLQ and Advanced searching - functions referencehttps://confluence.atlassian.com/x/hgORLQ, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. This operation can filter the custom fields retudata: {
. includeCollapsedFields (boolean)
. projectIds (array)
} (object) required
get_rest_api_3_jql_autocompletedata_suggestionsReturns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: fieldName to get a list of all values for the field. fieldName and fieldValue to get a list of values containing the text in fieldValue. fieldName and predicateName to get a list of all predicate values for the field. fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue. This operation can be accessed anonymously.fieldName (string)
fieldValue (string)
predicateName (string)
predicateValue (string)
get_rest_api_3_jql_function_computationReturns the list of a function's precomputations along with information about when they were created, updated, and last used. Each precomputation has a value - the JQL fragment to replace the custom function clause with. Permissions permissions required: This API is only accessible to apps and apps can only inspect their own functions. The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list becfunctionKey (array)
startAt (integer)
maxResults (integer)
orderBy (string)
post_rest_api_3_jql_function_computationUpdate the precomputation value of a function created by a Forge/Connect app. Permissions permissions required: An API for apps to update their own precomputations. The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.skipNotFoundPrecomputations (boolean)
data: {
. values (array)
} (object) required
post_rest_api_3_jql_function_computation_searchReturns function precomputations by IDs, along with information about when they were created, updated, and last used. Each precomputation has a value - the JQL fragment to replace the custom function clause with. Permissions permissions required: This API is only accessible to apps and apps can only inspect their own functions. The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because weorderBy (string)
data: {
. precomputationIDs (array)
} (object) required
post_rest_api_3_jql_matchChecks whether one or more issues would be returned by one or more JQL queries. Permissions permissions required: None, however, issues are only matched against JQL queries where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that the issue is in. If issue-level securityhttps://confluence.atlassian.com/x/J4lKLg is configured, issue-level security permission to view the issue.data: {
. issueIds (array)
. jqls (array)
} (object) required
post_rest_api_3_jql_parseParses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. Permissions permissions required: None.validation (string) required
data: {
. queries (array)
} (object) required
post_rest_api_3_jql_pdcleanerConverts one or more JQL queries with user identifiers username or user key to equivalent JQL queries with account IDs. You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guidehttps://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/. Permissions permissions required: Permission to access Jira.data: {
. queryStrings (array)
} (object) required
post_rest_api_3_jql_sanitizeSanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity. For example, if the query contains the clause project = 'Secret project', and a user does not have browse permission for the project 'Secret project', the sanitized query replaces the clause with project = 12345' where 12345 is the ID of the project. If a user has the required permission, the clause is not sanitized. If the account ID is null, sanitizing is performedata: {
. queries (array)
} (object) required
get_rest_api_3_labelReturns a paginated pagination list of labels.startAt (integer)
maxResults (integer)
get_rest_api_3_license_approximate_license_countReturns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
get_rest_api_3_license_approximate_license_count_product_by_application_keyReturns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.applicationKey (string)
get_rest_api_3_mypermissionsReturns 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. The user is reported as having a project permission: in the global context, if the user has the project permission in any project. for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project pprojectKey (string)
projectId (string)
issueKey (string)
issueId (string)
permissions (string)
projectUuid (string)
projectConfigurationUuid (string)
commentId (string)
delete_rest_api_3_mypreferencesDeletes a preference of the user, which restores the default value of system defined settings. Note that these keys are deprecated: jira.user.locale The locale of the user. By default, not set. The user takes the instance locale. jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone. Use Update a user profilehttps://developer.atlassian.com/cloud/admin/user-management/rest/ api-users-account-id-manage-profile-patch from the user managemekey (string) required
get_rest_api_3_mypreferencesReturns the value of a preference of the current user. Note that these keys are deprecated: jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance. jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance. These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not have any impact on Notification behaviour.key (string) required
put_rest_api_3_mypreferencesCreates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created: user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html. user.default.share.private Whether new filtershttps://confluence.atlassian.com/x/eQiiLQ are set to prkey (string) required
data (string) required
get_rest_api_3_mypreferences_localeReturns the locale for the user. If the user has no language preference set which is the default setting or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
put_rest_api_3_mypreferences_localeDeprecated, use Update a user profilehttps://developer.atlassian.com/cloud/admin/user-management/rest/ api-users-account-id-manage-profile-patch from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the instance of Jira. Permissions permissions required: Permission to access Jira.data: {
. locale (string)
} (object) required
get_rest_api_3_myselfReturns details for the current user. Permissions permissions required: Permission to access Jira.expand (string)
get_rest_api_3_notificationschemeReturns a paginated pagination list of notification schemeshttps://confluence.atlassian.com/x/8YdKLg ordered by the display name. Note that you should allow for events without recipients to appear in responses. Permissions permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.startAt (string)
maxResults (string)
id (array)
projectId (array)
onlyDefault (boolean)
expand (string)
post_rest_api_3_notificationschemeCreates a notification scheme with notifications. You can create up to 1000 notifications per request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
. notificationSchemeEvents (array)
} (object) required
get_rest_api_3_notificationscheme_projectReturns a paginated pagination 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. Note that only company-managed classic projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId. Permissions permissions required: Permission to accessstartAt (string)
maxResults (string)
notificationSchemeId (array)
projectId (array)
get_rest_api_3_notificationscheme_by_idReturns a notification schemehttps://confluence.atlassian.com/x/8YdKLg, including the list of events and the recipients who will receive notifications for those events. Permissions permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.id (integer)
expand (string)
put_rest_api_3_notificationscheme_by_idUpdates a notification scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_notificationscheme_by_id_notificationAdds notifications to a notification scheme. You can add up to 1000 notifications per request. Deprecated: The notification type EmailAddress is no longer supported in Cloud. Refer to the changeloghttps://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-1031 for more details. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. notificationSchemeEvents (array)
} (object) required
delete_rest_api_3_notificationscheme_by_notification_scheme_idDeletes a notification scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.notificationSchemeId (string)
delete_rest_api_3_notificationscheme_by_notification_scheme_id_notification_by_notification_idRemoves a notification from a notification scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.notificationSchemeId (string)
notificationId (string)
get_rest_api_3_permissionsReturns all permissions, including: global permissions. project permissions. global permissions added by plugins. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
post_rest_api_3_permissions_checkReturns: for a list of global permissions, the global permissions granted to a user. for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate. If no account ID is provided, the operation returns details for the logged in user. Note that: Invalid project and issue IDs are ignored. A maximum of 1000 projects and 1000 issues can be checked. Null values in globalPermissions, prdata: {
. accountId (string)
. globalPermissions (array)
. projectPermissions (array)
} (object) required
post_rest_api_3_permissions_projectReturns all the projects where the user is granted a list of project permissions. This operation can be accessed anonymously. Permissions permissions required: None.data: {
. permissions (array)
} (object) required
get_rest_api_3_permissionschemeReturns all permission schemes. About permission schemes and grants A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission. Holder object The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is 'type': 'group', and the parameter is the group name,expand (string)
post_rest_api_3_permissionschemeCreates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.expand (string)
data: {
. description (string)
. expand (string)
. id (integer)
. name (string)
. permissions (array)
. scope
. self (string)
} (object) required
delete_rest_api_3_permissionscheme_by_scheme_idDeletes a permission scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
get_rest_api_3_permissionscheme_by_scheme_idReturns a permission scheme. Permissions permissions required: Permission to access Jira.schemeId (integer)
expand (string)
put_rest_api_3_permissionscheme_by_scheme_idUpdates a permission scheme. Below are some important things to note when using this resource: If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants. If you want to update only the name and description, then do not send a permissions list in the request. Sending an empty list will remove all permission grants from the permission scheme. If you want to add or delete a permission grant instead of updating the whole listschemeId (integer)
expand (string)
data: {
. description (string)
. expand (string)
. id (integer)
. name (string)
. permissions (array)
. scope
. self (string)
} (object) required
get_rest_api_3_permissionscheme_by_scheme_id_permissionReturns all permission grants for a permission scheme. Permissions permissions required: Permission to access Jira.schemeId (integer)
expand (string)
post_rest_api_3_permissionscheme_by_scheme_id_permissionCreates a permission grant in a permission scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
expand (string)
data: {
. holder
. id (integer)
. permission (string)
. self (string)
} (object) required
delete_rest_api_3_permissionscheme_by_scheme_id_permission_by_permission_idDeletes a permission grant from a permission scheme. See About permission schemes and grants../api-group-permission-schemes/ about-permission-schemes-and-grants for more details. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
permissionId (integer)
get_rest_api_3_permissionscheme_by_scheme_id_permission_by_permission_idReturns a permission grant. Permissions permissions required: Permission to access Jira.schemeId (integer)
permissionId (integer)
expand (string)
get_rest_api_3_plans_planReturns a paginated pagination list of plans. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.includeTrashed (boolean)
includeArchived (boolean)
cursor (string)
maxResults (integer)
post_rest_api_3_plans_planCreates a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.useGroupId (boolean)
data: {
. crossProjectReleases (array)
. customFields (array)
. exclusionRules
. issueSources (array)
. leadAccountId (string)
. name (string)
. permissions (array)
. scheduling
} (object) required
get_rest_api_3_plans_plan_by_plan_idReturns a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
useGroupId (boolean)
put_rest_api_3_plans_plan_by_plan_idUpdates any of the following details of a plan using JSON Patchhttps://datatracker.ietf.org/doc/html/rfc6902. name leadAccountId scheduling estimation with StoryPoints, Days or Hours as possible values startDate type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values dateCustomFieldId endDate type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible valuesplanId (integer)
useGroupId (boolean)
put_rest_api_3_plans_plan_by_plan_id_archiveArchives a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
post_rest_api_3_plans_plan_by_plan_id_duplicateDuplicates a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
data: {
. name (string)
} (object) required
get_rest_api_3_plans_plan_by_plan_id_teamReturns a paginated pagination list of plan-only and Atlassian teams in a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
cursor (string)
maxResults (integer)
post_rest_api_3_plans_plan_by_plan_id_team_atlassianAdds an existing Atlassian team to a plan and configures their plannning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
data: {
. capacity (number)
. id (string)
. issueSourceId (integer)
. planningStyle (string)
. sprintLength (integer)
} (object) required
delete_rest_api_3_plans_plan_by_plan_id_team_atlassian_by_atlassian_team_idRemoves an Atlassian team from a plan and deletes their planning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
atlassianTeamId (string)
get_rest_api_3_plans_plan_by_plan_id_team_atlassian_by_atlassian_team_idReturns planning settings for an Atlassian team in a plan. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
atlassianTeamId (string)
put_rest_api_3_plans_plan_by_plan_id_team_atlassian_by_atlassian_team_idUpdates any of the following planning settings of an Atlassian team in a plan using JSON Patchhttps://datatracker.ietf.org/doc/html/rfc6902. planningStyle issueSourceId sprintLength capacity Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Note that 'add' operations do not respect array indexes in target locations. Call the 'Get Atlassian team in plan' endpoint to find out the order of array elements.planId (integer)
atlassianTeamId (string)
post_rest_api_3_plans_plan_by_plan_id_team_planonlyCreates a plan-only team and configures their planning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
data: {
. capacity (number)
. issueSourceId (integer)
. memberAccountIds (array)
. name (string)
. planningStyle (string)
. sprintLength (integer)
} (object) required
delete_rest_api_3_plans_plan_by_plan_id_team_planonly_by_plan_only_team_idDeletes a plan-only team and their planning settings. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
planOnlyTeamId (integer)
get_rest_api_3_plans_plan_by_plan_id_team_planonly_by_plan_only_team_idReturns planning settings for a plan-only team. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
planOnlyTeamId (integer)
put_rest_api_3_plans_plan_by_plan_id_team_planonly_by_plan_only_team_idUpdates any of the following planning settings of a plan-only team using JSON Patchhttps://datatracker.ietf.org/doc/html/rfc6902. name planningStyle issueSourceId sprintLength capacity memberAccountIds Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Note that 'add' operations do not respect array indexes in target locations. Call the 'Get plan-only team' endpoint to find out the order of array elements.planId (integer)
planOnlyTeamId (integer)
put_rest_api_3_plans_plan_by_plan_id_trashMoves a plan to trash. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.planId (integer)
get_rest_api_3_priorityReturns the list of all issue priorities. Permissions permissions required: Permission to access Jira.No parameters
post_rest_api_3_priorityCreates an issue priority. Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changeloghttps://developer.atlassian.com/changelog/ CHANGE-1525. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. avatarId (integer)
. description (string)
. iconUrl (string)
. name (string)
. statusColor (string)
} (object) required
put_rest_api_3_priority_defaultSets default issue priority. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. id (string)
} (object) required
put_rest_api_3_priority_moveChanges the order of issue priorities. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. after (string)
. ids (array)
. position (string)
} (object) required
get_rest_api_3_priority_searchReturns a paginated pagination list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria: a list of priority IDs. Any invalid priority IDs are ignored. a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored. whether the field configuration is a default. This returns priorities from company-managed classic projects only, as there is no concept of default pstartAt (string)
maxResults (string)
id (array)
projectId (array)
priorityName (string)
onlyDefault (boolean)
expand (string)
delete_rest_api_3_priority_by_idDeletes an issue priority. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
get_rest_api_3_priority_by_idReturns an issue priority. Permissions permissions required: Permission to access Jira.id (string)
put_rest_api_3_priority_by_idUpdates an issue priority. At least one request body parameter must be defined. Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changeloghttps://developer.atlassian.com/changelog/ CHANGE-1525. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. avatarId (integer)
. description (string)
. iconUrl (string)
. name (string)
. statusColor (string)
} (object) required
get_rest_api_3_priorityschemeReturns a paginated pagination list of priority schemes. Permissions permissions required: Permission to access Jira.startAt (string)
maxResults (string)
priorityId (array)
schemeId (array)
schemeName (string)
onlyDefault (boolean)
orderBy (string)
expand (string)
post_rest_api_3_priorityschemeCreates a new priority scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultPriorityId (integer)
. description (string)
. mappings
. name (string)
. priorityIds (array)
. projectIds (array)
} (object) required
post_rest_api_3_priorityscheme_mappingsReturns a paginated pagination list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme. Permissions permissions required: Permission to access Jira.data: {
. maxResults (integer)
. priorities
. projects
. schemeId (integer)
. startAt (integer)
} (object) required
get_rest_api_3_priorityscheme_priorities_availableReturns a paginated pagination list of priorities available for adding to a priority scheme. Permissions permissions required: Permission to access Jira.startAt (string)
maxResults (string)
query (string)
schemeId (string) required
exclude (array)
delete_rest_api_3_priorityscheme_by_scheme_idDeletes a priority scheme. This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
put_rest_api_3_priorityscheme_by_scheme_idUpdates a priority scheme. This includes its details, the lists of priorities and projects in it Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.schemeId (integer)
data: {
. defaultPriorityId (integer)
. description (string)
. mappings
. name (string)
. priorities
. projects
} (object) required
get_rest_api_3_priorityscheme_by_scheme_id_prioritiesReturns a paginated pagination list of priorities by scheme. Permissions permissions required: Permission to access Jira.schemeId (string)
startAt (string)
maxResults (string)
get_rest_api_3_priorityscheme_by_scheme_id_projectsReturns a paginated pagination list of projects by scheme. Permissions permissions required: Permission to access Jira.schemeId (string)
startAt (string)
maxResults (string)
projectId (array)
query (string)
get_rest_api_3_projectReturns all projects visible to the user. Deprecated, use Get projects paginated api-rest-api-3-project-search-get that supports search and pagination. This operation can be accessed anonymously. Permissions permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.expand (string)
recent (integer)
properties (array)
post_rest_api_3_projectCreates a project based on a project type template, as shown in the following table: | Project Type Key | Project Template Key | |--|--| | business | com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-cordata: {
. assigneeType (string)
. avatarId (integer)
. categoryId (integer)
. description (string)
. fieldConfigurationScheme (integer)
. issueSecurityScheme (integer)
. issueTypeScheme (integer)
. issueTypeScreenScheme (integer)
. key (string)
. lead (string)
. leadAccountId (string)
. name (string)
. notificationScheme (integer)
. permissionScheme (integer)
. projectTemplateKey (string)
. projectTypeKey (string)
. url (string)
. workflowScheme (integer)
} (object) required
post_rest_api_3_project_templateCreates a project based on a custom template provided in the request. The request body should contain the project details and the capabilities that comprise the project: details - represents the project details settings template - represents a list of capabilities responsible for creating specific parts of a project A capability is defined as a unit of configuration for the project you want to create. This operation is: asynchronous async. Follow the Location link in the response hdata: {
. details
. template
} (object) required
put_rest_api_3_project_template_edit_templateEdit custom template This API endpoint allows you to edit an existing customised template. Note: Custom Templates are only supported for Jira Enterprise edition.data: {
. templateDescription (string)
. templateGenerationOptions
. templateKey (string)
. templateName (string)
} (object) required
get_rest_api_3_project_template_live_templateGet custom template This API endpoint allows you to get a live custom project template details by either templateKey or projectId Note: Custom Templates are only supported for Jira Enterprise edition.projectId (string)
templateKey (string)
delete_rest_api_3_project_template_remove_templateRemove custom template This API endpoint allows you to remove a specified customised template Note: Custom Templates are only supported for Jira Enterprise edition.templateKey (string) required
post_rest_api_3_project_template_save_templateSave custom template This API endpoint allows you to save a customised template Note: Custom Templates are only supported for Jira Enterprise edition.data: {
. templateDescription (string)
. templateFromProjectRequest
. templateName (string)
} (object) required
get_rest_api_3_project_recentReturns a list of up to 20 projects recently viewed by the user that are still visible to the user. This operation can be accessed anonymously. Permissions permissions required: Projects are returned only where the user has one of: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Jira global permissionhttps://confluence.atlassian.com/expand (string)
properties (array)
get_rest_api_3_project_searchReturns a paginated pagination list of projects visible to the user. This operation can be accessed anonymously. Permissions permissions required: Projects are returned only where the user has one of: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
orderBy (string)
id (array)
keys (array)
query (string)
typeKey (string)
categoryId (integer)
action (string)
expand (string)
status (array)
properties (array)
propertyQuery (string)
get_rest_api_3_project_typeReturns all project typeshttps://confluence.atlassian.com/x/Var1Nw, whether or not the instance has a valid license for each type. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
get_rest_api_3_project_type_accessibleReturns all project typeshttps://confluence.atlassian.com/x/Var1Nw with a valid license.No parameters
get_rest_api_3_project_type_by_project_type_keyReturns a project typehttps://confluence.atlassian.com/x/Var1Nw. This operation can be accessed anonymously. Permissions permissions required: None.projectTypeKey (string)
get_rest_api_3_project_type_by_project_type_key_accessibleReturns a project typehttps://confluence.atlassian.com/x/Var1Nw if it is accessible to the user. Permissions permissions required: Permission to access Jira.projectTypeKey (string)
delete_rest_api_3_project_by_project_id_or_keyDeletes a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
enableUndo (boolean)
get_rest_api_3_project_by_project_id_or_keyReturns the project detailshttps://confluence.atlassian.com/x/ahLpNw for a project. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
expand (string)
properties (array)
put_rest_api_3_project_by_project_id_or_keyUpdates the project detailshttps://confluence.atlassian.com/x/ahLpNw of a project. All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. is only needed when changing the schemes or project key. Otherwise you will only need Administer Projects project permissionhttps://conflueprojectIdOrKey (string)
expand (string)
data: {
. assigneeType (string)
. avatarId (integer)
. categoryId (integer)
. description (string)
. issueSecurityScheme (integer)
. key (string)
. lead (string)
. leadAccountId (string)
. name (string)
. notificationScheme (integer)
. permissionScheme (integer)
. releasedProjectKeys (array)
. url (string)
} (object) required
post_rest_api_3_project_by_project_id_or_key_archiveArchives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
put_rest_api_3_project_by_project_id_or_key_avatarSets the avatar displayed for a project. Use Load project avatar api-rest-api-3-project-projectIdOrKey-avatar2-post to store avatars against the project, before using this operation to set the displayed avatar. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectIdOrKey (string)
data: {
. fileName (string)
. id (string)
. isDeletable (boolean)
. isSelected (boolean)
. isSystemAvatar (boolean)
. owner (string)
. urls (object)
} (object) required
delete_rest_api_3_project_by_project_id_or_key_avatar_by_idDeletes a custom avatar from a project. Note that system avatars cannot be deleted. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectIdOrKey (string)
id (integer)
post_rest_api_3_project_by_project_id_or_key_avatar2Loads an avatar for a project. Specify the avatar's local file location in the body of the request. Also, include the following headers: X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers special-request-headers. Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:api_token --header 'X-Atlassian-Token: no-check' --header 'Content-Type:projectIdOrKey (string)
x (integer)
y (integer)
size (integer)
get_rest_api_3_project_by_project_id_or_key_avatarsReturns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
delete_rest_api_3_project_by_project_id_or_key_classification_level_defaultRemove the default data classification level for a project. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
get_rest_api_3_project_by_project_id_or_key_classification_level_defaultReturns the default data classification for a project. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
put_rest_api_3_project_by_project_id_or_key_classification_level_defaultUpdates the default data classification level for a project. Permissions permissions required: Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project. Administer jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
data: {
. id (string)
} (object) required
get_rest_api_3_project_by_project_id_or_key_componentReturns a paginated pagination list of all components in a project. See the Get project components api-rest-api-3-project-projectIdOrKey-components-get resource if you want to get a full list of versions without pagination. If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassiaprojectIdOrKey (string)
startAt (integer)
maxResults (integer)
orderBy (string)
componentSource (string)
query (string)
get_rest_api_3_project_by_project_id_or_key_componentsReturns all components in a project. See the Get project components paginated api-rest-api-3-project-projectIdOrKey-component-get resource if you want to get a full list of components with pagination. If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLprojectIdOrKey (string)
componentSource (string)
post_rest_api_3_project_by_project_id_or_key_deleteDeletes a project asynchronously. This operation is: transactional, that is, if part of the delete fails the project is not deleted. asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
get_rest_api_3_project_by_project_id_or_key_featuresReturns the list of features for a project.projectIdOrKey (string)
put_rest_api_3_project_by_project_id_or_key_features_by_feature_keySets the state of a project feature.projectIdOrKey (string)
featureKey (string)
data: {
. state (string)
} (object) required
get_rest_api_3_project_by_project_id_or_key_propertiesReturns all project propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties keys for the project. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
delete_rest_api_3_project_by_project_id_or_key_properties_by_property_keyDeletes the propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties from a project. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the property.projectIdOrKey (string)
propertyKey (string)
get_rest_api_3_project_by_project_id_or_key_properties_by_property_keyReturns the value of a project propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the property.projectIdOrKey (string)
propertyKey (string)
put_rest_api_3_project_by_project_id_or_key_properties_by_property_keySets the value of the project propertyhttps://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/ a-id-jira-entity-properties-a-jira-entity-properties. You can use project properties to store custom data against the project. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permprojectIdOrKey (string)
propertyKey (string)
data (undefined) required
post_rest_api_3_project_by_project_id_or_key_restoreRestores a project that has been archived or placed in the Jira recycle bin. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLgfor Company managed projects. Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project for Team managed projects.projectIdOrKey (string)
get_rest_api_3_project_by_project_id_or_key_roleReturns a list of project roleshttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/ for the project returning the name and self URL for each role. Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles api-rest-api-3-role-get for more information. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for any project onprojectIdOrKey (string)
delete_rest_api_3_project_by_project_id_or_key_role_by_idDeletes actors from a project role for the project. To remove default actors from the project role, use Delete default actors from project role api-rest-api-3-role-id-actors-delete. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
id (integer)
user (string)
group (string)
groupId (string)
get_rest_api_3_project_by_project_id_or_key_role_by_idReturns a project role's details and actors associated with the project. The list of actors is sorted by display name. To check whether a user belongs to a role based on their group memberships, use Get user api-rest-api-3-user-get with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluprojectIdOrKey (string)
id (integer)
excludeInactiveUsers (boolean)
post_rest_api_3_project_by_project_id_or_key_role_by_idAdds actors to a project role for the project. To replace all actors for the project, use Set actors for project role api-rest-api-3-project-projectIdOrKey-role-id-put. This operation can be accessed anonymously. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
id (integer)
data: {
. group (array)
. groupId (array)
. user (array)
} (object) required
put_rest_api_3_project_by_project_id_or_key_role_by_idSets the actors for a project role for a project, replacing all existing actors. To add actors to the project without overwriting the existing list, use Add actors to project role api-rest-api-3-project-projectIdOrKey-role-id-post. Permissions permissions required: Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project or Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.projectIdOrKey (string)
id (integer)
data: {
. categorisedActors (object)
. id (integer)
} (object) required
get_rest_api_3_project_by_project_id_or_key_roledetailsReturns all project roleshttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/ and the details for each role. Note that the list of project roles is common to all projects. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
currentMember (boolean)
excludeConnectAddons (boolean)
excludeOtherServiceRoles (boolean)
get_rest_api_3_project_by_project_id_or_key_statusesReturns 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. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
get_rest_api_3_project_by_project_id_or_key_versionReturns a paginated pagination list of all versions in a project. See the Get project versions api-rest-api-3-project-projectIdOrKey-versions-get resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
startAt (integer)
maxResults (integer)
orderBy (string)
query (string)
status (string)
expand (string)
get_rest_api_3_project_by_project_id_or_key_versionsReturns all versions in a project. The response is not paginated. Use Get project versions paginated api-rest-api-3-project-projectIdOrKey-version-get if you want to get the versions in a project with pagination. This operation can be accessed anonymously. Permissions permissions required: Browse Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectIdOrKey (string)
expand (string)
get_rest_api_3_project_by_project_id_emailReturns the project's sender email addresshttps://confluence.atlassian.com/x/dolKLg. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project.projectId (integer)
put_rest_api_3_project_by_project_id_emailSets the project's sender email addresshttps://confluence.atlassian.com/x/dolKLg. If emailAddress is an empty string, the default email address is restored. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permission.https://confluence.atlassian.com/x/yodKLgprojectId (integer)
data: {
. emailAddress (string)
. emailAddressStatus (array)
} (object) required
get_rest_api_3_project_by_project_id_hierarchyGet the issue type hierarchy for a next-gen project. The issue type hierarchy for a project consists of: Epic at level 1 optional. One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic. Subtask at level -1 optional. This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue. Permissions permiprojectId (integer)
get_rest_api_3_project_by_project_key_or_id_issuesecuritylevelschemeReturns the issue security schemehttps://confluence.atlassian.com/x/J4lKLg associated with the project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or the Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectKeyOrId (string)
get_rest_api_3_project_by_project_key_or_id_notificationschemeGets a notification schemehttps://confluence.atlassian.com/x/8YdKLg associated with the project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectKeyOrId (string)
expand (string)
get_rest_api_3_project_by_project_key_or_id_permissionschemeGets the permission schemehttps://confluence.atlassian.com/x/yodKLg associated with the project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg.projectKeyOrId (string)
expand (string)
put_rest_api_3_project_by_project_key_or_id_permissionschemeAssigns a permission scheme with a project. See Managing project permissionshttps://confluence.atlassian.com/x/yodKLg for more information about permission schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLgprojectKeyOrId (string)
expand (string)
data: {
. id (integer)
} (object) required
get_rest_api_3_project_by_project_key_or_id_securitylevelReturns all issue securityhttps://confluence.atlassian.com/x/J4lKLg levels for the project that the user has access to. This operation can be accessed anonymously. Permissions permissions required: Browse projects global permissionhttps://confluence.atlassian.com/x/x4dKLg for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permissionhttps://confluence.atlassian.com/x/x4dKLg for the project.projectKeyOrId (string)
get_rest_api_3_project_categoryReturns all project categories. Permissions permissions required: Permission to access Jira.No parameters
post_rest_api_3_project_categoryCreates a project category. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. id (string)
. name (string)
. self (string)
} (object) required
delete_rest_api_3_project_category_by_idDeletes a project category. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_3_project_category_by_idReturns a project category. Permissions permissions required: Permission to access Jira.id (integer)
put_rest_api_3_project_category_by_idUpdates a project category. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. id (string)
. name (string)
. self (string)
} (object) required
get_rest_api_3_projectvalidate_keyValidates a project key by confirming the key is a valid string and not in use. Permissions permissions required: None.key (string)
get_rest_api_3_projectvalidate_valid_project_keyValidates a project key and, if the key is invalid or in use, generates a valid random string for the project key. Permissions permissions required: None.key (string)
get_rest_api_3_projectvalidate_valid_project_nameChecks 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. If a valid project name cannot be generated, a 404 response is returned. Permissions permissions required: None.name (string) required
post_rest_api_3_redactSubmit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously. The redaction status can be polled using the job id.data: {
. redactions (array)
} (object) required
get_rest_api_3_redact_status_by_job_idRetrieves the current status of a redaction job ID. The jobStatus will be one of the following: IN_PROGRESS - The redaction job is currently in progress COMPLETED - The redaction job has completed successfully. PENDING - The redaction job has not started yetjobId (string)
get_rest_api_3_resolutionReturns a list of all issue resolution values. Permissions permissions required: Permission to access Jira.No parameters
post_rest_api_3_resolutionCreates an issue resolution. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_resolution_defaultSets default issue resolution. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. id (string)
} (object) required
put_rest_api_3_resolution_moveChanges the order of issue resolutions. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. after (string)
. ids (array)
. position (string)
} (object) required
get_rest_api_3_resolution_searchReturns a paginated pagination list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria: a list of resolutions IDs. whether the field configuration is a default. This returns resolutions from company-managed classic projects only, as there is no concept of default resolutions in team-managed projects. Permissions permissions required: Permission to access Jira.startAt (string)
maxResults (string)
id (array)
onlyDefault (boolean)
delete_rest_api_3_resolution_by_idDeletes an issue resolution. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain subsequent updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
replaceWith (string) required
get_rest_api_3_resolution_by_idReturns an issue resolution value. Permissions permissions required: Permission to access Jira.id (string)
put_rest_api_3_resolution_by_idUpdates an issue resolution. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (string)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_3_roleGets a list of all project roles, complete with project role details and default actors. About project roles Project roleshttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/ are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it unlike groups, which have the same membership throughout all Jira apNo parameters
post_rest_api_3_roleCreates a new project role with no default actors api-rest-api-3-resolution-get. You can use the Add default actors to project role api-rest-api-3-role-id-actors-post operation to add default actors to the project role after creating it. Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created. Permissions permissions required: Administerdata: {
. description (string)
. name (string)
} (object) required
delete_rest_api_3_role_by_idDeletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
swap (integer)
get_rest_api_3_role_by_idGets the project role details and the default actors associated with the role. The list of default actors is sorted by display name. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
post_rest_api_3_role_by_idUpdates either the project role's name or its description. You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
put_rest_api_3_role_by_idUpdates the project role's name and description. You must include both a name and a description in the request. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. description (string)
. name (string)
} (object) required
delete_rest_api_3_role_by_id_actorsDeletes the default actors api-rest-api-3-resolution-get from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request. Changing a project role's default actors does not affect project role members for projects already created. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
user (string)
groupId (string)
group (string)
get_rest_api_3_role_by_id_actorsReturns the default actors api-rest-api-3-resolution-get for the project role. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
post_rest_api_3_role_by_id_actorsAdds default actors api-rest-api-3-resolution-get to a role. You may add groups or users, but you cannot add groups and users in the same request. Changing a project role's default actors does not affect project role members for projects already created. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. group (array)
. groupId (array)
. user (array)
} (object) required
get_rest_api_3_screensReturns a paginated pagination list of all screens or those specified by one or more screen IDs. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
queryString (string)
scope (array)
orderBy (string)
post_rest_api_3_screensCreates a screen with a default field tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
} (object) required
post_rest_api_3_screens_add_to_default_by_field_idAdds a field to the default tab of the default screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.fieldId (string)
get_rest_api_3_screens_tabsReturns the list of tabs for a bulk of screens. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (array)
tabId (array)
startAt (integer)
maxResult (integer)
delete_rest_api_3_screens_by_screen_idDeletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only screens used in classic projects can be deleted.screenId (integer)
put_rest_api_3_screens_by_screen_idUpdates a screen. Only screens used in classic projects can be updated. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
data: {
. description (string)
. name (string)
} (object) required
get_rest_api_3_screens_by_screen_id_available_fieldsReturns the fields that can be added to a tab on a screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
get_rest_api_3_screens_by_screen_id_tabsReturns the list of tabs for a screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.screenId (integer)
projectKey (string)
post_rest_api_3_screens_by_screen_id_tabsCreates a tab for a screen. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
data: {
. id (integer)
. name (string)
} (object) required
delete_rest_api_3_screens_by_screen_id_tabs_by_tab_idDeletes a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
put_rest_api_3_screens_by_screen_id_tabs_by_tab_idUpdates the name of a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
data: {
. id (integer)
. name (string)
} (object) required
get_rest_api_3_screens_by_screen_id_tabs_by_tab_id_fieldsReturns all fields for a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Administer projects project permissionhttps://confluence.atlassian.com/x/yodKLg when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.screenId (integer)
tabId (integer)
projectKey (string)
post_rest_api_3_screens_by_screen_id_tabs_by_tab_id_fieldsAdds a field to a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
data: {
. fieldId (string)
} (object) required
delete_rest_api_3_screens_by_screen_id_tabs_by_tab_id_fields_by_idRemoves a field from a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
id (string)
post_rest_api_3_screens_by_screen_id_tabs_by_tab_id_fields_by_id_moveMoves a screen tab field. If after and position are provided in the request, position is ignored. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
id (string)
data: {
. after (string)
. position (string)
} (object) required
post_rest_api_3_screens_by_screen_id_tabs_by_tab_id_move_by_posMoves a screen tab. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenId (integer)
tabId (integer)
pos (integer)
get_rest_api_3_screenschemeReturns a paginated pagination list of screen schemes. Only screen schemes used in classic projects are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
id (array)
expand (string)
queryString (string)
orderBy (string)
post_rest_api_3_screenschemeCreates a screen scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. description (string)
. name (string)
. screens
} (object) required
delete_rest_api_3_screenscheme_by_screen_scheme_idDeletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenSchemeId (string)
put_rest_api_3_screenscheme_by_screen_scheme_idUpdates a screen scheme. Only screen schemes used in classic projects can be updated. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.screenSchemeId (string)
data: {
. description (string)
. name (string)
. screens
} (object) required
get_rest_api_3_searchEndpoint is currently being removed. More detailshttps://developer.atlassian.com/changelog/ CHANGE-2046 Searches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. If the JQL query expression is too large to be encoded as a query parameter, use the POST api-rest-api-3-search-post version of this resource. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browse projects project permissionhttpsjql (string)
startAt (integer)
maxResults (integer)
validateQuery (string)
fields (array)
expand (string)
properties (array)
fieldsByKeys (boolean)
failFast (boolean)
post_rest_api_3_searchEndpoint is currently being removed. More detailshttps://developer.atlassian.com/changelog/ CHANGE-2046 Searches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. There is a GET api-rest-api-3-search-get version of this resource that can be used for smaller JQL query expressions. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browse projects project permissionhttps://confluence.atlassian.cdata: {
. expand (array)
. fields (array)
. fieldsByKeys (boolean)
. jql (string)
. maxResults (integer)
. properties (array)
. startAt (integer)
. validateQuery (string)
} (object) required
post_rest_api_3_search_approximate_countProvide an estimated count of the issues that match the JQLhttps://confluence.atlassian.com/x/egORLQ. Recent updates might not be immediately visible in the returned output. This endpoint requires JQL to be bounded. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the issue. If issue-level securityhttpdata: {
. jql (string)
} (object) required
get_rest_api_3_search_jqlSearches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. Recent updates might not be immediately visible in the returned search results. If you need read-after-writehttps://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/ consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously. If the JQL query expression is too large to be encoded as a query parameter, use the POST api-rest-jql (string)
nextPageToken (string)
maxResults (integer)
fields (array)
expand (string)
properties (array)
fieldsByKeys (boolean)
failFast (boolean)
reconcileIssues (array)
post_rest_api_3_search_jqlSearches for issues using JQLhttps://confluence.atlassian.com/x/egORLQ. Recent updates might not be immediately visible in the returned search results. If you need read-after-writehttps://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/ consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously. Permissions permissions required: Issues are included in the response where the user has: Browsdata: {
. expand (string)
. fields (array)
. fieldsByKeys (boolean)
. jql (string)
. maxResults (integer)
. nextPageToken (string)
. properties (array)
. reconcileIssues (array)
} (object) required
get_rest_api_3_securitylevel_by_idReturns details of an issue security level. Use Get issue security scheme api-rest-api-3-issuesecurityschemes-id-get to obtain the IDs of issue security levels associated with the issue security scheme. This operation can be accessed anonymously. Permissions permissions required: None.id (string)
get_rest_api_3_server_infoReturns information about the Jira instance. This operation can be accessed anonymously. Permissions permissions required: None.No parameters
get_rest_api_3_settings_columnsReturns the default issue navigator columns. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.No parameters
put_rest_api_3_settings_columnsSets the default issue navigator columns. The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns If no column details are sent, then all default columns are removed. A navigable field is one that can be used as a column on the issue navigator. Find details ofNo parameters
get_rest_api_3_statusReturns a list of all statuses associated with active workflows. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/ for the project.No parameters
get_rest_api_3_status_by_id_or_nameReturns a status. The status must be associated with an active workflow to be returned. If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/ for the project.idOrName (string)
get_rest_api_3_statuscategoryReturns a list of all status categories. Permissions permissions required: Permission to access Jira.No parameters
get_rest_api_3_statuscategory_by_id_or_keyReturns a status category. Status categories provided a mechanism for categorizing statuses api-rest-api-3-status-idOrName-get. Permissions permissions required: Permission to access Jira.idOrKey (string)
delete_rest_api_3_statusesDeletes statuses by ID. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgid (array) required
get_rest_api_3_statusesReturns a list of the statuses specified by one or more status IDs. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgid (array) required
post_rest_api_3_statusesCreates statuses for a global or project scope. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgdata: {
. scope
. statuses (array)
} (object) required
put_rest_api_3_statusesUpdates statuses by ID. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgdata: {
. statuses (array)
} (object) required
get_rest_api_3_statuses_by_namesReturns a list of the statuses specified by one or more status names. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLg Browse projects project permission.https://confluence.atlassian.com/x/yodKLgname (array) required
projectId (string)
get_rest_api_3_statuses_searchReturns a paginatedhttps://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/ pagination list of statuses that match a search on name or project. Permissions permissions required: Administer projects project permission.https://confluence.atlassian.com/x/yodKLg Administer Jira project permission.https://confluence.atlassian.com/x/yodKLgprojectId (string)
startAt (integer)
maxResults (integer)
searchString (string)
statusCategory (string)
get_rest_api_3_statuses_by_status_id_project_by_project_id_issue_type_usagesReturns a page of issue types in a project using a given status.statusId (string)
projectId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_3_statuses_by_status_id_project_usagesReturns a page of projects using a given status.statusId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_3_statuses_by_status_id_workflow_usagesReturns a page of workflows using a given status.statusId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_3_task_by_task_idReturns the status of a long-running asynchronous task async. When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice. Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024. read:jira-work Permissions permissions rtaskId (string)
post_rest_api_3_task_by_task_id_cancelCancels a task. Permissions permissions required: either of: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg. Creator of the task.taskId (string)
get_rest_api_3_ui_modificationsGets UI modifications. UI modifications can only be retrieved by Forge apps. Permissions permissions required: None. The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.startAt (integer)
maxResults (integer)
expand (string)
post_rest_api_3_ui_modificationsCreates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. Permissions permissions required: None if the UI modification is created without contexts. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for one or more projects, if the UI modification is created with contexts. Thdata: {
. contexts (array)
. data (string)
. description (string)
. name (string)
} (object) required
delete_rest_api_3_ui_modifications_by_ui_modification_idDeletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps. Permissions permissions required: None. The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.uiModificationId (string)
put_rest_api_3_ui_modifications_by_ui_modification_idUpdates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. Permissions permissions required: None if the UI modification is created without contexts. Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for one or more projects, if the UI modification is created with contexts. The new write:app-data:jira OAuth scope is 100% optuiModificationId (string)
data: {
. contexts (array)
. data (string)
. description (string)
. name (string)
} (object) required
get_rest_api_3_universal_avatar_type_by_type_owner_by_entity_idReturns the system and custom avatars for a project, issue type or priority. This operation can be accessed anonymously. Permissions permissions required: for custom project avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the avatar belongs to. for custom issue type avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one project the issue type is used in. for system avatars, none. fotype (string)
entityId (string)
post_rest_api_3_universal_avatar_type_by_type_owner_by_entity_idLoads a custom avatar for a project, issue type or priority. Specify the avatar's local file location in the body of the request. Also, include the following headers: X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers special-request-headers. Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:api_token --header 'X-Atlassian-Token: no-chetype (string)
entityId (string)
x (integer)
y (integer)
size (integer) required
delete_rest_api_3_universal_avatar_type_by_type_owner_by_owning_object_id_avatar_by_idDeletes an avatar from a project, issue type or priority. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.type (string)
owningObjectId (string)
id (integer)
get_rest_api_3_universal_avatar_view_type_by_typeReturns the default project, issue type or priority avatar image. This operation can be accessed anonymously. Permissions permissions required: None.type (string)
size (string)
format (string)
get_rest_api_3_universal_avatar_view_type_by_type_avatar_by_idReturns a project, issue type or priority avatar image by ID. This operation can be accessed anonymously. Permissions permissions required: For system avatars, none. For custom project avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the avatar belongs to. For custom issue type avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one project the issue type is used in. For priority avattype (string)
id (integer)
size (string)
format (string)
get_rest_api_3_universal_avatar_view_type_by_type_owner_by_entity_idReturns the avatar image for a project, issue type or priority. This operation can be accessed anonymously. Permissions permissions required: For system avatars, none. For custom project avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the avatar belongs to. For custom issue type avatars, Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for at least one project the issue type is used in. For priority avtype (string)
entityId (string)
size (string)
format (string)
delete_rest_api_3_userDeletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account. Permissions permissions required: Site administration that is, membership of the site-admin grouphttps://confluence.atlassian.com/x/24xjL.accountId (string) required
username (string)
key (string)
get_rest_api_3_userReturns a user. Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overviewhttps://developer.atlassian.com/cloud/jira/platform/profile-visibility/ for more details. Permissions permissions required: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg.accountId (string)
username (string)
key (string)
expand (string)
post_rest_api_3_userCreates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. applicationKeys (array)
. displayName (string)
. emailAddress (string)
. key (string)
. name (string)
. password (string)
. products (array)
. self (string)
} (object) required
get_rest_api_3_user_assignable_multi_project_searchReturns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, use Getquery (string)
username (string)
accountId (string)
projectKeys (string) required
startAt (integer)
maxResults (integer)
get_rest_api_3_user_assignable_searchReturns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to: a new issue, by providing the projectKeyOrId. an updated issue, by providing the issueKey or issueId. to an issue during a transition workflow action, by providing the issueKey or issueId and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of Get issue api-restquery (string)
sessionId (string)
username (string)
accountId (string)
project (string)
issueKey (string)
issueId (string)
startAt (integer)
maxResults (integer)
actionDescriptorId (integer)
recommend (boolean)
get_rest_api_3_user_bulkReturns a paginated pagination list of the users specified by one or more account IDs. Permissions permissions required: Permission to access Jira.startAt (integer)
maxResults (integer)
username (array)
key (array)
accountId (array) required
get_rest_api_3_user_bulk_migrationReturns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified. Permissions permissions required: Permission to access Jira.startAt (integer)
maxResults (integer)
username (array)
key (array)
delete_rest_api_3_user_columnsResets the default issue table columnshttps://confluence.atlassian.com/x/XYdKLg for the user to the system default. If accountId is not passed, the calling user's default columns are reset. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to set the columns on any user. Permission to access Jira, to set the calling user's columns.accountId (string)
username (string)
get_rest_api_3_user_columnsReturns the default issue table columnshttps://confluence.atlassian.com/x/XYdKLg for the user. If accountId is not passed in the request, the calling user's details are returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLgl, to get the column details for any user. Permission to access Jira, to get the calling user's column details.accountId (string)
username (string)
put_rest_api_3_user_columnsSets the default issue table columnshttps://confluence.atlassian.com/x/XYdKLg for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5' Permissions permissionsaccountId (string)
get_rest_api_3_user_emailReturns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelineshttps://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603. For Forge apps, this API only supports access via asApp requests.accountId (string) required
get_rest_api_3_user_email_bulkReturns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelineshttps://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603. For Forge apps, this API only supports access via asApp requests.accountId (array) required
get_rest_api_3_user_groupsReturns the groups to which a user belongs. Permissions permissions required: Browse users and groups global permissionhttps://confluence.atlassian.com/x/x4dKLg.accountId (string) required
username (string)
key (string)
get_rest_api_3_user_permission_searchReturns a list of users who fulfill these criteria: their user attributes match a search string. they have a set of permissions for a project or issue. If no search string is provided, a list of all users with the permissions is returned. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operatioquery (string)
username (string)
accountId (string)
permissions (string) required
issueKey (string)
projectKey (string)
startAt (integer)
maxResults (integer)
get_rest_api_3_user_pickerReturns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results. This operation takes the users in the range defined by maxResults, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in maxResultquery (string) required
maxResults (integer)
showAvatar (boolean)
exclude (array)
excludeAccountIds (array)
avatarSize (string)
excludeConnectUsers (boolean)
get_rest_api_3_user_propertiesReturns the keys of all properties for a user. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to access the property keys on any user. Access to Jira, to access the calling user's property keys.accountId (string)
userKey (string)
username (string)
delete_rest_api_3_user_properties_by_property_keyDeletes a property from a user. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to delete a property from any user. Access to Jira, to delete a property from the calling user's record.propertyKey (string)
accountId (string)
userKey (string)
username (string)
get_rest_api_3_user_properties_by_property_keyReturns the value of a user's property. If no property key is provided Get user property keys api-rest-api-3-user-properties-get is called. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to get a property from any user. Access to Jira, to get a property from the calling user's record.propertyKey (string)
accountId (string)
userKey (string)
username (string)
put_rest_api_3_user_properties_by_property_keySets the value of a user's property. Use this resource to store custom data against a user. Note: This operation does not access the user propertieshttps://confluence.atlassian.com/x/8YxjL created and maintained in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg, to set a property on any user. Access to Jira, to set a property on the calling user's record.propertyKey (string)
accountId (string)
userKey (string)
username (string)
data (undefined) required
get_rest_api_3_user_searchReturns a list of active users that match the search string and property. This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users api-rest-api-3-users-search-get and filter the records in your code. This operation can be accessed anonymously. Privacy controls are applied to the respoquery (string)
username (string)
accountId (string)
startAt (integer)
maxResults (integer)
property (string)
get_rest_api_3_user_search_queryFinds users with a structured query and returns a paginated pagination list of user details. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users api-rest-api-3-users-search-get and filter the records in your coquery (string) required
startAt (integer)
maxResults (integer)
get_rest_api_3_user_search_query_keyFinds users with a structured query and returns a paginated pagination list of user keys. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users api-rest-api-3-users-search-get and filter the records in your code.query (string) required
startAt (integer)
maxResult (integer)
get_rest_api_3_user_viewissue_searchReturns a list of users who fulfill these criteria: their user attributes match a search string. they have permission to browse issues. Use this resource to find users who can browse: an issue, by providing the issueKey. any issue in a project, by providing the projectKey. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browquery (string)
username (string)
accountId (string)
issueKey (string)
projectKey (string)
startAt (integer)
maxResults (integer)
get_rest_api_3_usersReturns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account. Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overviewhttps://developer.atlassian.com/cloud/jira/platform/profile-visibility/ for more details. Permissions permissions required: Browse users and groups global permissionhttps://confluence.astartAt (integer)
maxResults (integer)
get_rest_api_3_users_searchReturns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account. Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overviewhttps://developer.atlassian.com/cloud/jira/platform/profile-visibility/ for more details. Permissions permissions required: Browse users and groups global permissionhttps://confluence.astartAt (integer)
maxResults (integer)
post_rest_api_3_versionCreates a project version. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project the version is added to.data: {
. approvers (array)
. archived (boolean)
. description (string)
. driver (string)
. expand (string)
. id (string)
. issuesStatusForFixVersion
. moveUnfixedIssuesTo (string)
. name (string)
. operations (array)
. overdue (boolean)
. project (string)
. projectId (integer)
. releaseDate (string)
. released (boolean)
. self (string)
. startDate (string)
. userReleaseDate (string)
. userStartDate (string)
} (object) required
delete_rest_api_3_version_by_idDeletes a project version. Deprecated, use Delete and replace version api-rest-api-3-version-id-removeAndSwap-post that supports swapping version values in custom fields, in addition to the swapping for fixVersion and affectedVersion provided in this resource. Alternative versions can be provided to update issues that use the deleted version in fixVersion or affectedVersion. If alternatives are not provided, occurrences of fixVersion and affectedVersion that contain the deleted version are clid (string)
moveFixIssuesTo (string)
moveAffectedIssuesTo (string)
get_rest_api_3_version_by_idReturns a project version. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the version.id (string)
expand (string)
put_rest_api_3_version_by_idUpdates a project version. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg or Administer Projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project that contains the version.id (string)
data: {
. approvers (array)
. archived (boolean)
. description (string)
. driver (string)
. expand (string)
. id (string)
. issuesStatusForFixVersion
. moveUnfixedIssuesTo (string)
. name (string)
. operations (array)
. overdue (boolean)
. project (string)
. projectId (integer)
. releaseDate (string)
. released (boolean)
. self (string)
. startDate (string)
. userReleaseDate (string)
. userStartDate (string)
} (object) required
put_rest_api_3_version_by_id_mergeto_by_move_issues_toMerges 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. Consider using Delete and replace version api-rest-api-3-version-id-removeAndSwap-post instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields. This operation can be accessed anonymously. Permissions permissions required: Administer Jira global permissiid (string)
moveIssuesTo (string)
post_rest_api_3_version_by_id_moveModifies the version's sequence within the project, which affects the display order of the versions in Jira. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permission for the project that contains the version.id (string)
data: {
. after (string)
. position (string)
} (object) required
get_rest_api_3_version_by_id_related_issue_countsReturns the following counts for a version: Number of issues where the fixVersion is set to the version. Number of issues where the affectedVersion is set to the version. Number of issues where a version custom field is set to the version. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permission for the project that contains the version.id (string)
get_rest_api_3_version_by_id_relatedworkReturns related work items for the given version id. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permissionhttps://confluence.atlassian.com/x/yodKLg for the project containing the version.id (string)
post_rest_api_3_version_by_id_relatedworkCreates 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. This operation can be accessed anonymously. Permissions permissions required: Resolve issues: and Edit issues Managing project permissionshttps://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html for the project that contains the version.id (string)
data: {
. category (string)
. issueId (integer)
. relatedWorkId (string)
. title (string)
. url (string)
} (object) required
put_rest_api_3_version_by_id_relatedworkUpdates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited. This operation can be accessed anonymously. Permissions permissions required: Resolve issues: and Edit issues Managing project permissionshttps://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html for the project that contains the version.id (string)
data: {
. category (string)
. issueId (integer)
. relatedWorkId (string)
. title (string)
. url (string)
} (object) required
post_rest_api_3_version_by_id_remove_and_swapDeletes a project version. Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonid (string)
data: {
. customFieldReplacementList (array)
. moveAffectedIssuesTo (integer)
. moveFixIssuesTo (integer)
} (object) required
get_rest_api_3_version_by_id_unresolved_issue_countReturns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously. Permissions permissions required: Browse projects project permission for the project that contains the version.id (string)
delete_rest_api_3_version_by_version_id_relatedwork_by_related_work_idDeletes the given related work for the given version. This operation can be accessed anonymously. Permissions permissions required: Resolve issues: and Edit issues Managing project permissionshttps://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html for the project that contains the version.versionId (string)
relatedWorkId (string)
delete_rest_api_3_webhookRemoves webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.data: {
. webhookIds (array)
} (object) required
get_rest_api_3_webhookReturns a paginated pagination list of the webhooks registered by the calling app. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.startAt (integer)
maxResults (integer)
post_rest_api_3_webhookRegisters webhooks. NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.data: {
. url (string)
. webhooks (array)
} (object) required
get_rest_api_3_webhook_failedReturns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries. After 72 hours the failure may no longer be returned by this operation. The oldest failure is returned first. This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next. Permissions permissions required: Only Connect appshttps://developer.atlassian.com/cloudmaxResults (integer)
after (integer)
put_rest_api_3_webhook_refreshExtends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive. Unrecognized webhook IDs those that are not found or belong to other apps are ignored. Permissions permissions required: Only Connecthttps://developer.atlassian.com/cloud/jira/platform/ connect-apps and OAuth 2.0https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps apps can use this operation.data: {
. webhookIds (array)
} (object) required
get_rest_api_3_workflowThis will be removed on February 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2567; use Search workflows api-rest-api-3-workflows-search-get instead. Returns all workflows in Jira or a workflow. If the workflowName parameter is specified, the workflow is returned as an object not in an array. Otherwise, an array of workflow objects is returned. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.workflowName (string)
post_rest_api_3_workflowThis will be removed on February 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2568; use Bulk create workflows api-rest-api-3-workflows-create-post to create both team and company-managed scoped workflows. Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Condidata: {
. description (string)
. name (string)
. statuses (array)
. transitions (array)
} (object) required
get_rest_api_3_workflow_rule_configReturns a paginated pagination list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules: of one or more transition rule types, such as workflow post functionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/. matching one or more transition rule keys. Only workflows containing transition rules created by the calling Connecthttps://developer.atlassian.com/cloud/jira/platform/index/ costartAt (integer)
maxResults (integer)
types (array) required
keys (array)
workflowNames (array)
withTags (array)
draft (boolean)
expand (string)
put_rest_api_3_workflow_rule_configUpdates configuration of workflow transition rules. The following rule types are supported: post functionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/ conditionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/ validatorshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/ Only rules created by the calling Connecthttps://developer.atlassian.com/cloud/jira/platform/index/ connect-apps or Fordata: {
. workflows (array)
} (object) required
put_rest_api_3_workflow_rule_config_deleteDeletes workflow transition rules from one or more workflows. These rule types are supported: post functionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/ conditionshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/ validatorshttps://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/ Only rules created by the calling Connect app can be deleted. Permissions permissions required: Only Connect apps cadata: {
. workflows (array)
} (object) required
get_rest_api_3_workflow_searchThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2569; use Search workflows api-rest-api-3-workflows-search-get instead. Returns a paginated pagination list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned. This operation does not return next-gen workflows. Permissions permissions required: Administer Jira global permissionstartAt (integer)
maxResults (integer)
workflowName (array)
expand (string)
queryString (string)
orderBy (string)
isActive (boolean)
delete_rest_api_3_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; delete transition properties using Bulk update workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-update-post instead. Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition propertieshttps://confluence.atlassian.com/x/zIhKtransitionId (integer)
key (string) required
workflowName (string) required
workflowMode (string)
get_rest_api_3_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; fetch transition properties from Bulk get workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-post instead. Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition propertieshttps://confluence.atlassian.com/x/zIhKLg AdvancetransitionId (integer)
includeReservedKeys (boolean)
key (string)
workflowName (string) required
workflowMode (string)
post_rest_api_3_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; add transition properties using Bulk update workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-update-post instead. Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition propertieshttps://confluence.atlassian.com/x/zIhKLg AdvantransitionId (integer)
key (string) required
workflowName (string) required
workflowMode (string)
data: {
. id (string)
. key (string)
. value (string)
} (object) required
put_rest_api_3_workflow_transitions_by_transition_id_propertiesThis will be removed on June 1, 2026https://developer.atlassian.com/cloud/jira/platform/changelog/ CHANGE-2570; update transition properties using Bulk update workflowshttps://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/ api-rest-api-3-workflows-update-post instead. Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to chatransitionId (integer)
key (string) required
workflowName (string) required
workflowMode (string)
data: {
. id (string)
. key (string)
. value (string)
} (object) required
delete_rest_api_3_workflow_by_entity_idDeletes a workflow. The workflow cannot be deleted if it is: an active workflow. a system workflow. associated with any workflow scheme. associated with any draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.entityId (string)
get_rest_api_3_workflow_by_workflow_id_project_by_project_id_issue_type_usagesReturns a page of issue types using a given workflow within a project.workflowId (string)
projectId (integer)
nextPageToken (string)
maxResults (integer)
get_rest_api_3_workflow_by_workflow_id_project_usagesReturns a page of projects using a given workflow.workflowId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_3_workflow_by_workflow_id_workflow_schemesReturns a page of workflow schemes using a given workflow.workflowId (string)
nextPageToken (string)
maxResults (integer)
post_rest_api_3_workflowsReturns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types. Permissions permissions required: Administer Jira global permission to access all, including project-scoped, workflows At least one of the Administer projects and View read-only workflow project permissions to access project-scoped workflowsuseApprovalConfiguration (boolean)
data: {
. projectAndIssueTypes (array)
. workflowIds (array)
. workflowNames (array)
} (object) required
get_rest_api_3_workflows_capabilitiesGet the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories conditions, validators, actions, triggers, screens as well as the source location Atlassian-provided, Connect, Forge. Permissions permissions required: AdminworkflowId (string)
projectId (string)
issueTypeId (string)
post_rest_api_3_workflows_createCreate workflows and related statuses. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. scope
. statuses (array)
. workflows (array)
} (object) required
post_rest_api_3_workflows_create_validationValidate the payload for bulk create workflows. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. payload
. validationOptions
} (object) required
get_rest_api_3_workflows_default_editorGet the user's default workflow editor. This can be either the new editor or the legacy editor.No parameters
post_rest_api_3_workflows_previewReturns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details. Permissions permissions required: At least one of the Administer projects and View read-only workflow project permissionsdata: {
. issueTypeIds (array)
. projectId (string)
. workflowIds (array)
. workflowNames (array)
} (object) required
get_rest_api_3_workflows_searchReturns a paginated pagination list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned. Permissions permissions required: Administer Jira global permission to access all, including project-scoped, workflows At least one of the Administer projects and View read-only workflow project permissions to access project-scoped workflowsstartAt (integer)
maxResults (integer)
expand (string)
queryString (string)
orderBy (string)
scope (string)
isActive (boolean)
post_rest_api_3_workflows_updateUpdate workflows and related statuses. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. statuses (array)
. workflows (array)
} (object) required
post_rest_api_3_workflows_update_validationValidate the payload for bulk update workflows. Permissions permissions required: Administer Jira project permission to create all, including global-scoped, workflows Administer projects project permissions to create project-scoped workflowsdata: {
. payload
. validationOptions
} (object) required
get_rest_api_3_workflowschemeReturns a paginated pagination list of all workflow schemes, not including draft workflow schemes. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.startAt (integer)
maxResults (integer)
post_rest_api_3_workflowschemeCreates a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. defaultWorkflow (string)
. description (string)
. draft (boolean)
. id (integer)
. issueTypeMappings (object)
. issueTypes (object)
. lastModified (string)
. lastModifiedUser
. name (string)
. originalDefaultWorkflow (string)
. originalIssueTypeMappings (object)
. self (string)
. updateDraftIfNeeded (boolean)
} (object) required
get_rest_api_3_workflowscheme_projectReturns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned. If the project is associated with the Default Workflow Scheme no ID is returned. This is because the way the Default Workflow Scheme is stored means it has no ID. Permissions permissions required: Administer Jira global permissionhttpprojectId (array) required
put_rest_api_3_workflowscheme_projectAssigns a workflow scheme to a project. This operation is performed only when there are no issues in the project. Workflow schemes can only be assigned to classic projects. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.data: {
. projectId (string)
. workflowSchemeId (string)
} (object) required
post_rest_api_3_workflowscheme_readReturns a list of workflow schemes by providing workflow scheme IDs or project IDs. Permissions permissions required: Administer Jira global permission to access all, including project-scoped, workflow schemes Administer projects project permissions to access project-scoped workflow schemesdata: {
. projectIds (array)
. workflowSchemeIds (array)
} (object) required
post_rest_api_3_workflowscheme_updateUpdates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an asynchronous task async migrates the issues as defined in the provided mappings. Permissions permissions required: Administer Jira project permission to update all, including global-scoped, workflow schemes. Administer projects project permission to update pdata: {
. defaultWorkflowId (string)
. description (string)
. id (string)
. name (string)
. statusMappingsByIssueTypeOverride (array)
. statusMappingsByWorkflows (array)
. version
. workflowsForIssueTypes (array)
} (object) required
post_rest_api_3_workflowscheme_update_mappingsGets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both. Permissions permissions required: Administer Jira permission to update all, including global-scoped, workflow schemes. Administer projects project permission to update project-scoped workflow schemes.data: {
. defaultWorkflowId (string)
. id (string)
. workflowsForIssueTypes (array)
} (object) required
delete_rest_api_3_workflowscheme_by_idDeletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active that is, being used by at least one project. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_3_workflowscheme_by_idReturns a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
returnDraftIfExists (boolean)
put_rest_api_3_workflowscheme_by_idUpdates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active that is, being used by at least one project, then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. defaultWorkflow (string)
. description (string)
. draft (boolean)
. id (integer)
. issueTypeMappings (object)
. issueTypes (object)
. lastModified (string)
. lastModifiedUser
. name (string)
. originalDefaultWorkflow (string)
. originalIssueTypeMappings (object)
. self (string)
. updateDraftIfNeeded (boolean)
} (object) required
post_rest_api_3_workflowscheme_by_id_createdraftCreate a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
delete_rest_api_3_workflowscheme_by_id_defaultResets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow the jira workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
updateDraftIfNeeded (boolean)
get_rest_api_3_workflowscheme_by_id_defaultReturns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
returnDraftIfExists (boolean)
put_rest_api_3_workflowscheme_by_id_defaultSets the default workflow for a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_3_workflowscheme_by_id_draftDeletes a draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_3_workflowscheme_by_id_draftReturns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemeshttps://confluence.atlassian.com/x/tohKLg for more information. Note that: Only active workflow schemes can have draft workflow schemes. An activeid (integer)
put_rest_api_3_workflowscheme_by_id_draftUpdates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. defaultWorkflow (string)
. description (string)
. draft (boolean)
. id (integer)
. issueTypeMappings (object)
. issueTypes (object)
. lastModified (string)
. lastModifiedUser
. name (string)
. originalDefaultWorkflow (string)
. originalIssueTypeMappings (object)
. self (string)
. updateDraftIfNeeded (boolean)
} (object) required
delete_rest_api_3_workflowscheme_by_id_draft_defaultResets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow the jira workflow. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
get_rest_api_3_workflowscheme_by_id_draft_defaultReturns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
put_rest_api_3_workflowscheme_by_id_draft_defaultSets the default workflow for a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
data: {
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_3_workflowscheme_by_id_draft_issuetype_by_issue_typeDeletes the issue type-workflow mapping for an issue type in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
get_rest_api_3_workflowscheme_by_id_draft_issuetype_by_issue_typeReturns the issue type-workflow mapping for an issue type in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
put_rest_api_3_workflowscheme_by_id_draft_issuetype_by_issue_typeSets the workflow for an issue type in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
data: {
. issueType (string)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
post_rest_api_3_workflowscheme_by_id_draft_publishPublishes a draft workflow scheme. Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status. This operation is asynchronous async. Follow the location link in the response to determine the status of the task and use Get task api-rest-api-3-task-taskId-get to obtain updates. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4id (integer)
validateOnly (boolean)
data: {
. statusMappings (array)
} (object) required
delete_rest_api_3_workflowscheme_by_id_draft_workflowDeletes the workflow-issue type mapping for a workflow in a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string) required
get_rest_api_3_workflowscheme_by_id_draft_workflowReturns the workflow-issue type mappings for a workflow scheme's draft. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string)
put_rest_api_3_workflowscheme_by_id_draft_workflowSets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string) required
data: {
. defaultMapping (boolean)
. issueTypes (array)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_3_workflowscheme_by_id_issuetype_by_issue_typeDeletes the issue type-workflow mapping for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
updateDraftIfNeeded (boolean)
get_rest_api_3_workflowscheme_by_id_issuetype_by_issue_typeReturns the issue type-workflow mapping for an issue type in a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
returnDraftIfExists (boolean)
put_rest_api_3_workflowscheme_by_id_issuetype_by_issue_typeSets the workflow for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
issueType (string)
data: {
. issueType (string)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
delete_rest_api_3_workflowscheme_by_id_workflowDeletes the workflow-issue type mapping for a workflow in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string) required
updateDraftIfNeeded (boolean)
get_rest_api_3_workflowscheme_by_id_workflowReturns the workflow-issue type mappings for a workflow scheme. Permissions permissions required: Administer Jira global permissionhttps://confluence.atlassian.com/x/x4dKLg.id (integer)
workflowName (string)
returnDraftIfExists (boolean)
put_rest_api_3_workflowscheme_by_id_workflowSets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira. Permissions permissiid (integer)
workflowName (string) required
data: {
. defaultMapping (boolean)
. issueTypes (array)
. updateDraftIfNeeded (boolean)
. workflow (string)
} (object) required
get_rest_api_3_workflowscheme_by_workflow_scheme_id_project_usagesReturns a page of projects using a given workflow scheme.workflowSchemeId (string)
nextPageToken (string)
maxResults (integer)
get_rest_api_3_worklog_deletedReturns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs. This resource does not return worklogs delsince (integer)
post_rest_api_3_worklog_listReturns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items. Permissions permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true: the worklog is set as Viewable by All Users. the user is a member of a project role or group with permission to view the worklog.expand (string)
data: {
. ids (array)
} (object) required
get_rest_api_3_worklog_updatedReturns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs. This resource does not return worklogs updsince (integer)
expand (string)
get_rest_atlassian_connect_1_addons_by_addon_key_propertiesGets all the properties of an app. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
delete_rest_atlassian_connect_1_addons_by_addon_key_properties_by_property_keyDeletes an app's property. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
propertyKey (string)
get_rest_atlassian_connect_1_addons_by_addon_key_properties_by_property_keyReturns the key and value of an app's property. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
propertyKey (string)
put_rest_atlassian_connect_1_addons_by_addon_key_properties_by_property_keySets the value of an app's property. Use this resource to store custom data for your app. The value of the request body must be a validhttp://tools.ietf.org/html/rfc4627, non-empty JSON blob. The maximum length is 32768 characters. Permissions permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties stored against the same app.connect.key.addonKey (string)
propertyKey (string)
data (undefined) required
delete_rest_atlassian_connect_1_app_module_dynamicRemove all or a list of modules registered by the calling app. Permissions permissions required: Only Connect apps can make this request.moduleKey (array)
get_rest_atlassian_connect_1_app_module_dynamicReturns all modules registered dynamically by the calling app. Permissions permissions required: Only Connect apps can make this request.No parameters
post_rest_atlassian_connect_1_app_module_dynamicRegisters a list of modules. Permissions permissions required: Only Connect apps can make this request.data: {
. modules (array)
} (object) required
put_rest_atlassian_connect_1_migration_fieldUpdates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated. Permissions permissions required: Only Connect apps can make this requestAtlassian-Transfer-Id (string) required
data: {
. updateValueList (array)
} (object) required
put_rest_atlassian_connect_1_migration_properties_by_entity_typeUpdates 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.entityType (string)
Atlassian-Transfer-Id (string) required
data (array) required
post_rest_atlassian_connect_1_migration_workflow_rule_searchReturns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.Atlassian-Transfer-Id (string) required
data: {
. expand (string)
. ruleIds (array)
. workflowEntityId (string)
} (object) required
get_rest_atlassian_connect_1_service_registryRetrieve the attributes of given service registries. Permissions permissions required: Only Connect apps can make this request and the servicesIds belong to the tenant you are requestingserviceIds (array) required
get_rest_forge_1_app_propertiesReturns all property keys for the Forge app. Permissions permissions required: Only Forge apps can make this request. This API can only be accessed using asApphttps://developer.atlassian.com/platform/forge/apis-reference/fetch-api-product.requestjira/ method-signature requests from Forge.No parameters
delete_rest_forge_1_app_properties_by_property_keyDeletes a Forge app's property. Permissions permissions required: Only Forge apps can make this request. This API can only be accessed using asApphttps://developer.atlassian.com/platform/forge/apis-reference/fetch-api-product.requestjira/ method-signature requests from Forge. The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.propertyKey (string)
get_rest_forge_1_app_properties_by_property_keyReturns the value of a Forge app's property. Permissions permissions required: Only Forge apps can make this request. This API can only be accessed using asApphttps://developer.atlassian.com/platform/forge/apis-reference/fetch-api-product.requestjira/ method-signature requests from Forge.propertyKey (string)
put_rest_forge_1_app_properties_by_property_keySets the value of a Forge app's property. These values can be retrieved in Jira expressions/cloud/jira/platform/jira-expressions/ through the app context variable/cloud/jira/platform/jira-expressions/ context-variables. They are also available in entity property display conditions/platform/forge/manifest-reference/display-conditions/entity-property-conditions/. For other use cases, use the Storage API/platform/forge/runtime-reference/storage-api/. The value of the request body must be a validhpropertyKey (string)
data (undefined) required
post_rest_internal_api_latest_worklog_bulkReturns worklog details for a list of issue ID and worklog ID pairs. This is an internal API for bulk fetching worklogs by their issue and worklog IDs. Worklogs that don't exist will be filtered out from the response. The returned list of worklogs is limited to 1000 items. Permissions permissions required: This is an internal service-to-service API that requires ASAP authentication. No user permission checks are performed as this bypasses normal user context.data: {
. requests (array)
} (object) required