Connectors
Productivity & Project Management
Jira
Issue tracking: issues, projects, sprints, transitions, and comment updates
Jira API referenceAPI checked August 18, 2026
- Signs in with
- Username and password
- Runs on
- Cloud or On-Prem Worker
- Operations
- 617
- Ready-made triggers
- 68
Connect Jira
- In Neblex open Connect › Connections and click New Connection.
- Search for Jira and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Site (the part before .atlassian.net)Required | |
| EmailRequired | |
| API tokenRequiredSecret |
Triggers
Start a flow when something changes in Jira: add a Poll for changes trigger, choose Jira and pick the event.
| Event | What it does | How |
|---|---|---|
| New or updated group | Fires for each group that appears or changes since the last check. | Checks for changes |
| New or updated project component | Fires for each project component that appears or changes since the last check. | Checks for changes |
| New or updated dashboard | Fires for each dashboard that appears or changes since the last check. | Checks for changes |
| New or updated issue custom field options (apps) | Fires for each issue custom field options (apps) that appears or changes since the last check. | Checks for changes |
| New or updated issue type scheme | Fires for each issue type scheme that appears or changes since the last check. | Checks for changes |
| New or updated workflow scheme | Fires for each workflow scheme that appears or changes since the last check. | Checks for changes |
| New or updated issue comment | Fires for each issue comment created or changed since the last check. | Checks for changes by updated |
| New or updated issue custom field context | Fires for each issue custom field context that appears or changes since the last check. | Checks for changes |
| New or updated issue | Fires for each issue that appears or changes since the last check. | Checks for changes |
| New or updated issue custom field configuration (apps) | Fires for each issue custom field configuration (apps) that appears or changes since the last check. | Checks for changes |
| New or updated webhook | Fires for each webhook that appears or changes since the last check. | Checks for changes |
| New or updated field scheme | Fires for each field scheme that appears or changes since the last check. | Checks for changes |
| New or updated issue field configuration | Fires for each issue field configuration that appears or changes since the last check. | Checks for changes |
| New or updated issue field | Fires for each issue field that appears or changes since the last check. | Checks for changes |
| New or updated filter | Fires for each filter that appears or changes since the last check. | Checks for changes |
| New or updated issue type screen scheme | Fires for each issue type screen scheme that appears or changes since the last check. | Checks for changes |
| New or updated issue worklog | Fires for each issue worklog created or changed since the last check. | Checks for changes by updated |
| New or updated issue notification scheme | Fires for each issue notification scheme that appears or changes since the last check. | Checks for changes |
| New or updated issue custom field option | Fires for each issue custom field option that appears or changes since the last check. | Checks for changes |
| New or updated plan | Fires for each plan that appears or changes since the last check. | Checks for changes |
| New or updated jql functions (apps) | Fires for each jql functions (apps) created or changed since the last check. | Checks for changes by updated |
| New or updated priority scheme | Fires for each priority scheme that appears or changes since the last check. | Checks for changes |
| New or updated project version | Fires for each project version that appears or changes since the last check. | Checks for changes |
| New or updated screen scheme | Fires for each screen scheme that appears or changes since the last check. | Checks for changes |
| New or updated screen | Fires for each screen that appears or changes since the last check. | Checks for changes |
| New or updated issue security scheme | Fires for each issue security scheme that appears or changes since the last check. | Checks for changes |
| New or updated teams in plan | Fires for each teams in plan that appears or changes since the last check. | Checks for changes |
| New or updated ui modifications (apps) | Fires for each ui modifications (apps) that appears or changes since the last check. | Checks for changes |
| New or updated workflow | Fires for each workflow created or changed since the last check. | Checks for changes by updated |
| New or updated status | Fires for each status that appears or changes since the last check. | Checks for changes |
| New or updated issue search | Fires for each issue search that appears or changes since the last check. | Checks for changes |
| New or updated issue priority | Fires for each issue priority that appears or changes since the last check. | Checks for changes |
| New or updated project | Fires for each project that appears or changes since the last check. | Checks for changes |
| New or updated issue resolution | Fires for each issue resolution that appears or changes since the last check. | Checks for changes |
| New group | Fires for each group that appears since the last check. | Checks for changes |
| New project component | Fires for each project component that appears since the last check. | Checks for changes |
| New dashboard | Fires for each dashboard that appears since the last check. | Checks for changes |
| New issue custom field options (apps) | Fires for each issue custom field options (apps) that appears since the last check. | Checks for changes |
| New issue type scheme | Fires for each issue type scheme that appears since the last check. | Checks for changes |
| New workflow scheme | Fires for each workflow scheme that appears since the last check. | Checks for changes |
| New issue comment | Fires for each issue comment created since the last check. | Checks for changes by created |
| New issue custom field context | Fires for each issue custom field context that appears since the last check. | Checks for changes |
| New issue | Fires for each issue that appears since the last check. | Checks for changes |
| New issue custom field configuration (apps) | Fires for each issue custom field configuration (apps) that appears since the last check. | Checks for changes |
| New webhook | Fires for each webhook that appears since the last check. | Checks for changes |
| New field scheme | Fires for each field scheme that appears since the last check. | Checks for changes |
| New issue field configuration | Fires for each issue field configuration that appears since the last check. | Checks for changes |
| New issue field | Fires for each issue field that appears since the last check. | Checks for changes |
| New filter | Fires for each filter that appears since the last check. | Checks for changes |
| New issue type screen scheme | Fires for each issue type screen scheme that appears since the last check. | Checks for changes |
| New issue worklog | Fires for each issue worklog created since the last check. | Checks for changes by created |
| New issue notification scheme | Fires for each issue notification scheme that appears since the last check. | Checks for changes |
| New issue custom field option | Fires for each issue custom field option that appears since the last check. | Checks for changes |
| New plan | Fires for each plan that appears since the last check. | Checks for changes |
| New jql functions (apps) | Fires for each jql functions (apps) created since the last check. | Checks for changes by created |
| New priority scheme | Fires for each priority scheme that appears since the last check. | Checks for changes |
| New project version | Fires for each project version that appears since the last check. | Checks for changes |
| New screen scheme | Fires for each screen scheme that appears since the last check. | Checks for changes |
| New screen | Fires for each screen that appears since the last check. | Checks for changes |
| New issue security scheme | Fires for each issue security scheme that appears since the last check. | Checks for changes |
| New teams in plan | Fires for each teams in plan that appears since the last check. | Checks for changes |
| New ui modifications (apps) | Fires for each ui modifications (apps) that appears since the last check. | Checks for changes |
| New workflow | Fires for each workflow created since the last check. | Checks for changes by created |
| New status | Fires for each status that appears since the last check. | Checks for changes |
| New issue search | Fires for each issue search that appears since the last check. | Checks for changes |
| New issue priority | Fires for each issue priority that appears since the last check. | Checks for changes |
| New project | Fires for each project that appears since the last check. | Checks for changes |
| New issue resolution | Fires for each issue resolution that appears since the last check. | Checks for changes |
Use it in a flow
- Open a flow, open the node library and search for Jira.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
617 operations in 99 groups. Each one is a step you can add to a flow.
Announcement Banner2
Get announcement banner configurationgetBanner | GET | Returns the current announcement banner configuration. |
Update announcement banner configurationsetBanner | PUT | Updates the announcement banner configuration. |
App Data Policy2
Get data policy for projectsgetPolicies | GET | Returns data policies for the projects specified in the request. |
Get data policy for the workspacegetPolicy | GET | Returns data policy for the workspace. |
App Migration3
Bulk update custom field valueAppIssueFieldValueUpdateResource_updateIssueFields_put | PUT | Updates the value of a custom field added by Connect apps on one or more issues. |
Bulk update entity propertiesMigrationResource_updateEntityPropertiesValue_put | PUT | Updates the values of multiple entity properties for an object, up to 50 updates per request. |
Get workflow transition rule configurationsMigrationResource_workflowRuleSearch_post | POST | Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app. |
App Property8
Delete app propertyAddonPropertiesResource_deleteAddonProperty_delete | DELETE | Deletes an app's property. |
Delete app property (Forge)deleteForgeAppProperty | DELETE | Deletes a Forge app's property. |
Get app propertiesAddonPropertiesResource_getAddonProperties_get | GET | Gets all the properties of an app. |
Get app propertyAddonPropertiesResource_getAddonProperty_get | GET | Returns the key and value of an app's property. |
Get app property (Forge)getForgeAppProperty | GET | Returns the value of a Forge app's property. |
Get app property keys (Forge)getForgeAppPropertyKeys | GET | Returns all property keys for the Forge app. |
Set app propertyAddonPropertiesResource_putAddonProperty_put | PUT | Sets the value of an app's property. |
Set app property (Forge)putForgeAppProperty | PUT | Sets the value of a Forge app's property. |
Application Role2
Get all application rolesgetAllApplicationRoles | GET | Returns all application roles. |
Get application rolegetApplicationRole | GET | Returns an application role. |
Audit Record1
Get audit recordsgetAuditRecords | GET | Returns a list of audit records. |
Avatar7
Delete avatardeleteAvatar | DELETE | Deletes an avatar from a project, issue type or priority. |
Get avatar image by IDgetAvatarImageByID | GET | Returns a project, issue type or priority avatar image by ID. |
Get avatar image by ownergetAvatarImageByOwner | GET | Returns the avatar image for a project, issue type or priority. |
Get avatar image by typegetAvatarImageByType | GET | Returns the default project, issue type or priority avatar image. |
Get avatarsgetAvatars | GET | Returns the system and custom avatars for a project, issue type or priority. |
Get system avatars by typegetAllSystemAvatars | GET | Returns a list of system avatar details by owner type, where the owner types are issue type, project, user or priority. |
Load avatarstoreAvatar | POST | Loads a custom avatar for a project, issue type or priority. |
Classification Level1
Get all classification levelsgetAllUserDataClassificationLevels | GET | Returns all classification levels. |
Dashboard17
Add gadget to dashboardaddGadget | POST | Adds a gadget to a dashboard. |
Bulk edit dashboardsbulkEditDashboards | PUT | Bulk edit dashboards. |
Copy dashboardcopyDashboard | POST | Copies a dashboard. |
Create dashboardcreateDashboard | POST | Creates a dashboard. |
Delete dashboarddeleteDashboard | DELETE | Deletes a dashboard. |
Delete dashboard item propertydeleteDashboardItemProperty | DELETE | Deletes a dashboard item property. |
Get all dashboardsgetAllDashboards | GET | Returns a list of dashboards owned by or shared with the user. |
Get available gadgetsgetAllAvailableDashboardGadgets | GET | Gets a list of all available gadgets that can be added to all dashboards. |
Get dashboardgetDashboard | GET | Returns a dashboard. |
Get dashboard item propertygetDashboardItemProperty | GET | Returns the key and value of a dashboard item property. |
Get dashboard item property keysgetDashboardItemPropertyKeys | GET | Returns the keys of all properties for a dashboard item. |
Get gadgetsgetAllGadgets | GET | Returns a list of dashboard gadgets on a dashboard. |
Remove gadget from dashboardremoveGadget | DELETE | Removes a dashboard gadget from a dashboard. |
Search for dashboardsgetDashboardsPaginated | GET | Returns a paginated list of dashboards. |
Set dashboard item propertysetDashboardItemProperty | PUT | Sets the value of a dashboard item property. |
Update dashboardupdateDashboard | PUT | Updates a dashboard, replacing all the dashboard details with those provided. |
Update gadget on dashboardupdateGadget | PUT | Changes the title, position, and color of the gadget on a dashboard. |
Dynamic Module3
Get modulesDynamicModulesResource_getModules_get | GET | Returns all modules registered dynamically by the calling app. |
Register modulesDynamicModulesResource_registerModules_post | POST | Registers a list of modules. |
Remove modulesDynamicModulesResource_removeModules_delete | DELETE | Remove all or a list of modules registered by the calling app. |
Field Scheme15
Associate projects to field schemesassociateProjectsToFieldAssociationSchemes | PUT | Associate projects to field association schemes. |
Clone field schemecloneFieldAssociationScheme | POST | Endpoint for cloning an existing field association scheme into a new one. |
Create field schemecreateFieldAssociationScheme | POST | Endpoint for creating a new field association scheme. |
Delete a field schemedeleteFieldAssociationScheme | DELETE | Delete a specified field association scheme |
Get field parametersgetFieldAssociationSchemeItemParameters | GET | Retrieve field association parameters on a field association scheme |
Get field schemegetFieldAssociationSchemeById | GET | Endpoint for fetching a field association scheme by its ID |
Get field schemesgetFieldAssociationSchemes | GET | REST endpoint for retrieving a paginated list of field association schemes with optional filtering. |
Get projects with field schemesgetProjectsWithFieldSchemes | GET | Get projects with field association schemes. |
Remove field parametersremoveFieldAssociationSchemeItemParameters | DELETE | Remove field association parameters overrides for work types. |
Remove fields associated with field schemesremoveFieldsAssociatedWithSchemes | DELETE | Remove fields associated with field association schemes. |
Search field scheme fieldssearchFieldAssociationSchemeFields | GET | Search for fields belonging to a given field association scheme. |
Search field scheme projectssearchFieldAssociationSchemeProjects | GET | REST Endpoint for searching for projects belonging to a given field association scheme |
Update field parametersupdateFieldAssociationSchemeItemParameters | PUT | Update field association item parameters in field association schemes. |
Update field schemeupdateFieldAssociationScheme | PUT | Endpoint for updating an existing field association scheme. |
Update fields associated with field schemesupdateFieldsAssociatedWithSchemes | PUT | Update fields associated with field association schemes. |
Filter13
Add filter as favoritesetFavouriteForFilter | PUT | Add a filter as a favorite for the user. |
Change filter ownerchangeFilterOwner | PUT | Changes the owner of the filter. |
Create filtercreateFilter | POST | Creates a filter. |
Delete filterdeleteFilter | DELETE | Delete a filter. |
Get columnsgetColumns | GET | Returns the columns configured for a filter. |
Get favorite filtersgetFavouriteFilters | GET | Returns the visible favorite filters of the user. |
Get filtergetFilter | GET | Returns a filter. |
Get my filtersgetMyFilters | GET | Returns the filters owned by the user. |
Remove filter as favoritedeleteFavouriteForFilter | DELETE | Removes a filter as a favorite for the user. |
Reset columnsresetColumns | DELETE | Reset the user's column configuration for the filter to the default. |
Search for filtersgetFiltersPaginated | GET | Returns a paginated list of filters. |
Set columnssetColumns | PUT | Sets the columns for a filter. |
Update filterupdateFilter | PUT | Updates a filter. |
Filter Sharing6
Add share permissionaddSharePermission | POST | Add a share permissions to a filter. |
Delete share permissiondeleteSharePermission | DELETE | Deletes a share permission from a filter. |
Get default share scopegetDefaultShareScope | GET | Returns the default sharing settings for new filters and dashboards for a user. |
Get share permissiongetSharePermission | GET | Returns a share permission for a filter. |
Get share permissionsgetSharePermissions | GET | Returns the share permissions for a filter. |
Set default share scopesetDefaultShareScope | PUT | Sets the default sharing for new filters and dashboards for a user. |
Group8
Add user to groupaddUserToGroup | POST | Adds a user to a group. |
Bulk get groupsbulkGetGroups | GET | Returns a paginated list of groups. |
Create groupcreateGroup | POST | Creates a group. |
Find groupsfindGroups | GET | Returns a list of groups whose names contain a query string. |
Get groupgetGroup | GET | This operation is deprecated, use group/member. |
Get users from groupgetUsersFromGroup | GET | Returns a paginated list of all users in a group. |
Remove groupremoveGroup | DELETE | Deletes a group. |
Remove user from groupremoveUserFromGroup | DELETE | Removes a user from a group. |
Group And User Picker1
Find users and groupsfindUsersAndGroups | GET | Returns a list of users and groups matching a string. |
Issue24
Archive issue(s) by issue ID/keyarchiveIssues | PUT | Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any. |
Archive issue(s) by JQLarchiveIssuesAsync | POST | Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request. |
Assign issueassignIssue | PUT | Assigns an issue to a user. |
Bulk create issuecreateIssues | POST | Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. |
Bulk fetch changelogsgetBulkChangelogs | POST | Bulk fetch changelogs for multiple issues and filter by fields |
Bulk fetch issuesbulkFetchIssues | POST | Returns the details for a set of requested issues. |
Create issuecreateIssue | POST | Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. |
Delete issuedeleteIssue | DELETE | Deletes an issue. |
Edit issueeditIssue | PUT | Edits an issue. |
Export archived issue(s)exportArchivedIssues | PUT | Enables admins to retrieve details of all archived issues. |
Get changelogsgetChangeLogs | GET | Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest. |
Get changelogs by IDsgetChangeLogsByIds | POST | Returns changelogs for an issue specified by a list of changelog IDs. |
Get create field metadata for a project and issue type idgetCreateIssueMetaIssueTypeId | GET | Returns a page of field metadata for a specified project and issuetype id. |
Get create issue metadatagetCreateIssueMeta | GET | Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. |
Get create metadata issue types for a projectgetCreateIssueMetaIssueTypes | GET | Returns a page of issue type metadata for a specified project. |
Get edit issue metadatagetEditIssueMeta | GET | Returns the edit screen fields for an issue that are visible to and editable by the user. |
Get eventsgetEvents | GET | Returns all issue events. |
Get issuegetIssue | GET | Returns the details for an issue. |
Get issue adf limit reportgetIssueAdfLimitReport | GET | Returns all issues whose ADF (rich text) field data breaches the universal ADF size limit. |
Get issue limit reportgetIssueLimitReport | GET | Returns all issues breaching and approaching per-issue limits. |
Get transitionsgetTransitions | GET | Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status. |
Send notification for issuenotify | POST | Creates an email notification for an issue and adds it to the mail queue. |
Transition issuedoTransition | POST | Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen. |
Unarchive issue(s) by issue keys/IDunarchiveIssues | PUT | Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any. |
Issue Attachment8
Add attachmentaddAttachment | POST | Adds one or more attachments to an issue. |
Delete attachmentremoveAttachment | DELETE | Deletes an attachment from an issue. |
Get all metadata for an expanded attachmentexpandAttachmentForHumans | GET | Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. |
Get attachment contentgetAttachmentContent | GET | Returns the contents of an attachment. |
Get attachment metadatagetAttachment | GET | Returns the metadata for an attachment. |
Get attachment thumbnailgetAttachmentThumbnail | GET | Returns the thumbnail of an attachment. |
Get contents metadata for an expanded attachmentexpandAttachmentForMachines | GET | Returns the metadata for the contents of an attachment, if it is an archive. |
Get Jira attachment settingsgetAttachmentMeta | GET | Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. |
Issue Bulk Operation9
Bulk delete issuessubmitBulkDelete | POST | Use this API to submit a bulk delete request. |
Bulk edit issuessubmitBulkEdit | POST | Use this API to submit a bulk edit request and simultaneously edit multiple issues. |
Bulk move issuessubmitBulkMove | POST | Use this API to submit a bulk issue move request. |
Bulk transition issue statusessubmitBulkTransition | POST | Use this API to submit a bulk issue status transition request. |
Bulk unwatch issuessubmitBulkUnwatch | POST | Use this API to submit a bulk unwatch request. |
Bulk watch issuessubmitBulkWatch | POST | Use this API to submit a bulk watch request. |
Get available transitionsgetAvailableTransitions | GET | Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk transition operations. |
Get bulk editable fieldsgetBulkEditableFields | GET | Use this API to get a list of fields visible to the user to perform bulk edit operations. |
Get bulk issue operation progressgetBulkOperationProgress | GET | Use this to get the progress state for the specified bulk operation taskId. |
Issue Comment6
Add commentaddComment | POST | Adds a comment to an issue. |
Delete commentdeleteComment | DELETE | Deletes a comment. |
Get commentgetComment | GET | Returns a comment. |
Get commentsgetComments | GET | Returns all comments for an issue. |
Get comments by IDsgetCommentsByIds | POST | Returns a paginated list of comments specified by a list of comment IDs. |
Update commentupdateComment | PUT | Updates a comment. |
Issue Comment Property4
Delete comment propertydeleteCommentProperty | DELETE | Deletes a comment property. |
Get comment propertygetCommentProperty | GET | Returns the value of a comment property. |
Get comment property keysgetCommentPropertyKeys | GET | Returns the keys of all the properties of a comment. |
Set comment propertysetCommentProperty | PUT | Creates or updates the value of a property for a comment. |
Issue Custom Field Association2
Create associationscreateAssociations | PUT | Associates fields with projects. |
Remove associationsremoveAssociations | DELETE | Unassociates a set of fields with a project and issue type context. |
Issue Custom Field Configuration (apps)3
Bulk get custom field configurationsgetCustomFieldsConfigurations | POST | Returns a paginated list of configurations for list of custom fields of a type created by a Forge app. |
Get custom field configurationsgetCustomFieldConfiguration | GET | Returns a paginated list of configurations for a custom field of a type created by a Forge app. |
Update custom field configurationsupdateCustomFieldConfiguration | PUT | Update the configuration for contexts of a custom field of a type created by a Forge app. |
Issue Custom Field Context14
Add issue types to contextaddIssueTypesToContext | PUT | Adds issue types to a custom field context, appending the issue types to the issue types list. |
Assign custom field context to projectsassignProjectsToCustomFieldContext | PUT | Assigns a custom field context to projects. |
Create custom field contextcreateCustomFieldContext | POST | Creates a custom field context. |
Delete custom field contextdeleteCustomFieldContext | DELETE | Deletes a custom field context. |
Get custom field contextsgetContextsForField | GET | Returns a paginated list of contexts for a custom field. |
Get custom field contexts default valuesgetDefaultValues | GET | Returns a paginated list of defaults for a custom field. |
Get custom field contexts for projects and issue typesgetCustomFieldContextsForProjectsAndIssueTypes | POST | Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type. |
Get default values for a custom field grouped by context andgetContextDefaultValues | GET | Returns a paginated list of default values grouped by custom field context. |
Get issue types for custom field contextgetIssueTypeMappingsForContexts | GET | Returns a paginated list of context to issue type mappings for a custom field. |
Get project mappings for custom field contextgetProjectContextMapping | GET | Returns a paginated list of context to project mappings for a custom field. |
Remove custom field context from projectsremoveCustomFieldContextFromProjects | POST | Removes a custom field context from projects. |
Remove issue types from contextremoveIssueTypesFromContext | POST | Removes issue types from a custom field context. |
Set custom field contexts default valuessetDefaultValues | PUT | Sets default for contexts of a custom field. |
Update custom field contextupdateCustomFieldContext | PUT | Updates a custom field context. |
Issue Custom Field Option7
Create custom field options (context)createCustomFieldOption | POST | Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. |
Delete custom field options (context)deleteCustomFieldOption | DELETE | Deletes a custom field option. |
Get custom field optiongetCustomFieldOption | GET | Returns a custom field option. |
Get custom field options (context)getOptionsForContext | GET | Returns a paginated list of all custom field option for a context. |
Reorder custom field options (context)reorderCustomFieldOptions | PUT | Changes the order of custom field options or cascading options in a context. |
Replace custom field optionsreplaceCustomFieldOption | DELETE | Replaces the options of a custom field. |
Update custom field options (context)updateCustomFieldOption | PUT | Updates the options of a custom field. |
Issue Custom Field Options (apps)8
Create issue field optioncreateIssueFieldOption | POST | Creates an option for a select list issue field. |
Delete issue field optiondeleteIssueFieldOption | DELETE | Deletes an option from a select list issue field. |
Get all issue field optionsgetAllIssueFieldOptions | GET | Returns a paginated list of all the options of a select list issue field. |
Get issue field optiongetIssueFieldOption | GET | Returns an option from a select list issue field. |
Get selectable issue field optionsgetSelectableIssueFieldOptions | GET | Returns a paginated list of options for a select list issue field that can be viewed and selected by the user. |
Get visible issue field optionsgetVisibleIssueFieldOptions | GET | Returns a paginated list of options for a select list issue field that can be viewed by the user. |
Replace issue field optionreplaceIssueFieldOption | DELETE | Deselects an issue-field select-list option from all issues where it is selected. |
Update issue field optionupdateIssueFieldOption | PUT | Updates or creates an option for a select list issue field. |
Issue Custom Field Values (apps)2
Update custom field valueupdateCustomFieldValue | PUT | Updates the value of a custom field on one or more issues. |
Update custom fieldsupdateMultipleCustomFieldValues | POST | Updates the value of one or more custom fields on one or more issues. |
Issue Field11
Create custom fieldcreateCustomField | POST | Creates a custom field. |
Delete custom fielddeleteCustomField | DELETE | Deletes a custom field. |
Get contexts for a fieldgetContextsForFieldDeprecated | GET | Returns a paginated list of the contexts a field is used in. |
Get field project associationsgetFieldProjectAssociations | GET | Returns a paginated list of project associations for the given custom field. |
Get fieldsgetFields | GET | Returns system and custom issue fields according to the following rules: |
Get fields for projectsgetProjectFields | GET | Returns a paginated list of fields for the requested projects and work types. |
Get fields in trash paginatedgetTrashedFieldsPaginated | GET | Returns a paginated list of fields in the trash. |
Get fields paginatedgetFieldsPaginated | GET | Returns a paginated list of fields for Classic Jira projects. |
Move custom field to trashtrashCustomField | POST | Moves a custom field to trash. |
Restore custom field from trashrestoreCustomField | POST | Restores a custom field from trash. |
Update custom fieldupdateCustomField | PUT | Updates a custom field. |
Issue Field Configuration15
Assign field configuration scheme to projectassignFieldConfigurationSchemeToProject | PUT | Deprecated, use Field schemes which supports field association schemes. |
Assign issue types to field configurationssetFieldConfigurationSchemeMapping | PUT | Deprecated, use Field schemes which supports field association schemes. |
Create field configurationcreateFieldConfiguration | POST | Deprecated, use Field schemes which supports field association schemes. |
Create field configuration schemecreateFieldConfigurationScheme | POST | Deprecated, use Field schemes which supports field association schemes. |
Delete field configurationdeleteFieldConfiguration | DELETE | Deprecated, use Field schemes which supports field association schemes. |
Delete field configuration schemedeleteFieldConfigurationScheme | DELETE | Deprecated, use Field schemes which supports field association schemes. |
Get all field configuration schemesgetAllFieldConfigurationSchemes | GET | Deprecated, use Field schemes which supports field association schemes. |
Get all field configurationsgetAllFieldConfigurations | GET | Deprecated, use Field schemes which supports field association schemes. |
Get field configuration issue type itemsgetFieldConfigurationSchemeMappings | GET | Deprecated, use Field schemes which supports field association schemes. |
Get field configuration itemsgetFieldConfigurationItems | GET | Deprecated, use Field schemes which supports field association schemes. |
Get field configuration schemes for projectsgetFieldConfigurationSchemeProjectMapping | GET | Deprecated, use Field schemes which supports field association schemes. |
Remove issue types from field configuration schemeremoveIssueTypesFromGlobalFieldConfigurationScheme | POST | Deprecated, use Field schemes which supports field association schemes. |
Update field configurationupdateFieldConfiguration | PUT | Deprecated, use Field schemes which supports field association schemes. |
Update field configuration itemsupdateFieldConfigurationItems | PUT | Deprecated, use Field schemes which supports field association schemes. |
Update field configuration schemeupdateFieldConfigurationScheme | PUT | Deprecated, use Field schemes which supports field association schemes. |
Issue Link3
Create issue linklinkIssues | POST | Creates a link between two issues. |
Delete issue linkdeleteIssueLink | DELETE | Deletes an issue link. |
Get issue linkgetIssueLink | GET | Returns an issue link. |
Issue Link Type5
Create issue link typecreateIssueLinkType | POST | Creates an issue link type. |
Delete issue link typedeleteIssueLinkType | DELETE | Deletes an issue link type. |
Get issue link typegetIssueLinkType | GET | Returns an issue link type. |
Get issue link typesgetIssueLinkTypes | GET | Returns a list of all issue link types. |
Update issue link typeupdateIssueLinkType | PUT | Updates an issue link type. |
Issue Navigator Setting2
Get issue navigator default columnsgetIssueNavigatorDefaultColumns | GET | Returns the default issue navigator columns. |
Set issue navigator default columnssetIssueNavigatorDefaultColumns | PUT | Sets the default issue navigator columns. |
Issue Notification Scheme8
Add notifications to notification schemeaddNotifications | PUT | Adds notifications to a notification scheme. |
Create notification schemecreateNotificationScheme | POST | Creates a notification scheme with notifications. |
Delete notification schemedeleteNotificationScheme | DELETE | Deletes a notification scheme. |
Get notification schemegetNotificationScheme | GET | Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events. |
Get notification schemes paginatedgetNotificationSchemes | GET | Returns a paginated list of notification schemes ordered by the display name. |
Get projects using notification schemes paginatedgetNotificationSchemeToProjectMappings | GET | Returns a paginated mapping of project that have notification scheme assigned. |
Remove notification from notification schemeremoveNotificationFromNotificationScheme | DELETE | Removes a notification from a notification scheme. |
Update notification schemeupdateNotificationScheme | PUT | Updates a notification scheme. |
Issue Panel1
Bulk pin or unpin issue panel to projectsbulkPinUnpinProjectsAsync | POST | Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects. |
Issue Priority8
Create prioritycreatePriority | POST | Creates an issue priority. |
Delete prioritydeletePriority | DELETE | Deletes an issue priority. |
Get prioritiesgetPriorities | GET | Returns the list of all issue priorities. |
Get prioritygetPriority | GET | Returns an issue priority. |
Move prioritiesmovePriorities | PUT | Changes the order of issue priorities. |
Search prioritiessearchPriorities | GET | Returns a paginated list of priorities. |
Set default prioritysetDefaultPriority | PUT | Sets default issue priority. |
Update priorityupdatePriority | PUT | Updates an issue priority. |
Issue Property8
Bulk delete issue propertybulkDeleteIssueProperty | DELETE | Deletes a property value from multiple issues. |
Bulk set issue properties by issuebulkSetIssuePropertiesByIssue | POST | Sets or updates entity property values on issues. |
Bulk set issue propertybulkSetIssueProperty | PUT | Sets a property value on multiple issues. |
Bulk set issues properties by listbulkSetIssuesPropertiesList | POST | Sets or updates a list of entity property values on issues. |
Delete issue propertydeleteIssueProperty | DELETE | Deletes an issue's property. |
Get issue propertygetIssueProperty | GET | Returns the key and value of an issue's property. |
Get issue property keysgetIssuePropertyKeys | GET | Returns the URLs and keys of an issue's properties. |
Set issue propertysetIssueProperty | PUT | Sets the value of an issue's property. |
Issue Redaction2
Get redaction statusgetRedactionStatus | GET | Retrieves the current status of a redaction job ID. |
Redactredact | POST | Submit a job to redact issue field data. |
Issue Remote Link6
Create or update remote issue linkcreateOrUpdateRemoteIssueLink | POST | Creates or updates a remote issue link for an issue. |
Delete remote issue link by global IDdeleteRemoteIssueLinkByGlobalId | DELETE | Deletes the remote issue link from the issue using the link's global ID. |
Delete remote issue link by IDdeleteRemoteIssueLinkById | DELETE | Deletes a remote issue link from an issue. |
Get remote issue link by IDgetRemoteIssueLinkById | GET | Returns a remote issue link for an issue. |
Get remote issue linksgetRemoteIssueLinks | GET | Returns the remote issue links for an issue. |
Update remote issue link by IDupdateRemoteIssueLink | PUT | Updates a remote issue link for an issue. |
Issue Resolution8
Create resolutioncreateResolution | POST | Creates an issue resolution. |
Delete resolutiondeleteResolution | DELETE | Deletes an issue resolution. |
Get resolutiongetResolution | GET | Returns an issue resolution value. |
Get resolutionsgetResolutions | GET | Returns a list of all issue resolution values. |
Move resolutionsmoveResolutions | PUT | Changes the order of issue resolutions. |
Search resolutionssearchResolutions | GET | Returns a paginated list of resolutions. |
Set default resolutionsetDefaultResolution | PUT | Sets default issue resolution. |
Update resolutionupdateResolution | PUT | Updates an issue resolution. |
Issue Search7
Check issues against JQLmatchIssues | POST | Checks whether one or more issues would be returned by one or more JQL queries. |
Count issues using JQLcountIssues | POST | Provide an estimated count of the issues that match the JQL. |
Currently being removed. Search for issues using JQL (GET)searchForIssuesUsingJql | GET | Endpoint is currently being removed. |
Currently being removed. Search for issues using JQL (POST)searchForIssuesUsingJqlPost | POST | Endpoint is currently being removed. |
Get issue picker suggestionsgetIssuePickerResource | GET | Returns lists of issues matching a query string. |
Search for issues using JQL enhanced search (GET)searchAndReconsileIssuesUsingJql | GET | Searches for issues using JQL. |
Search for issues using JQL enhanced search (POST)searchAndReconsileIssuesUsingJqlPost | POST | Searches for issues using JQL. |
Issue Security Level2
Get issue security levelgetIssueSecurityLevel | GET | Returns details of an issue security level. |
Get issue security level members by issue security schemegetIssueSecurityLevelMembers | GET | Returns issue security level members. |
Issue Security Scheme16
Add issue security level membersaddSecurityLevelMembers | PUT | Adds members to the issue security level. |
Add issue security levelsaddSecurityLevel | PUT | Adds levels and levels' members to the issue security scheme. |
Associate security scheme to projectassociateSchemesToProjects | PUT | Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided. |
Create issue security schemecreateIssueSecurityScheme | POST | Creates a security scheme with security scheme levels and levels' members. |
Delete issue security schemedeleteSecurityScheme | DELETE | Deletes an issue security scheme. |
Get issue security level membersgetSecurityLevelMembers | GET | Returns a paginated list of issue security level members. |
Get issue security levelsgetSecurityLevels | GET | Returns a paginated list of issue security levels. |
Get issue security schemegetIssueSecurityScheme | GET | Returns an issue security scheme along with its security levels. |
Get issue security schemesgetIssueSecuritySchemes | GET | Returns all issue security schemes. |
Get projects using issue security schemessearchProjectsUsingSecuritySchemes | GET | Returns a paginated mapping of projects that are using security schemes. |
Remove issue security levelremoveLevel | DELETE | Deletes an issue security level. |
Remove member from issue security levelremoveMemberFromSecurityLevel | DELETE | Removes an issue security level member from an issue security scheme. |
Search issue security schemessearchSecuritySchemes | GET | Returns a paginated list of issue security schemes. |
Set default issue security levelssetDefaultLevels | PUT | Sets default issue security levels for schemes. |
Update issue security levelupdateSecurityLevel | PUT | Updates the issue security level. |
Update issue security schemeupdateIssueSecurityScheme | PUT | Updates the issue security scheme. |
Issue Type8
Create issue typecreateIssueType | POST | Creates an issue type. |
Delete issue typedeleteIssueType | DELETE | Deletes the issue type. |
Get all issue types for usergetIssueAllTypes | GET | Returns all issue types. |
Get alternative issue typesgetAlternativeIssueTypes | GET | Returns a list of issue types that can be used to replace the issue type. |
Get issue typegetIssueType | GET | Returns an issue type. |
Get issue types for projectgetIssueTypesForProject | GET | Returns issue types for a project. |
Load issue type avatarcreateIssueTypeAvatar | POST | Loads an avatar for the issue type. |
Update issue typeupdateIssueType | PUT | Updates the issue type. |
Issue Type Property4
Delete issue type propertydeleteIssueTypeProperty | DELETE | Deletes the issue type property. |
Get issue type propertygetIssueTypeProperty | GET | Returns the key and value of the issue type property. |
Get issue type property keysgetIssueTypePropertyKeys | GET | Returns all the issue type property keys of the issue type. |
Set issue type propertysetIssueTypeProperty | PUT | Creates or updates the value of the issue type property. |
Issue Type Scheme10
Add issue types to issue type schemeaddIssueTypesToIssueTypeScheme | PUT | Adds issue types to an issue type scheme. |
Assign issue type scheme to projectassignIssueTypeSchemeToProject | PUT | Assigns an issue type scheme to a project. |
Change order of issue typesreorderIssueTypesInIssueTypeScheme | PUT | Changes the order of issue types in an issue type scheme. |
Create issue type schemecreateIssueTypeScheme | POST | Creates an issue type scheme. |
Delete issue type schemedeleteIssueTypeScheme | DELETE | Deletes an issue type scheme. |
Get all issue type schemesgetAllIssueTypeSchemes | GET | Returns a paginated list of issue type schemes. |
Get issue type scheme itemsgetIssueTypeSchemesMapping | GET | Returns a paginated list of issue type scheme items. |
Get issue type schemes for projectsgetIssueTypeSchemeForProjects | GET | Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it. |
Remove issue type from issue type schemeremoveIssueTypeFromIssueTypeScheme | DELETE | Removes an issue type from an issue type scheme. |
Update issue type schemeupdateIssueTypeScheme | PUT | Updates an issue type scheme. |
Issue Type Screen Scheme11
Append mappings to issue type screen schemeappendMappingsForIssueTypeScreenScheme | PUT | Appends issue type to screen scheme mappings to an issue type screen scheme. |
Assign issue type screen scheme to projectassignIssueTypeScreenSchemeToProject | PUT | Assigns an issue type screen scheme to a project. |
Create issue type screen schemecreateIssueTypeScreenScheme | POST | Creates an issue type screen scheme. |
Delete issue type screen schemedeleteIssueTypeScreenScheme | DELETE | Deletes an issue type screen scheme. |
Get issue type screen scheme itemsgetIssueTypeScreenSchemeMappings | GET | Returns a paginated list of issue type screen scheme items. |
Get issue type screen scheme projectsgetProjectsForIssueTypeScreenScheme | GET | Returns a paginated list of projects associated with an issue type screen scheme. |
Get issue type screen schemesgetIssueTypeScreenSchemes | GET | Returns a paginated list of issue type screen schemes. |
Get issue type screen schemes for projectsgetIssueTypeScreenSchemeProjectAssociations | GET | Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it. |
Remove mappings from issue type screen schemeremoveMappingsFromIssueTypeScreenScheme | POST | Removes issue type to screen scheme mappings from an issue type screen scheme. |
Update issue type screen schemeupdateIssueTypeScreenScheme | PUT | Updates an issue type screen scheme. |
Update issue type screen scheme default screen schemeupdateDefaultScreenScheme | PUT | Updates the default screen scheme of an issue type screen scheme. |
Issue Vote3
Add voteaddVote | POST | Adds the user's vote to an issue. |
Delete voteremoveVote | DELETE | Deletes a user's vote from an issue. |
Get votesgetVotes | GET | Returns details about the votes on an issue. |
Issue Watcher4
Add watcheraddWatcher | POST | Adds a user as a watcher of an issue by passing the account ID of the user. |
Delete watcherremoveWatcher | DELETE | Deletes a user as a watcher of an issue. |
Get is watching issue bulkgetIsWatchingIssueBulk | POST | Returns, for the user, details of the watched status of issues from a list. |
Get issue watchersgetIssueWatchers | GET | Returns the watchers for an issue. |
Issue Worklog10
Add worklogaddWorklog | POST | Adds a worklog to an issue. |
Bulk delete worklogsbulkDeleteWorklogs | DELETE | Deletes a list of worklogs from an issue. |
Bulk move worklogsbulkMoveWorklogs | POST | Moves a list of worklogs from one issue to another. |
Delete worklogdeleteWorklog | DELETE | Deletes a worklog from an issue. |
Get IDs of deleted worklogsgetIdsOfWorklogsDeletedSince | GET | Returns a list of IDs and delete timestamps for worklogs deleted after a date and time. |
Get IDs of updated worklogsgetIdsOfWorklogsModifiedSince | GET | Returns a list of IDs and update timestamps for worklogs updated after a date and time. |
Get issue worklogsgetIssueWorklog | GET | Returns worklogs for an issue (ordered by created time), starting from the oldest worklog or from the worklog started on or after a date and time. |
Get workloggetWorklog | GET | Returns a worklog. |
Get worklogsgetWorklogsForIds | POST | Returns worklog details for a list of worklog IDs. |
Update worklogupdateWorklog | PUT | Updates a worklog. |
Issue Worklog Property4
Delete worklog propertydeleteWorklogProperty | DELETE | Deletes a worklog property. |
Get worklog propertygetWorklogProperty | GET | Returns the value of a worklog property. |
Get worklog property keysgetWorklogPropertyKeys | GET | Returns the keys of all properties for a worklog. |
Set worklog propertysetWorklogProperty | PUT | Sets the value of a worklog property. |
Jira Expression3
Analyse Jira expressionanalyseExpression | POST | Analyses and validates Jira expressions. |
Currently being removed. Evaluate Jira expressionevaluateJiraExpression | POST | Endpoint is currently being removed. |
Evaluate Jira expression using enhanced search APIevaluateJSISJiraExpression | POST | Evaluates a Jira expression and returns its value. |
Jira Setting4
Get advanced settingsgetAdvancedSettings | GET | Returns the application properties that are accessible on the Advanced Settings page. |
Get application propertygetApplicationProperty | GET | Returns all application properties or an application property. |
Get global settingsgetConfiguration | GET | Returns the global settings in Jira. |
Set application propertysetApplicationProperty | PUT | Changes the value of an application property. |
JQL6
Convert user identifiers to account IDs in JQL queriesmigrateQueries | POST | Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs. |
Get field auto complete suggestionsgetFieldAutoCompleteForQueryString | GET | Returns the JQL search auto complete suggestions for a field. |
Get field reference data (GET)getAutoComplete | GET | Returns reference data for JQL searches. |
Get field reference data (POST)getAutoCompletePost | POST | Returns reference data for JQL searches. |
Parse JQL queryparseJqlQueries | POST | Parses and validates JQL queries. |
Sanitize JQL queriessanitiseJqlQueries | POST | Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity. |
JQL Functions (apps)3
Get precomputations (apps)getPrecomputations | GET | Returns the list of a function's precomputations along with information about when they were created, updated, and last used. |
Get precomputations by ID (apps)getPrecomputationsByID | POST | Returns function precomputations by IDs, along with information about when they were created, updated, and last used. |
Update precomputations (apps)updatePrecomputations | POST | Update the precomputation value of a function created by a Forge/Connect app. |
Label1
Get all labelsgetAllLabels | GET | Returns a paginated list of labels. |
License Metric3
Get approximate application license countgetApproximateApplicationLicenseCount | GET | Returns the total approximate number of user accounts for a single Jira license. |
Get approximate license countgetApproximateLicenseCount | GET | Returns the approximate number of user accounts across all Jira licenses. |
Get licensegetLicense | GET | Returns licensing information about the Jira instance. |
Migration Of Connect Modules To Forge2
Get Connect issue field migration taskConnectToForgeMigrationFetchTaskResource_fetchMigrationTask_get | GET | Returns the details of a Connect issue field's migration to Forge. |
Submit Connect issue field migration taskConnectToForgeMigrationTaskSubmissionResource_submitTask_post | POST | Submits a request to trigger migration of connect issue field to its Forge custom field counterpart. |
Myself6
Delete preferenceremovePreference | DELETE | Deletes a preference of the user, which restores the default value of system defined settings. |
Get current usergetCurrentUser | GET | Returns details for the current user. |
Get localegetLocale | GET | Returns the locale for the user. |
Get preferencegetPreference | GET | Returns the value of a preference of the current user. |
Set localesetLocale | PUT | Deprecated, use Update a user profile from the user management REST API instead. |
Set preferencesetPreference | PUT | Creates a preference for the user or updates a preference's value by sending a plain text string. |
Permission4
Get all permissionsgetAllPermissions | GET | Returns all permissions, including: |
Get bulk permissionsgetBulkPermissions | POST | Returns: |
Get my permissionsgetMyPermissions | GET | Returns a list of permissions indicating which permissions the user has. |
Get permitted projectsgetPermittedProjects | POST | Returns all the projects where the user is granted a list of project permissions. |
Permission Scheme9
Create permission grantcreatePermissionGrant | POST | Creates a permission grant in a permission scheme. |
Create permission schemecreatePermissionScheme | POST | Creates a new permission scheme. |
Delete permission schemedeletePermissionScheme | DELETE | Deletes a permission scheme. |
Delete permission scheme grantdeletePermissionSchemeEntity | DELETE | Deletes a permission grant from a permission scheme. |
Get all permission schemesgetAllPermissionSchemes | GET | Returns all permission schemes. |
Get permission schemegetPermissionScheme | GET | Returns a permission scheme. |
Get permission scheme grantgetPermissionSchemeGrant | GET | Returns a permission grant. |
Get permission scheme grantsgetPermissionSchemeGrants | GET | Returns all permission grants for a permission scheme. |
Update permission schemeupdatePermissionScheme | PUT | Updates a permission scheme. |
Plan7
Archive planarchivePlan | PUT | Archives a plan. |
Create plancreatePlan | POST | Creates a plan. |
Duplicate planduplicatePlan | POST | Duplicates a plan. |
Get plangetPlan | GET | Returns a plan. |
Get plans paginatedgetPlans | GET | Returns a paginated list of plans. |
Trash plantrashPlan | PUT | Moves a plan to trash. |
Update planupdatePlan | PUT | Updates any of the following details of a plan using JSON Patch. |
Priority Scheme8
Create priority schemecreatePriorityScheme | POST | Creates a new priority scheme. |
Delete priority schemedeletePriorityScheme | DELETE | Deletes a priority scheme. |
Get available priorities by priority schemegetAvailablePrioritiesByPriorityScheme | GET | Returns a paginated list of priorities available for adding to a priority scheme. |
Get priorities by priority schemegetPrioritiesByPriorityScheme | GET | Returns a paginated list of priorities by scheme. |
Get priority schemesgetPrioritySchemes | GET | Returns a paginated list of priority schemes. |
Get projects by priority schemegetProjectsByPriorityScheme | GET | Returns a paginated list of projects by scheme. |
Suggested priorities for mappingssuggestedPrioritiesForMappings | POST | Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme. |
Update priority schemeupdatePriorityScheme | PUT | Updates a priority scheme. |
Project13
Archive projectarchiveProject | POST | Archives a project. |
Create projectcreateProject | POST | Creates a project based on a project type template, as shown in the following table: |
Delete projectdeleteProject | DELETE | Deletes a project. |
Delete project asynchronouslydeleteProjectAsynchronously | POST | Deletes a project asynchronously. |
Get all projectsgetAllProjects | GET | Returns all projects visible to the user. |
Get all statuses for projectgetAllStatuses | GET | Returns the valid statuses for a project. |
Get projectgetProject | GET | Returns the project details for a project. |
Get project issue type hierarchygetHierarchy | GET | Get the issue type hierarchy for a next-gen project. |
Get project notification schemegetNotificationSchemeForProject | GET | Gets a notification scheme associated with the project. |
Get projects paginatedsearchProjects | GET | Returns a paginated list of projects visible to the user. |
Get recent projectsgetRecent | GET | Returns a list of up to 20 projects recently viewed by the user that are still visible to the user. |
Restore deleted or archived projectrestore | POST | Restores a project that has been archived or placed in the Jira recycle bin. |
Update projectupdateProject | PUT | Updates the project details of a project. |
Project Avatar4
Delete project avatardeleteProjectAvatar | DELETE | Deletes a custom avatar from a project. |
Get all project avatarsgetAllProjectAvatars | GET | Returns all project avatars, grouped by system and custom avatars. |
Load project avatarcreateProjectAvatar | POST | Loads an avatar for a project. |
Set project avatarupdateProjectAvatar | PUT | Sets the avatar displayed for a project. |
Project Category5
Create project categorycreateProjectCategory | POST | Creates a project category. |
Delete project categoryremoveProjectCategory | DELETE | Deletes a project category. |
Get all project categoriesgetAllProjectCategories | GET | Returns all project categories. |
Get project category by IDgetProjectCategoryById | GET | Returns a project category. |
Update project categoryupdateProjectCategory | PUT | Updates a project category. |
Project Classification Level4
Get the classification configuration for a projectgetProjectClassificationConfig | GET | Returns the consolidated classification configuration for a project's admin settings page. |
Get the default data classification level of a projectgetDefaultProjectClassification | GET | Returns the default data classification for a project. |
Remove the default data classification level from a projectremoveDefaultProjectClassification | DELETE | Remove the default data classification level for a project. |
Update the default data classification level of a projectupdateDefaultProjectClassification | PUT | Updates the default data classification level for a project. |
Project Component8
Create componentcreateComponent | POST | Creates a component. |
Delete componentdeleteComponent | DELETE | Deletes a component. |
Find components for projectsfindComponentsForProjects | GET | Returns a paginated list of all components in a project, including global (Compass) components when applicable. |
Get componentgetComponent | GET | Returns a component. |
Get component issues countgetComponentRelatedIssues | GET | Returns the counts of issues assigned to the component. |
Get project componentsgetProjectComponents | GET | Returns all components in a project. |
Get project components paginatedgetProjectComponentsPaginated | GET | Returns a paginated list of all components in a project. |
Update componentupdateComponent | PUT | Updates a component. |
Project Email2
Get project's sender emailgetProjectEmail | GET | Returns the project's sender email address. |
Set project's sender emailupdateProjectEmail | PUT | Sets the project's sender email address. |
Project Feature2
Get project featuresgetFeaturesForProject | GET | Returns the list of features for a project. |
Set project feature statetoggleFeatureForProject | PUT | Sets the state of a project feature. |
Project Key And Name Validation3
Get valid project keygetValidProjectKey | GET | Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key. |
Get valid project namegetValidProjectName | GET | Checks that a project name isn't in use. |
Validate project keyvalidateProjectKey | GET | Validates a project key by confirming the key is a valid string and not in use. |
Project Permission Scheme4
Assign permission schemeassignPermissionScheme | PUT | Assigns a permission scheme with a project. |
Get assigned permission schemegetAssignedPermissionScheme | GET | Gets the permission scheme associated with the project. |
Get project issue security levelsgetSecurityLevelsForProject | GET | Returns all issue security levels for the project that the user has access to. |
Get project issue security schemegetProjectIssueSecurityScheme | GET | Returns the issue security scheme associated with the project. |
Project Property4
Delete project propertydeleteProjectProperty | DELETE | Deletes the property from a project. |
Get project propertygetProjectProperty | GET | Returns the value of a project property. |
Get project property keysgetProjectPropertyKeys | GET | Returns all project property keys for the project. |
Set project propertysetProjectProperty | PUT | Sets the value of the project property. |
Project Role9
Create project rolecreateProjectRole | POST | Creates a new project role with no default actors. |
Delete project roledeleteProjectRole | DELETE | Deletes a project role. |
Fully update project rolefullyUpdateProjectRole | PUT | Updates the project role's name and description. |
Get all project rolesgetAllProjectRoles | GET | Gets a list of all project roles, complete with project role details and default actors. |
Get project role by IDgetProjectRoleById | GET | Gets the project role details and the default actors associated with the role. |
Get project role detailsgetProjectRoleDetails | GET | Returns all project roles and the details for each role. |
Get project role for projectgetProjectRole | GET | Returns a project role's details and actors associated with the project. |
Get project roles for projectgetProjectRoles | GET | Returns a list of project roles for the project returning the name and self URL for each role. |
Partial update project rolepartialUpdateProjectRole | POST | Updates either the project role's name or its description. |
Project Role Actor6
Add actors to project roleaddActorUsers | POST | Adds actors to a project role for the project. |
Add default actors to project roleaddProjectRoleActorsToRole | POST | Adds default actors to a role. |
Delete actors from project roledeleteActor | DELETE | Deletes actors from a project role for the project. |
Delete default actors from project roledeleteProjectRoleActorsFromRole | DELETE | Deletes the default actors from a project role. |
Get default actors for project rolegetProjectRoleActorsForRole | GET | Returns the default actors for the project role. |
Set actors for project rolesetActors | PUT | Sets the actors for a project role for a project, replacing all existing actors. |
Project Template5
Create custom projectcreateProjectWithCustomTemplate | POST | Creates a project based on a custom template provided in the request. |
Deletes a custom project templateremoveTemplate | DELETE | Remove custom template |
Edit a custom project templateeditTemplate | PUT | Edit custom template |
Gets a custom project templateliveTemplate | GET | Get custom template |
Save a custom project templatesaveTemplate | POST | Save custom template |
Project Type4
Get accessible project type by keygetAccessibleProjectTypeByKey | GET | Returns a project type if it is accessible to the user. |
Get all project typesgetAllProjectTypes | GET | Returns all project types, whether or not the instance has a valid license for each type. |
Get licensed project typesgetAllAccessibleProjectTypes | GET | Returns all project types with a valid license. |
Get project type by keygetProjectTypeByKey | GET | Returns a project type. |
Project Version15
Create related workcreateRelatedWork | POST | Creates a related work for the given version. |
Create versioncreateVersion | POST | Creates a project version. |
Delete and replace versiondeleteAndReplaceVersion | POST | Deletes a project version. |
Delete related workdeleteRelatedWork | DELETE | Deletes the given related work for the given version. |
Delete versiondeleteVersion | DELETE | Deletes a project version. |
Get project versionsgetProjectVersions | GET | Returns all versions in a project. |
Get project versions paginatedgetProjectVersionsPaginated | GET | Returns a paginated list of all versions in a project. |
Get related workgetRelatedWork | GET | Returns related work items for the given version id. |
Get versiongetVersion | GET | Returns a project version. |
Get version's related issues countgetVersionRelatedIssues | GET | Returns the following counts for a version: |
Get version's unresolved issues countgetVersionUnresolvedIssues | GET | Returns counts of the issues and unresolved issues for the project version. |
Merge versionsmergeVersions | PUT | Merges two project versions. |
Move versionmoveVersion | POST | Modifies the version's sequence within the project, which affects the display order of the versions in Jira. |
Update related workupdateRelatedWork | PUT | Updates the given related work. |
Update versionupdateVersion | PUT | Updates a project version. |
Rest1
Bulk restgetWorklogsByIssueIdAndWorklogId | POST | Returns worklog details for a list of issue ID and worklog ID pairs. |
Screen7
Add field to default screenaddFieldToDefaultScreen | POST | Adds a field to the default tab of the default screen. |
Create screencreateScreen | POST | Creates a screen with a default field tab. |
Delete screendeleteScreen | DELETE | Deletes a screen. |
Get available screen fieldsgetAvailableScreenFields | GET | Returns the fields that can be added to a tab on a screen. |
Get screensgetScreens | GET | Returns a paginated list of all screens or those specified by one or more screen IDs. |
Get screens for a fieldgetScreensForField | GET | Returns a paginated list of the screens a field is used in. |
Update screenupdateScreen | PUT | Updates a screen. |
Screen Scheme4
Create screen schemecreateScreenScheme | POST | Creates a screen scheme. |
Delete screen schemedeleteScreenScheme | DELETE | Deletes a screen scheme. |
Get screen schemesgetScreenSchemes | GET | Returns a paginated list of screen schemes. |
Update screen schemeupdateScreenScheme | PUT | Updates a screen scheme. |
Screen Tab6
Create screen tabaddScreenTab | POST | Creates a tab for a screen. |
Delete screen tabdeleteScreenTab | DELETE | Deletes a screen tab. |
Get all screen tabsgetAllScreenTabs | GET | Returns the list of tabs for a screen. |
Get bulk screen tabsgetBulkScreenTabs | GET | Returns the list of tabs for a bulk of screens. |
Move screen tabmoveScreenTab | POST | Moves a screen tab. |
Update screen tabrenameScreenTab | PUT | Updates the name of a screen tab. |
Screen Tab Field4
Add screen tab fieldaddScreenTabField | POST | Adds a field to a screen tab. |
Get all screen tab fieldsgetAllScreenTabFields | GET | Returns all fields for a screen tab. |
Move screen tab fieldmoveScreenTabField | POST | Moves a screen tab field. |
Remove screen tab fieldremoveScreenTabField | DELETE | Removes a field from a screen tab. |
Server Info1
Get Jira instance infogetServerInfo | GET | Returns information about the Jira instance. |
Service Registry1
Retrieve the attributes of service registriesServiceRegistryResource_services_get | GET | Retrieve the attributes of given service registries. |
Status9
Bulk create statusescreateStatuses | POST | Creates statuses for a global or project scope. |
Bulk delete StatusesdeleteStatusesById | DELETE | Deletes statuses by ID. |
Bulk get statusesgetStatusesById | GET | Returns a list of the statuses specified by one or more status IDs. |
Bulk get statuses by namegetStatusesByName | GET | Returns a list of the statuses specified by one or more status names. |
Bulk update statusesupdateStatuses | PUT | Updates statuses by ID. |
Get issue type usages by status and projectgetProjectIssueTypeUsagesForStatus | GET | Returns a page of issue types in a project using a given status. |
Get project usages by statusgetProjectUsagesForStatus | GET | Returns a page of projects using a given status. |
Get workflow usages by statusgetWorkflowUsagesForStatus | GET | Returns a page of workflows using a given status. |
Search statuses paginatedsearch | GET | Returns a paginated list of statuses that match a search on name or project. |
Task2
Cancel taskcancelTask | POST | Cancels a task. |
Get taskgetTask | GET | Returns the status of a long-running asynchronous task. |
Teams In Plan9
Add Atlassian team to planaddAtlassianTeam | POST | Adds an existing Atlassian team to a plan and configures their plannning settings. |
Create plan-only teamcreatePlanOnlyTeam | POST | Creates a plan-only team and configures their planning settings. |
Delete plan-only teamdeletePlanOnlyTeam | DELETE | Deletes a plan-only team and their planning settings. |
Get Atlassian team in plangetAtlassianTeam | GET | Returns planning settings for an Atlassian team in a plan. |
Get plan-only teamgetPlanOnlyTeam | GET | Returns planning settings for a plan-only team. |
Get teams in plan paginatedgetTeams | GET | Returns a paginated list of plan-only and Atlassian teams in a plan. |
Remove Atlassian team from planremoveAtlassianTeam | DELETE | Removes an Atlassian team from a plan and deletes their planning settings. |
Update Atlassian team in planupdateAtlassianTeam | PUT | Updates any of the following planning settings of an Atlassian team in a plan using JSON Patch. |
Update plan-only teamupdatePlanOnlyTeam | PUT | Updates any of the following planning settings of a plan-only team using JSON Patch. |
Time Tracking5
Get all time tracking providersgetAvailableTimeTrackingImplementations | GET | Returns all time tracking providers. |
Get selected time tracking providergetSelectedTimeTrackingImplementation | GET | Returns the time tracking provider that is currently selected. |
Get time tracking settingsgetSharedTimeTrackingConfiguration | GET | Returns the time tracking settings. |
Select time tracking providerselectTimeTrackingImplementation | PUT | Selects a time tracking provider. |
Set time tracking settingssetSharedTimeTrackingConfiguration | PUT | Sets the time tracking settings. |
UI Modifications (apps)4
Create UI modificationcreateUiModification | POST | Creates a UI modification. |
Delete UI modificationdeleteUiModification | DELETE | Deletes a UI modification. |
Get UI modificationsgetUiModifications | GET | Gets UI modifications. |
Update UI modificationupdateUiModification | PUT | Updates a UI modification. |
User13
Bulk get usersbulkGetUsers | GET | Returns a paginated list of the users specified by one or more account IDs. |
Create usercreateUser | POST | Creates a user. |
Delete userremoveUser | DELETE | Deletes a user. |
Get account IDs for usersbulkGetUsersMigration | GET | Returns the account IDs for the users specified in the key or username parameters. |
Get all usersgetAllUsers | GET | Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account. |
Get all users defaultgetAllUsersDefault | GET | Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account. |
Get usergetUser | GET | Returns a user. |
Get user default columnsgetUserDefaultColumns | GET | Returns the default issue table columns for the user. |
Get user emailgetUserEmail | GET | Returns a user's email address regardless of the user's profile visibility settings. |
Get user email bulkgetUserEmailBulk | GET | Returns a user's email address regardless of the user's profile visibility settings. |
Get user groupsgetUserGroups | GET | Returns the groups to which a user belongs. |
Reset user default columnsresetUserColumns | DELETE | Resets the default issue table columns for the user to the system default. |
Set user default columnssetUserColumns | PUT | Sets the default issue table columns for the user. |
User Property4
Delete user propertydeleteUserProperty | DELETE | Deletes a property from a user. |
Get user propertygetUserProperty | GET | Returns the value of a user's property. |
Get user property keysgetUserPropertyKeys | GET | Returns the keys of all properties for a user. |
Set user propertysetUserProperty | PUT | Sets the value of a user's property. |
User Search8
Find user keys by queryfindUserKeysByQuery | GET | Finds users with a structured query and returns a paginated list of user keys. |
Find usersfindUsers | GET | Returns a list of active users that match the search string and property. |
Find users assignable to issuesfindAssignableUsers | GET | Returns a list of users that can be assigned to an issue. |
Find users assignable to projectsfindBulkAssignableUsers | GET | Returns a list of users who can be assigned issues in one or more projects. |
Find users by queryfindUsersByQuery | GET | Finds users with a structured query and returns a paginated list of user details. |
Find users for pickerfindUsersForPicker | GET | Returns a list of users whose attributes match the query term. |
Find users with browse permissionfindUsersWithBrowsePermission | GET | Returns a list of users who fulfill these criteria: |
Find users with permissionsfindUsersWithAllPermissions | GET | Returns a list of users who fulfill these criteria: |
Webhook5
Delete webhooks by IDdeleteWebhookById | DELETE | Removes webhooks by ID. |
Extend webhook liferefreshWebhooks | PUT | Extends the life of webhook. |
Get dynamic webhooks for appgetDynamicWebhooksForApp | GET | Returns a paginated list of the webhooks registered by the calling app. |
Get failed webhooksgetFailedWebhooks | GET | Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries. |
Register dynamic webhooksregisterDynamicWebhooks | POST | Registers webhooks. |
Workflow16
Bulk create workflowscreateWorkflows | POST | Create workflows and related statuses. |
Bulk get workflowsreadWorkflows | POST | Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types. |
Bulk update workflowsupdateWorkflows | POST | Update workflows and related statuses. |
Delete inactive workflowdeleteInactiveWorkflow | DELETE | Deletes a workflow. |
Get available workflow capabilitiesworkflowCapabilities | GET | Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. |
Get issue types in a project that are using a given workflowgetWorkflowProjectIssueTypeUsages | GET | Returns a page of issue types using a given workflow within a project. |
Get projects using a given workflowgetProjectUsagesForWorkflow | GET | Returns a page of projects using a given workflow. |
Get the user's default workflow editorgetDefaultEditor | GET | Get the user's default workflow editor. |
Get workflow schemes which are using a given workflowgetWorkflowSchemeUsagesForWorkflow | GET | Returns a page of workflow schemes using a given workflow. |
Get workflows paginatedgetWorkflowsPaginated | GET | This will be removed on June 1, 2026; use Search workflows instead. |
List workflow history entrieslistWorkflowHistory | POST | Returns a list of workflow history entries for a specified workflow id. |
Preview workflowreadWorkflowPreviews | POST | Returns a requested workflow within a given project. |
Read workflow version from historyreadWorkflowFromHistory | POST | Returns a workflow and related statuses for a specified workflow id and version number. |
Search workflowssearchWorkflows | GET | Returns a paginated list of global and project workflows. |
Validate create workflowsvalidateCreateWorkflows | POST | Validate the payload for bulk create workflows. |
Validate update workflowsvalidateUpdateWorkflows | POST | Validate the payload for bulk update workflows. |
Workflow Scheme19
Bulk get workflow schemesreadWorkflowSchemes | POST | Returns a list of workflow schemes by providing workflow scheme IDs or project IDs. |
Classic update workflow schemeupdateWorkflowScheme | PUT | Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. |
Create workflow schemecreateWorkflowScheme | POST | Creates a workflow scheme. |
Delete default workflowdeleteDefaultWorkflow | DELETE | Resets the default workflow for a workflow scheme. |
Delete issue types for workflow in workflow schemedeleteWorkflowMapping | DELETE | Deletes the workflow-issue type mapping for a workflow in a workflow scheme. |
Delete workflow for issue type in workflow schemedeleteWorkflowSchemeIssueType | DELETE | Deletes the issue type-workflow mapping for an issue type in a workflow scheme. |
Delete workflow schemedeleteWorkflowScheme | DELETE | Deletes a workflow scheme. |
Get all workflow schemesgetAllWorkflowSchemes | GET | Returns a paginated list of all workflow schemes, not including draft workflow schemes. |
Get default workflowgetDefaultWorkflow | GET | Returns the default workflow for a workflow scheme. |
Get issue types for workflows in workflow schemegetWorkflow | GET | Returns the workflow-issue type mappings for a workflow scheme. |
Get projects which are using a given workflow schemegetProjectUsagesForWorkflowScheme | GET | Returns a page of projects using a given workflow scheme. |
Get required status mappings for workflow scheme updategetRequiredWorkflowSchemeMappings | POST | Gets the required status mappings for the desired changes to a workflow scheme. |
Get workflow for issue type in workflow schemegetWorkflowSchemeIssueType | GET | Returns the issue type-workflow mapping for an issue type in a workflow scheme. |
Get workflow schemegetWorkflowScheme | GET | Returns a workflow scheme. |
Set issue types for workflow in workflow schemeupdateWorkflowMapping | PUT | Sets the issue types for a workflow in a workflow scheme. |
Set workflow for issue type in workflow schemesetWorkflowSchemeIssueType | PUT | Sets the workflow for an issue type in a workflow scheme. |
Switch workflow scheme for projectswitchWorkflowSchemeForProject | POST | Switches a workflow scheme for a project. |
Update default workflowupdateDefaultWorkflow | PUT | Sets the default workflow for a workflow scheme. |
Update workflow schemeupdateSchemes | POST | Updates company-managed and team-managed project workflow schemes. |
Workflow Scheme Draft14
Create draft workflow schemecreateWorkflowSchemeDraftFromParent | POST | Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. |
Delete draft default workflowdeleteDraftDefaultWorkflow | DELETE | Resets the default workflow for a workflow scheme's draft. |
Delete draft workflow schemedeleteWorkflowSchemeDraft | DELETE | Deletes a draft workflow scheme. |
Delete issue types for workflow in draft workflow schemedeleteDraftWorkflowMapping | DELETE | Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft. |
Delete workflow for issue type in draft workflow schemedeleteWorkflowSchemeDraftIssueType | DELETE | Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft. |
Get draft default workflowgetDraftDefaultWorkflow | GET | Returns the default workflow for a workflow scheme's draft. |
Get draft workflow schemegetWorkflowSchemeDraft | GET | Returns the draft workflow scheme for an active workflow scheme. |
Get issue types for workflows in draft workflow schemegetDraftWorkflow | GET | Returns the workflow-issue type mappings for a workflow scheme's draft. |
Get workflow for issue type in draft workflow schemegetWorkflowSchemeDraftIssueType | GET | Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft. |
Publish draft workflow schemepublishDraftWorkflowScheme | POST | Publishes a draft workflow scheme. |
Set issue types for workflow in workflow schemeupdateDraftWorkflowMapping | PUT | Sets the issue types for a workflow in a workflow scheme's draft. |
Set workflow for issue type in draft workflow schemesetWorkflowSchemeDraftIssueType | PUT | Sets the workflow for an issue type in a workflow scheme's draft. |
Update draft default workflowupdateDraftDefaultWorkflow | PUT | Sets the default workflow for a workflow scheme's draft. |
Update draft workflow schemeupdateWorkflowSchemeDraft | PUT | Updates a draft workflow scheme. |
Workflow Scheme Project Association2
Assign workflow scheme to projectassignSchemeToProject | PUT | Assigns a workflow scheme to a project. |
Get workflow scheme project associationsgetWorkflowSchemeProjectAssociations | GET | Returns a list of the workflow schemes associated with a list of projects. |
Workflow Status Category2
Get all status categoriesgetStatusCategories | GET | Returns a list of all status categories. |
Get status categorygetStatusCategory | GET | Returns a status category. |
Workflow Statuse2
Get all statusesgetStatuses | GET | Returns a list of all statuses associated with active workflows. |
Get statusgetStatus | GET | Returns a status. |
Workflow Transition Rule3
Delete workflow transition rule configurationsdeleteWorkflowTransitionRuleConfigurations | PUT | Deletes workflow transition rules from one or more workflows. |
Get workflow transition rule configurationsgetWorkflowTransitionRuleConfigurations | GET | Returns a paginated list of workflows with transition rules. |
Update workflow transition rule configurationsupdateWorkflowTransitionRuleConfigurations | PUT | Updates configuration of workflow transition rules. |