The Jira Cloud platform REST API
Jira Cloud platform REST API documentation
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Jira Cloud platform REST API documentation
Endpoints 400
Announcement banner
- GETGet announcement banner configuration
/rest/api/3/announcementBannerReturns the current announcement banner configuration. Permissions required: *Administer Jira* global permission. - PUTUpdate announcement banner configuration
/rest/api/3/announcementBannerUpdates the announcement banner configuration. Permissions required: *Administer Jira* global permission.
Application roles
- GETGet all application roles
/rest/api/3/applicationroleReturns all application roles. In Jira, application roles are managed using the Application access configuration page. Permissions required: *Administer Jira*… - GETGet application role
/rest/api/3/applicationrole/:keyReturns an application role. Permissions required: *Administer Jira* global permission.
Audit records
- GETGet audit records
/rest/api/3/auditing/record?offset=0&limit=1000&filter=string&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZReturns 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: *…
Avatars
- GETGet system avatars by type
/rest/api/3/avatar/:type/systemReturns a list of system avatar details by owner type, where the owner types are issue type, project, or user. This operation can be accessed anonymously.… - GETGet avatars
/rest/api/3/universal_avatar/type/:type/owner/:entityIdReturns the system and custom avatars for a project or issue type. This operation can be accessed anonymously. Permissions required: * for custom project… - POSTLoad avatar
/rest/api/3/universal_avatar/type/:type/owner/:entityId?x=0&y=0&size=0Loads a custom avatar for a project or issue type. Specify the avatar's local file location in the body of the request. Also, include the following headers: *… - DELETEDelete avatar
/rest/api/3/universal_avatar/type/:type/owner/:owningObjectId/avatar/:idDeletes an avatar from a project or issue type. Permissions required: *Administer Jira* global permission. - GETGet avatar image by type
/rest/api/3/universal_avatar/view/type/:type?size=xsmall&format=pngReturns the default project or issue type avatar image. This operation can be accessed anonymously. Permissions required: None. - GETGet avatar image by ID
/rest/api/3/universal_avatar/view/type/:type/avatar/:id?size=xsmall&format=pngReturns a project or issue type avatar image by ID. This operation can be accessed anonymously. Permissions required: * For system avatars, none. * For custom… - GETGet avatar image by owner
/rest/api/3/universal_avatar/view/type/:type/owner/:entityId?size=xsmall&format=pngReturns the avatar image for a project or issue type. This operation can be accessed anonymously. Permissions required: * For system avatars, none. * For…
Dashboards
- GETGet all dashboards
/rest/api/3/dashboard?filter=my&startAt=0&maxResults=20Returns 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… - POSTCreate dashboard
/rest/api/3/dashboardCreates a dashboard. Permissions required: None. - GETGet available gadgets
/rest/api/3/dashboard/gadgetsGets a list of all available gadgets that can be added to all dashboards. Permissions required: None. - GETSearch for dashboards
/rest/api/3/dashboard/search?dashboardName=string&accountId=string&owner=string&groupname=string&groupId=string&projectId=0&orderBy=name&startAt=0&maxResults=50&status=active&expand=stringReturns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have… - GETGet gadgets
/rest/api/3/dashboard/:dashboardId/gadget?moduleKey=string&uri=string&gadgetId=0Returns 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… - POSTAdd gadget to dashboard
/rest/api/3/dashboard/:dashboardId/gadgetAdds a gadget to a dashboard. Permissions required: None. - PUTUpdate gadget on dashboard
/rest/api/3/dashboard/:dashboardId/gadget/:gadgetIdChanges the title, position, and color of the gadget on a dashboard. Permissions required: None. - DELETERemove gadget from dashboard
/rest/api/3/dashboard/:dashboardId/gadget/:gadgetIdRemoves 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… - GETGet dashboard item property keys
/rest/api/3/dashboard/:dashboardId/items/:itemId/propertiesReturns the keys of all properties for a dashboard item. This operation can be accessed anonymously. Permissions required: The user must be the owner of the… - GETGet dashboard item property
/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKeyReturns 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… - PUTSet dashboard item property
/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKeySets 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… - DELETEDelete dashboard item property
/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKeyDeletes a dashboard item property. This operation can be accessed anonymously. Permissions required: The user must be the owner of the dashboard. Note, users… - GETGet dashboard
/rest/api/3/dashboard/:idReturns a dashboard. This operation can be accessed anonymously. Permissions required: None. However, to get a dashboard, the dashboard must be shared with… - PUTUpdate dashboard
/rest/api/3/dashboard/:idUpdates a dashboard, replacing all the dashboard details with those provided. Permissions required: None The dashboard to be updated must be owned by the user. - DELETEDelete dashboard
/rest/api/3/dashboard/:idDeletes a dashboard. Permissions required: None The dashboard to be deleted must be owned by the user. - POSTCopy dashboard
/rest/api/3/dashboard/:id/copyCopies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard. Permissions required: None The dashboard to be…
Filters
- GETGet filters
/rest/api/3/filter?expand=stringDeprecated. Returns all filters. Deprecated, use Search for filters that supports search and pagination. This operation can be accessed anonymously.… - POSTCreate filter
/rest/api/3/filter?expand=string&overrideSharePermissions=falseCreates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite. Permissions required: Permission to… - GETGet favorite filters
/rest/api/3/filter/favourite?expand=stringReturns the visible favorite filters of the user. This operation can be accessed anonymously. Permissions required: A favorite filter is only visible to the… - GETGet my filters
/rest/api/3/filter/my?expand=string&includeFavourites=falseReturns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned. Permissions required: Permission… - GETSearch for filters
/rest/api/3/filter/search?filterName=string&accountId=string&owner=string&groupname=string&groupId=string&projectId=0&id=0&orderBy=name&startAt=0&maxResults=50&expand=string&overrideSharePermissions=falseReturns a paginated list of filters. Use this operation to get: * specific filters, by defining id only. * filters that match all of the specified attributes.… - GETGet filter
/rest/api/3/filter/:id?expand=string&overrideSharePermissions=falseReturns a filter. This operation can be accessed anonymously. Permissions required: None, however, the filter is only returned where it is: * owned by the… - PUTUpdate filter
/rest/api/3/filter/:id?expand=string&overrideSharePermissions=falseUpdates a filter. Use this operation to update a filter's name, description, JQL, or sharing. Permissions required: Permission to access Jira, however the… - DELETEDelete filter
/rest/api/3/filter/:idDelete a filter. Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with *Administer… - GETGet columns
/rest/api/3/filter/: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… - PUTSet columns
/rest/api/3/filter/:id/columnsSets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set… - DELETEReset columns
/rest/api/3/filter/:id/columnsReset the user's column configuration for the filter to the default. Permissions required: Permission to access Jira, however, columns are only reset for: *… - PUTAdd filter as favorite
/rest/api/3/filter/:id/favourite?expand=stringAdd a filter as a favorite for the user. Permissions required: Permission to access Jira, however, the user can only favorite: * filters owned by the user. *… - DELETERemove filter as favorite
/rest/api/3/filter/:id/favourite?expand=stringRemoves 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… - PUTChange filter owner
/rest/api/3/filter/:id/ownerChanges the owner of the filter. Permissions required: Permission to access Jira. However, the user must own the filter or have the *Administer Jira* global…
Filter sharing
- GETGet default share scope
/rest/api/3/filter/defaultShareScopeReturns the default sharing settings for new filters and dashboards for a user. Permissions required: Permission to access Jira. - PUTSet default share scope
/rest/api/3/filter/defaultShareScopeSets the default sharing for new filters and dashboards for a user. Permissions required: Permission to access Jira. - GETGet share permissions
/rest/api/3/filter/: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… - POSTAdd share permission
/rest/api/3/filter/: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… - GETGet share permission
/rest/api/3/filter/:id/permission/:permissionIdReturns 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… - DELETEDelete share permission
/rest/api/3/filter/:id/permission/:permissionIdDeletes a share permission from a filter. Permissions required: Permission to access Jira and the user must own the filter.
Group and user picker
- GETFind users and groups
/rest/api/3/groupuserpicker?query=string&maxResults=50&showAvatar=false&fieldId=string&projectId=string&issueTypeId=string&avatarSize=xsmall&caseInsensitive=false&excludeConnectAddons=falseReturns 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.…
Groups
- GETGet group
/rest/api/3/group?groupname=string&groupId=string&expand=stringDeprecated. This operation is deprecated, use group/member. Returns all users in a group. Permissions required: *Administer Jira* global permission. - POSTCreate group
/rest/api/3/groupCreates a group. Permissions required: Site administration (that is, member of the *site-admin* group). - DELETERemove group
/rest/api/3/group?groupname=string&groupId=string&swapGroup=string&swapGroupId=stringDeletes a group. Permissions required: Site administration (that is, member of the *site-admin* strategic group). - GETBulk get groups
/rest/api/3/group/bulk?startAt=0&maxResults=50&groupId=3571b9a7-348f-414a-9087-8e1ea03a7df8&groupName=string&accessType=string&applicationKey=stringReturns a paginated list of groups. Permissions required: *Browse users and groups* global permission. - GETGet users from group
/rest/api/3/group/member?groupname=string&groupId=string&includeInactiveUsers=false&startAt=0&maxResults=50Returns a paginated 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… - POSTAdd user to group
/rest/api/3/group/user?groupname=string&groupId=stringAdds a user to a group. Permissions required: Site administration (that is, member of the *site-admin* group). - DELETERemove user from group
/rest/api/3/group/user?groupname=string&groupId=string&username=string&accountId=5b10ac8d82e05b22cc7d4ef5Removes a user from a group. Permissions required: Site administration (that is, member of the *site-admin* group). - GETFind groups
/rest/api/3/groups/picker?accountId=string&query=query&exclude=string&excludeId=string&maxResults=0&caseInsensitive=false&userName=stringReturns 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…
Instance information
- GETGet license
/rest/api/3/instance/licenseReturns licensing information about the Jira instance. Permissions required: None.
Issues
- GETGet events
/rest/api/3/eventsReturns all issue events. Permissions required: *Administer Jira* global permission. - POSTCreate issue
/rest/api/3/issue?updateHistory=falseCreates 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… - POSTBulk create issue
/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… - GETGet create issue metadata
/rest/api/3/issue/createmeta?projectIds=string&projectKeys=string&issuetypeIds=string&issuetypeNames=string&expand=stringReturns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information… - GETGet issue
/rest/api/3/issue/:issueIdOrKey?fields=*all&fieldsByKeys=false&expand=string&properties=null&updateHistory=falseReturns 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… - PUTEdit issue
/rest/api/3/issue/:issueIdOrKey?notifyUsers=true&overrideScreenSecurity=false&overrideEditableFlag=falseEdits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and… - DELETEDelete issue
/rest/api/3/issue/:issueIdOrKey?deleteSubtasks=falseDeletes 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… - PUTAssign issue
/rest/api/3/issue/:issueIdOrKey/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… - GETGet changelogs
/rest/api/3/issue/:issueIdOrKey/changelog?startAt=0&maxResults=100Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest. This operation can be accessed anonymously. Permissions… - POSTGet changelogs by IDs
/rest/api/3/issue/:issueIdOrKey/changelog/listReturns changelogs for an issue specified by a list of changelog IDs. This operation can be accessed anonymously. Permissions required: * *Browse projects*… - GETGet edit issue metadata
/rest/api/3/issue/:issueIdOrKey/editmeta?overrideScreenSecurity=false&overrideEditableFlag=falseReturns 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. This… - POSTSend notification for issue
/rest/api/3/issue/:issueIdOrKey/notifyCreates an email notification for an issue and adds it to the mail queue. Permissions required: * *Browse Projects* project permission for the project that… - GETGet transitions
/rest/api/3/issue/:issueIdOrKey/transitions?expand=string&transitionId=string&skipRemoteOnlyCondition=false&includeUnavailableTransitions=false&sortByOpsBarAndStatus=falseReturns 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… - POSTTransition issue
/rest/api/3/issue/:issueIdOrKey/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…
UI modifications (apps)
- GETGet UI modifications
/rest/api/3/uiModifications?startAt=0&maxResults=50&expand=stringGets UI modifications. UI modifications can only be retrieved by Forge apps. Permissions required: None. - POSTCreate UI modification
/rest/api/3/uiModificationsCreates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 100 UI modifications. Each UI modification can define… - PUTUpdate UI modification
/rest/api/3/uiModifications/:uiModificationIdUpdates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to 1000 contexts. Permissions required: *… - DELETEDelete UI modification
/rest/api/3/uiModifications/:uiModificationIdDeletes 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…
Issue attachments
- GETGet attachment content
/rest/api/3/attachment/content/:id?redirect=trueReturns 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… - GETGet Jira attachment settings
/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… - GETGet attachment thumbnail
/rest/api/3/attachment/thumbnail/:id?redirect=true&fallbackToDefault=true&width=0&height=0Returns the thumbnail of an attachment. To return the attachment contents, use Get attachment content. This operation can be accessed anonymously. Permissions… - GETGet attachment metadata
/rest/api/3/attachment/:idReturns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be accessed anonymously. Permissions required: *… - DELETEDelete attachment
/rest/api/3/attachment/:idDeletes an attachment from an issue. This operation can be accessed anonymously. Permissions required: For the project holding the issue containing the… - GETGet all metadata for an expanded attachment
/rest/api/3/attachment/: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… - GETGet contents metadata for an expanded attachment
/rest/api/3/attachment/: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… - POSTAdd attachment
/rest/api/3/issue/:issueIdOrKey/attachmentsAdds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867). Note that: * The request must have a X-Atlassian-Token:…
Issue comments
- POSTGet comments by IDs
/rest/api/3/comment/list?expand=stringReturns a paginated list of comments specified by a list of comment IDs. This operation can be accessed anonymously. Permissions required: Comments are… - GETGet comments
/rest/api/3/issue/:issueIdOrKey/comment?startAt=0&maxResults=5000&orderBy=created&expand=stringReturns all comments for an issue. This operation can be accessed anonymously. Permissions required: Comments are included in the response where the user has:… - POSTAdd comment
/rest/api/3/issue/:issueIdOrKey/comment?expand=stringAdds a comment to an issue. This operation can be accessed anonymously. Permissions required: * *Browse projects* and *Add comments* project permission for… - GETGet comment
/rest/api/3/issue/:issueIdOrKey/comment/:id?expand=stringReturns a comment. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for the project containing the… - PUTUpdate comment
/rest/api/3/issue/:issueIdOrKey/comment/:id?notifyUsers=true&overrideEditableFlag=false&expand=stringUpdates a comment. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for the project that the issue… - DELETEDelete comment
/rest/api/3/issue/:issueIdOrKey/comment/:idDeletes a comment. Permissions required: * *Browse projects* project permission for the project that the issue containing the comment is in. * If issue-level…
Issue comment properties
- GETGet comment property keys
/rest/api/3/comment/:commentId/propertiesReturns the keys of all the properties of a comment. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission… - GETGet comment property
/rest/api/3/comment/:commentId/properties/:propertyKeyReturns the value of a comment property. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for the… - PUTSet comment property
/rest/api/3/comment/:commentId/properties/:propertyKeyCreates 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… - DELETEDelete comment property
/rest/api/3/comment/:commentId/properties/:propertyKeyDeletes a comment property. Permissions required: either of: * *Edit All Comments* project permission to delete a property from any comment. * *Edit Own…
Issue fields
- GETGet fields
/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… - POSTCreate custom field
/rest/api/3/fieldCreates a custom field. Permissions required: *Administer Jira* global permission. - GETGet fields paginated
/rest/api/3/field/search?startAt=0&maxResults=50&type=custom&id=string&query=string&orderBy=contextsCount&expand=stringReturns a paginated list of fields for Classic Jira projects. The list can include: * all fields * specific fields, by defining id * fields that contain a… - GETGet fields in trash paginated
/rest/api/3/field/search/trashed?startAt=0&maxResults=50&id=string&query=string&expand=name&orderBy=stringReturns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string. Only custom… - PUTUpdate custom field
/rest/api/3/field/:fieldIdUpdates a custom field. Permissions required: *Administer Jira* global permission. - GETGet contexts for a field
/rest/api/3/field/:fieldId/contexts?startAt=0&maxResults=20Deprecated. Returns a paginated list of the contexts a field is used in. Deprecated, use Get custom field contexts. Permissions required: *Administer Jira*… - DELETEDelete custom field
/rest/api/3/field/:idDeletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and… - POSTRestore custom field from trash
/rest/api/3/field/:id/restoreRestores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields. Permissions required:… - POSTMove custom field to trash
/rest/api/3/field/:id/trashMoves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields. Permissions required:…
Issue field configurations
- GETGet all field configurations
/rest/api/3/fieldconfiguration?startAt=0&maxResults=50&id=0&isDefault=false&query=Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: *… - POSTCreate field configuration
/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… - PUTUpdate field configuration
/rest/api/3/fieldconfiguration/:idUpdates a field configuration. The name and the description provided in the request override the existing values. This operation can only update… - DELETEDelete field configuration
/rest/api/3/fieldconfiguration/:idDeletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. Permissions required: *Administer… - GETGet field configuration items
/rest/api/3/fieldconfiguration/:id/fields?startAt=0&maxResults=50Returns a paginated list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned.… - PUTUpdate field configuration items
/rest/api/3/fieldconfiguration/:id/fieldsUpdates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only… - GETGet all field configuration schemes
/rest/api/3/fieldconfigurationscheme?startAt=0&maxResults=50&id=0Returns a paginated list of field configuration schemes. Only field configuration schemes used in classic projects are returned. Permissions required:… - POSTCreate field configuration scheme
/rest/api/3/fieldconfigurationschemeCreates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. Permissions… - GETGet field configuration issue type items
/rest/api/3/fieldconfigurationscheme/mapping?startAt=0&maxResults=50&fieldConfigurationSchemeId=10020Returns a paginated list of field configuration issue type items. Only items used in classic projects are returned. Permissions required: *Administer Jira*… - GETGet field configuration schemes for projects
/rest/api/3/fieldconfigurationscheme/project?startAt=0&maxResults=50&projectId=0Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration… - PUTAssign field configuration scheme to project
/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.… - PUTUpdate field configuration scheme
/rest/api/3/fieldconfigurationscheme/:idUpdates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. Permissions… - DELETEDelete field configuration scheme
/rest/api/3/fieldconfigurationscheme/:idDeletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. Permissions… - PUTAssign issue types to field configurations
/rest/api/3/fieldconfigurationscheme/:id/mappingAssigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed… - POSTRemove issue types from field configuration scheme
/rest/api/3/fieldconfigurationscheme/:id/mapping/deleteRemoves issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic)…
Issue custom field contexts
- GETGet custom field contexts
/rest/api/3/field/:fieldId/context?isAnyIssueType=true&isGlobalContext=true&contextId=0&startAt=0&maxResults=50Returns a paginated list of contexts for a custom field. Contexts can be returned as follows: * With no other parameters set, all contexts. * By defining id… - POSTCreate custom field context
/rest/api/3/field/:fieldId/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… - GETGet custom field contexts default values
/rest/api/3/field/:fieldId/context/defaultValue?contextId=0&startAt=0&maxResults=50Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set… - PUTSet custom field contexts default values
/rest/api/3/field/:fieldId/context/defaultValueSets default for contexts of a custom field. Default are defined using these objects: * CustomFieldContextDefaultValueDate (type datepicker) for date fields.… - GETGet issue types for custom field context
/rest/api/3/field/:fieldId/context/issuetypemapping?contextId=0&startAt=0&maxResults=50Returns a paginated list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are… - POSTGet custom field contexts for projects and issue types
/rest/api/3/field/:fieldId/context/mapping?startAt=0&maxResults=50Returns 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… - GETGet project mappings for custom field context
/rest/api/3/field/:fieldId/context/projectmapping?contextId=0&startAt=0&maxResults=50Returns a paginated list of context to project mappings for a custom field. The result can be filtered by contextId. Otherwise, all mappings are returned.… - PUTUpdate custom field context
/rest/api/3/field/:fieldId/context/:contextIdUpdates a custom field context. Permissions required: *Administer Jira* global permission. - DELETEDelete custom field context
/rest/api/3/field/:fieldId/context/:contextIdDeletes a custom field context. Permissions required: *Administer Jira* global permission. - PUTAdd issue types to context
/rest/api/3/field/:fieldId/context/:contextId/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… - POSTRemove issue types from context
/rest/api/3/field/:fieldId/context/:contextId/issuetype/removeRemoves issue types from a custom field context. A custom field context without any issue types applies to all issue types. Permissions required: *Administer… - PUTAssign custom field context to projects
/rest/api/3/field/:fieldId/context/:contextId/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… - POSTRemove custom field context from projects
/rest/api/3/field/:fieldId/context/:contextId/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…
Issue custom field options
- GETGet custom field option
/rest/api/3/customFieldOption/: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… - GETGet custom field options (context)
/rest/api/3/field/:fieldId/context/:contextId/option?optionId=0&onlyOptions=false&startAt=0&maxResults=100Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This… - PUTUpdate custom field options (context)
/rest/api/3/field/:fieldId/context/:contextId/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… - POSTCreate custom field options (context)
/rest/api/3/field/:fieldId/context/:contextId/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… - PUTReorder custom field options (context)
/rest/api/3/field/:fieldId/context/:contextId/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… - DELETEDelete custom field options (context)
/rest/api/3/field/:fieldId/context/:contextId/option/:optionIdDeletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom…
Issue custom field options (apps)
- GETGet all issue field options
/rest/api/3/field/:fieldKey/option?startAt=0&maxResults=50Returns a paginated list of all the options of a select list issue field. A select list issue field is a type of issue field that enables a user to select a… - POSTCreate issue field option
/rest/api/3/field/:fieldKey/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… - GETGet selectable issue field options
/rest/api/3/field/:fieldKey/option/suggestions/edit?startAt=0&maxResults=50&projectId=0Returns a paginated 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… - GETGet visible issue field options
/rest/api/3/field/:fieldKey/option/suggestions/search?startAt=0&maxResults=0&projectId=0Returns a paginated 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… - GETGet issue field option
/rest/api/3/field/:fieldKey/option/:optionIdReturns 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… - PUTUpdate issue field option
/rest/api/3/field/:fieldKey/option/:optionIdUpdates 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… - DELETEDelete issue field option
/rest/api/3/field/:fieldKey/option/:optionIdDeletes 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… - DELETEReplace issue field option
/rest/api/3/field/:fieldKey/option/:optionId/issue?replaceWith=0&jql=string&overrideScreenSecurity=false&overrideEditableFlag=falseDeselects 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…
Issue custom field values (apps)
- POSTUpdate custom fields
/rest/api/3/app/field/value?generateChangelog=trueUpdates 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. Custom… - PUTUpdate custom field value
/rest/api/3/app/field/:fieldIdOrKey/value?generateChangelog=trueUpdates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that created them. Permissions required: Only…
Issue custom field configuration (apps)
- GETGet custom field configurations
/rest/api/3/app/field/:fieldIdOrKey/context/configuration?id=0&fieldContextId=0&issueId=0&projectKeyOrId=string&issueTypeId=string&startAt=0&maxResults=100Returns a paginated list of configurations for a custom field created by a Forge app. The result can be filtered by one of these criteria: * id. *… - PUTUpdate custom field configurations
/rest/api/3/app/field/:fieldIdOrKey/context/configurationUpdate the configuration for contexts of a custom field created by a Forge app. Permissions required: *Administer Jira* global permission. Jira permissions…
Issue links
- POSTCreate issue link
/rest/api/3/issueLinkCreates 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.… - GETGet issue link
/rest/api/3/issueLink/:linkIdReturns an issue link. This operation can be accessed anonymously. Permissions required: * *Browse project* project permission for all the projects containing… - DELETEDelete issue link
/rest/api/3/issueLink/:linkIdDeletes an issue link. This operation can be accessed anonymously. Permissions required: * Browse project project permission for all the projects containing…
Issue link types
- GETGet issue link types
/rest/api/3/issueLinkTypeReturns a list of all issue link types. To use this operation, the site must have issue linking enabled. This operation can be accessed anonymously.… - POSTCreate issue link type
/rest/api/3/issueLinkTypeCreates 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… - GETGet issue link type
/rest/api/3/issueLinkType/:issueLinkTypeIdReturns an issue link type. To use this operation, the site must have issue linking enabled. This operation can be accessed anonymously. Permissions required:… - PUTUpdate issue link type
/rest/api/3/issueLinkType/:issueLinkTypeIdUpdates an issue link type. To use this operation, the site must have issue linking enabled. Permissions required: *Administer Jira* global permission. - DELETEDelete issue link type
/rest/api/3/issueLinkType/:issueLinkTypeIdDeletes an issue link type. To use this operation, the site must have issue linking enabled. Permissions required: *Administer Jira* global permission.
Issue navigator settings
- GETGet issue navigator default columns
/rest/api/3/settings/columnsReturns the default issue navigator columns. Permissions required: *Administer Jira* global permission. - PUTSet issue navigator default columns
/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…
Issue notification schemes
- GETGet notification schemes paginated
/rest/api/3/notificationscheme?startAt=0&maxResults=50&id=string&projectId=string&onlyDefault=false&expand=stringReturns a paginated list of notification schemes ordered by the display name. *Note that you should allow for events without recipients to appear in… - POSTCreate notification scheme
/rest/api/3/notificationschemeCreates a notification scheme with notifications. You can create up to 1000 notifications per request. Permissions required: *Administer Jira* global… - GETGet projects using notification schemes paginated
/rest/api/3/notificationscheme/project?startAt=0&maxResults=50¬ificationSchemeId=string&projectId=stringReturns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs… - GETGet notification scheme
/rest/api/3/notificationscheme/:id?expand=stringReturns a notification scheme, including the list of events and the recipients who will receive notifications for those events. Permissions required:… - PUTUpdate notification scheme
/rest/api/3/notificationscheme/:idUpdates a notification scheme. Permissions required: *Administer Jira* global permission. - PUTAdd notifications to notification scheme
/rest/api/3/notificationscheme/:id/notificationAdds notifications to a notification scheme. You can add up to 1000 notifications per request. Permissions required: *Administer Jira* global permission. - DELETEDelete notification scheme
/rest/api/3/notificationscheme/:notificationSchemeIdDeletes a notification scheme. Permissions required: *Administer Jira* global permission. - DELETERemove notification from notification scheme
/rest/api/3/notificationscheme/:notificationSchemeId/notification/:notificationIdRemoves a notification from a notification scheme. Permissions required: *Administer Jira* global permission.
Issue priorities
- GETGet priorities
/rest/api/3/priorityDeprecated. Returns the list of all issue priorities. Permissions required: Permission to access Jira. - POSTCreate priority
/rest/api/3/priorityCreates an issue priority. Permissions required: *Administer Jira* global permission. - PUTSet default priority
/rest/api/3/priority/defaultSets default issue priority. Permissions required: *Administer Jira* global permission. - PUTMove priorities
/rest/api/3/priority/moveChanges the order of issue priorities. Permissions required: *Administer Jira* global permission. - GETSearch priorities
/rest/api/3/priority/search?startAt=0&maxResults=50&id=string&onlyDefault=falseReturns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria: * a list of priority… - GETGet priority
/rest/api/3/priority/:idReturns an issue priority. Permissions required: Permission to access Jira. - PUTUpdate priority
/rest/api/3/priority/:idUpdates an issue priority. Permissions required: *Administer Jira* global permission. - DELETEDelete priority
/rest/api/3/priority/:id?replaceWith=stringDeletes an issue priority. This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to…
Issue properties
- POSTBulk set issues properties by list
/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… - POSTBulk set issue properties by issue
/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… - PUTBulk set issue property
/rest/api/3/issue/properties/:propertyKeySets a property value on multiple issues. The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant… - DELETEBulk delete issue property
/rest/api/3/issue/properties/:propertyKeyDeletes 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… - GETGet issue property keys
/rest/api/3/issue/:issueIdOrKey/propertiesReturns the URLs and keys of an issue's properties. This operation can be accessed anonymously. Permissions required: Property details are only returned where… - GETGet issue property
/rest/api/3/issue/:issueIdOrKey/properties/:propertyKeyReturns the key and value of an issue's property. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for… - PUTSet issue property
/rest/api/3/issue/:issueIdOrKey/properties/:propertyKeySets 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 valid, non-empty JSON… - DELETEDelete issue property
/rest/api/3/issue/:issueIdOrKey/properties/:propertyKeyDeletes an issue's property. This operation can be accessed anonymously. Permissions required: * *Browse projects* and *Edit issues* project permissions for…
Issue remote links
- GETGet remote issue links
/rest/api/3/issue/:issueIdOrKey/remotelink?globalId=stringReturns 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… - POSTCreate or update remote issue link
/rest/api/3/issue/:issueIdOrKey/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… - DELETEDelete remote issue link by global ID
/rest/api/3/issue/:issueIdOrKey/remotelink?globalId=system=http://www.mycompany.com/support&id=1Deletes 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… - GETGet remote issue link by ID
/rest/api/3/issue/:issueIdOrKey/remotelink/:linkIdReturns a remote issue link for an issue. This operation requires issue linking to be active. This operation can be accessed anonymously. Permissions… - PUTUpdate remote issue link by ID
/rest/api/3/issue/:issueIdOrKey/remotelink/:linkIdUpdates 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 active. This… - DELETEDelete remote issue link by ID
/rest/api/3/issue/:issueIdOrKey/remotelink/:linkIdDeletes a remote issue link from an issue. This operation requires issue linking to be active. This operation can be accessed anonymously. Permissions…
Issue resolutions
- GETGet resolutions
/rest/api/3/resolutionDeprecated. Returns a list of all issue resolution values. Permissions required: Permission to access Jira. - POSTCreate resolution
/rest/api/3/resolutionCreates an issue resolution. Permissions required: *Administer Jira* global permission. - PUTSet default resolution
/rest/api/3/resolution/defaultSets default issue resolution. Permissions required: *Administer Jira* global permission. - PUTMove resolutions
/rest/api/3/resolution/moveChanges the order of issue resolutions. Permissions required: *Administer Jira* global permission. - GETSearch resolutions
/rest/api/3/resolution/search?startAt=0&maxResults=50&id=string&onlyDefault=falseReturns a paginated list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria: * a list of… - GETGet resolution
/rest/api/3/resolution/:idReturns an issue resolution value. Permissions required: Permission to access Jira. - PUTUpdate resolution
/rest/api/3/resolution/:idUpdates an issue resolution. Permissions required: *Administer Jira* global permission. - DELETEDelete resolution
/rest/api/3/resolution/:id?replaceWith=stringDeletes an issue resolution. This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to…
Issue search
- GETGet issue picker suggestions
/rest/api/3/issue/picker?query=query¤tJQL=string¤tIssueKey=string¤tProjectId=string&showSubTasks=true&showSubTaskParent=trueReturns 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… - POSTCheck issues against JQL
/rest/api/3/jql/matchChecks whether one or more issues would be returned by one or more JQL queries. Permissions required: None, however, issues are only matched against JQL… - GETSearch for issues using JQL (GET)
/rest/api/3/search?jql=project = HSP&startAt=0&maxResults=50&validateQuery=strict&fields=*navigable&expand=string&properties=string&fieldsByKeys=falseSearches for issues using JQL. If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource. This… - POSTSearch for issues using JQL (POST)
/rest/api/3/searchSearches for issues using JQL. There is a GET version of this resource that can be used for smaller JQL query expressions. This operation can be accessed…
Issue security level
- GETGet issue security level members
/rest/api/3/issuesecurityschemes/:issueSecuritySchemeId/members?startAt=0&maxResults=50&issueSecurityLevelId=0&expand=stringReturns issue security level members. Only issue security level members in context of classic projects are returned. Permissions required: *Administer Jira*… - GETGet issue security level
/rest/api/3/securitylevel/:idReturns details of an issue security level. Use Get issue security scheme to obtain the IDs of issue security levels associated with the issue security…
Issue security schemes
- GETGet issue security schemes
/rest/api/3/issuesecurityschemesReturns all issue security schemes. Permissions required: *Administer Jira* global permission. - GETGet issue security scheme
/rest/api/3/issuesecurityschemes/:idReturns an issue security scheme along with its security levels. Permissions required: * *Administer Jira* global permission. * *Administer Projects* project…
Issue types
- GETGet all issue types for user
/rest/api/3/issuetypeReturns all issue types. This operation can be accessed anonymously. Permissions required: Issue types are only returned as follows: * if the user has the… - POSTCreate issue type
/rest/api/3/issuetypeCreates an issue type and adds it to the default issue type scheme. Permissions required: *Administer Jira* global permission. - GETGet issue types for project
/rest/api/3/issuetype/project?projectId=0&level=0Returns issue types for a project. This operation can be accessed anonymously. Permissions required: *Browse projects* project permission in the relevant… - GETGet issue type
/rest/api/3/issuetype/:idReturns an issue type. This operation can be accessed anonymously. Permissions required: *Browse projects* project permission in a project the issue type is… - PUTUpdate issue type
/rest/api/3/issuetype/:idUpdates the issue type. Permissions required: *Administer Jira* global permission. - DELETEDelete issue type
/rest/api/3/issuetype/:id?alternativeIssueTypeId=stringDeletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative… - GETGet alternative issue types
/rest/api/3/issuetype/: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… - POSTLoad issue type avatar
/rest/api/3/issuetype/:id/avatar2?x=0&y=0&size=0Loads an avatar for the issue type. Specify the avatar's local file location in the body of the request. Also, include the following headers: *…
Issue type schemes
- GETGet all issue type schemes
/rest/api/3/issuetypescheme?startAt=0&maxResults=50&id=0&orderBy=id&expand=&queryString=Returns a paginated list of issue type schemes. Only issue type schemes used in classic projects are returned. Permissions required: *Administer Jira* global… - POSTCreate issue type scheme
/rest/api/3/issuetypeschemeCreates an issue type scheme. Permissions required: *Administer Jira* global permission. - GETGet issue type scheme items
/rest/api/3/issuetypescheme/mapping?startAt=0&maxResults=50&issueTypeSchemeId=0Returns a paginated list of issue type scheme items. Only issue type scheme items used in classic projects are returned. Permissions required: *Administer… - GETGet issue type schemes for projects
/rest/api/3/issuetypescheme/project?startAt=0&maxResults=50&projectId=0Returns a paginated 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… - PUTAssign issue type scheme to project
/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… - PUTUpdate issue type scheme
/rest/api/3/issuetypescheme/:issueTypeSchemeIdUpdates an issue type scheme. Permissions required: *Administer Jira* global permission. - DELETEDelete issue type scheme
/rest/api/3/issuetypescheme/:issueTypeSchemeIdDeletes 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… - PUTAdd issue types to issue type scheme
/rest/api/3/issuetypescheme/:issueTypeSchemeId/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… - PUTChange order of issue types
/rest/api/3/issuetypescheme/:issueTypeSchemeId/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… - DELETERemove issue type from issue type scheme
/rest/api/3/issuetypescheme/:issueTypeSchemeId/issuetype/:issueTypeIdRemoves 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…
Issue type screen schemes
- GETGet issue type screen schemes
/rest/api/3/issuetypescreenscheme?startAt=0&maxResults=50&id=0&queryString=&orderBy=id&expand=Returns a paginated list of issue type screen schemes. Only issue type screen schemes used in classic projects are returned. Permissions required: *Administer… - POSTCreate issue type screen scheme
/rest/api/3/issuetypescreenschemeCreates an issue type screen scheme. Permissions required: *Administer Jira* global permission. - GETGet issue type screen scheme items
/rest/api/3/issuetypescreenscheme/mapping?startAt=0&maxResults=50&issueTypeScreenSchemeId=0Returns a paginated list of issue type screen scheme items. Only issue type screen schemes used in classic projects are returned. Permissions required:… - GETGet issue type screen schemes for projects
/rest/api/3/issuetypescreenscheme/project?startAt=0&maxResults=50&projectId=0Returns a paginated 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… - PUTAssign issue type screen scheme to project
/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 required: *Administer Jira*… - PUTUpdate issue type screen scheme
/rest/api/3/issuetypescreenscheme/:issueTypeScreenSchemeIdUpdates an issue type screen scheme. Permissions required: *Administer Jira* global permission. - DELETEDelete issue type screen scheme
/rest/api/3/issuetypescreenscheme/:issueTypeScreenSchemeIdDeletes an issue type screen scheme. Permissions required: *Administer Jira* global permission. - PUTAppend mappings to issue type screen scheme
/rest/api/3/issuetypescreenscheme/:issueTypeScreenSchemeId/mappingAppends issue type to screen scheme mappings to an issue type screen scheme. Permissions required: *Administer Jira* global permission. - PUTUpdate issue type screen scheme default screen scheme
/rest/api/3/issuetypescreenscheme/:issueTypeScreenSchemeId/mapping/defaultUpdates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types. Permissions required:… - POSTRemove mappings from issue type screen scheme
/rest/api/3/issuetypescreenscheme/:issueTypeScreenSchemeId/mapping/removeRemoves issue type to screen scheme mappings from an issue type screen scheme. Permissions required: *Administer Jira* global permission. - GETGet issue type screen scheme projects
/rest/api/3/issuetypescreenscheme/:issueTypeScreenSchemeId/project?startAt=0&maxResults=50&query=Returns a paginated list of projects associated with an issue type screen scheme. Only company-managed projects associated with an issue type screen scheme…
Issue type properties
- GETGet issue type property keys
/rest/api/3/issuetype/:issueTypeId/propertiesReturns all the issue type property keys of the issue type. This operation can be accessed anonymously. Permissions required: * *Administer Jira* global… - GETGet issue type property
/rest/api/3/issuetype/:issueTypeId/properties/:propertyKeyReturns the key and value of the issue type property. This operation can be accessed anonymously. Permissions required: * *Administer Jira* global permission… - PUTSet issue type property
/rest/api/3/issuetype/:issueTypeId/properties/:propertyKeyCreates or updates the value of the issue type property. Use this resource to store and update data against an issue type. The value of the request body must… - DELETEDelete issue type property
/rest/api/3/issuetype/:issueTypeId/properties/:propertyKeyDeletes the issue type property. Permissions required: *Administer Jira* global permission.
Issue votes
- GETGet votes
/rest/api/3/issue/:issueIdOrKey/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… - POSTAdd vote
/rest/api/3/issue/:issueIdOrKey/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… - DELETEDelete vote
/rest/api/3/issue/:issueIdOrKey/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…
Issue watchers
- POSTGet is watching issue bulk
/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… - GETGet issue watchers
/rest/api/3/issue/:issueIdOrKey/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… - POSTAdd watcher
/rest/api/3/issue/:issueIdOrKey/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… - DELETEDelete watcher
/rest/api/3/issue/:issueIdOrKey/watchers?username=string&accountId=5b10ac8d82e05b22cc7d4ef5Deletes 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…
Issue worklogs
- GETGet issue worklogs
/rest/api/3/issue/:issueIdOrKey/worklog?startAt=0&maxResults=5000&startedAfter=0&startedBefore=0&expand=Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time. Time tracking must be enabled in… - POSTAdd worklog
/rest/api/3/issue/:issueIdOrKey/worklog?notifyUsers=true&adjustEstimate=auto&newEstimate=string&reduceBy=string&expand=&overrideEditableFlag=falseAdds a worklog to an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time… - GETGet worklog
/rest/api/3/issue/:issueIdOrKey/worklog/:id?expand=Returns a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This… - PUTUpdate worklog
/rest/api/3/issue/:issueIdOrKey/worklog/:id?notifyUsers=true&adjustEstimate=auto&newEstimate=string&expand=&overrideEditableFlag=falseUpdates a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This… - DELETEDelete worklog
/rest/api/3/issue/:issueIdOrKey/worklog/:id?notifyUsers=true&adjustEstimate=auto&newEstimate=string&increaseBy=string&overrideEditableFlag=falseDeletes a worklog from an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time… - GETGet IDs of deleted worklogs
/rest/api/3/worklog/deleted?since=0Returns 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.… - POSTGet worklogs
/rest/api/3/worklog/list?expand=Returns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items. Permissions required: Permission to access Jira,… - GETGet IDs of updated worklogs
/rest/api/3/worklog/updated?since=0&expand=Returns 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.…
Issue worklog properties
- GETGet worklog property keys
/rest/api/3/issue/:issueIdOrKey/worklog/:worklogId/propertiesReturns the keys of all properties for a worklog. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for… - GETGet worklog property
/rest/api/3/issue/:issueIdOrKey/worklog/:worklogId/properties/:propertyKeyReturns the value of a worklog property. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for the… - PUTSet worklog property
/rest/api/3/issue/:issueIdOrKey/worklog/:worklogId/properties/:propertyKeySets 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 valid, non-empty… - DELETEDelete worklog property
/rest/api/3/issue/:issueIdOrKey/worklog/:worklogId/properties/:propertyKeyDeletes a worklog property. This operation can be accessed anonymously. Permissions required: * *Browse projects* project permission for the project that the…
Jira expressions
- POSTAnalyse Jira expression
/rest/api/3/expression/analyse?check=syntaxAnalyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check the expressions. Learn more about Jira… - POSTEvaluate Jira expression
/rest/api/3/expression/eval?expand=stringEvaluates 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…
Jira settings
- GETGet application property
/rest/api/3/application-properties?key=string&permissionLevel=string&keyFilter=stringReturns all application properties or an application property. If you specify a value for the key parameter, then an application property is returned as an… - GETGet advanced settings
/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… - PUTSet application property
/rest/api/3/application-properties/: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 -*… - GETGet global settings
/rest/api/3/configurationReturns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If…
JQL
- GETGet field reference data (GET)
/rest/api/3/jql/autocompletedataReturns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced… - POSTGet field reference data (POST)
/rest/api/3/jql/autocompletedataReturns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced… - GETGet field auto complete suggestions
/rest/api/3/jql/autocompletedata/suggestions?fieldName=reporter&fieldValue=string&predicateName=string&predicateValue=stringReturns 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.… - POSTParse JQL query
/rest/api/3/jql/parse?validation=strictParses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. Permissions required:… - POSTConvert user identifiers to account IDs in JQL queries
/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… - POSTSanitize JQL queries
/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…
Labels
- GETGet all labels
/rest/api/3/label?startAt=0&maxResults=1000Returns a paginated list of labels.
License metrics
- GETGet approximate license count
/rest/api/3/license/approximateLicenseCountReturns the total approximate user account across all jira licenced application keys. Please note this information is cached with a 7-day lifecycle and could… - GETGet approximate application license count
/rest/api/3/license/approximateLicenseCount/product/:applicationKeyReturns the total approximate user account for a specific jira licence application key. Please note this information is cached with a 7-day lifecycle and…
Myself
- GETGet preference
/rest/api/3/mypreferences?key=stringReturns 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… - PUTSet preference
/rest/api/3/mypreferences?key=stringCreates 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… - DELETEDelete preference
/rest/api/3/mypreferences?key=stringDeletes a preference of the user, which restores the default value of system defined settings. Note that these keys are deprecated: * *jira.user.locale* The… - GETGet locale
/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… - PUTSet locale
/rest/api/3/mypreferences/localeDeprecated. Deprecated, use Update a user profile from the user management REST API instead. Sets the locale of the user. The locale must be one supported by… - DELETEDelete locale
/rest/api/3/mypreferences/localeDeprecated. Deprecated, use Update a user profile from the user management REST API instead. Deletes the locale of the user, which restores the default… - GETGet current user
/rest/api/3/myself?expand=stringReturns details for the current user. Permissions required: Permission to access Jira.
Permissions
- GETGet my permissions
/rest/api/3/mypermissions?projectKey=string&projectId=string&issueKey=string&issueId=string&permissions=BROWSE_PROJECTS,EDIT_ISSUES&projectUuid=string&projectConfigurationUuid=string&commentId=stringReturns 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… - GETGet all permissions
/rest/api/3/permissionsReturns all permissions, including: * global permissions. * project permissions. * global permissions added by plugins. Permissions required: *Administer… - POSTGet bulk permissions
/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,… - POSTGet permitted projects
/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 required: None.
Permission schemes
- GETGet all permission schemes
/rest/api/3/permissionscheme?expand=stringReturns all permission schemes. About permission schemes and grants ### A permission scheme is a collection of permission grants. A permission grant consists… - POSTCreate permission scheme
/rest/api/3/permissionscheme?expand=stringCreates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants. Permissions required: *Administer… - GETGet permission scheme
/rest/api/3/permissionscheme/:schemeId?expand=stringReturns a permission scheme. Permissions required: Permission to access Jira. - PUTUpdate permission scheme
/rest/api/3/permissionscheme/:schemeId?expand=stringUpdates 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… - DELETEDelete permission scheme
/rest/api/3/permissionscheme/:schemeIdDeletes a permission scheme. Permissions required: *Administer Jira* global permission. - GETGet permission scheme grants
/rest/api/3/permissionscheme/:schemeId/permission?expand=stringReturns all permission grants for a permission scheme. Permissions required: Permission to access Jira. - POSTCreate permission grant
/rest/api/3/permissionscheme/:schemeId/permission?expand=stringCreates a permission grant in a permission scheme. Permissions required: *Administer Jira* global permission. - GETGet permission scheme grant
/rest/api/3/permissionscheme/:schemeId/permission/:permissionId?expand=stringReturns a permission grant. Permissions required: Permission to access Jira. - DELETEDelete permission scheme grant
/rest/api/3/permissionscheme/:schemeId/permission/:permissionIdDeletes a permission grant from a permission scheme. See About permission schemes and grants for more details. Permissions required: *Administer Jira* global…
Projects
- GETGet all projects
/rest/api/3/project?expand=string&recent=0&properties=stringDeprecated. Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination. This operation can be… - POSTCreate project
/rest/api/3/projectCreates a project based on a project type template, as shown in the following table: The project types are available according to the installed Jira features… - GETGet recent projects
/rest/api/3/project/recent?expand=string&properties={}Returns 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… - GETGet projects paginated
/rest/api/3/project/search?startAt=0&maxResults=50&orderBy=key&id=0&keys=string&query=string&typeKey=string&categoryId=0&action=view&expand=string&status=live&properties={}&propertyQuery=stringReturns a paginated list of projects visible to the user. This operation can be accessed anonymously. Permissions required: Projects are returned only where… - GETGet project
/rest/api/3/project/:projectIdOrKey?expand=string&properties=stringReturns the project details for a project. This operation can be accessed anonymously. Permissions required: *Browse projects* project permission for the… - PUTUpdate project
/rest/api/3/project/:projectIdOrKey?expand=stringUpdates the project details of a project. All parameters are optional in the body of the request. Permissions required: *Administer Jira* global permission. - DELETEDelete project
/rest/api/3/project/:projectIdOrKey?enableUndo=falseDeletes 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,… - POSTArchive project
/rest/api/3/project/:projectIdOrKey/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,…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://your-domain.atlassian.net- Authentication
- OAuth 2.0 (authorization code flow) with 183 scopes
HTTP Basic authentication (username and password) - Operations
- 487 operations on 317 pathsGET 224PUT 95POST 93DELETE 75
13 marked deprecated - Main resources
- Dashboards 16Issue field configurations 15Filters 14Issues 14Projects 14Workflow scheme drafts 14Workflow schemes 14Issue custom field contexts 13Users 13Issue type screen schemes 11
- Response formats
application/json*/*image/png- Description format
- OpenAPI 3.0.1, API version
1001.0.0-SNAPSHOT - Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the The Jira Cloud platform REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the The Jira Cloud platform REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 183 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get announcement banner configuration” (GET /rest/api/3/announcementBanner), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the The Jira Cloud platform REST API?
Jira Cloud platform REST API documentation It is listed under Developer tools and has 487 endpoints.
Who publishes the The Jira Cloud platform REST API?
It is listed from Atlassian's public API description (an OpenAPI document), not published by Atlassian on Swastik Codes. Anyone who controls atlassian.com can claim the profile by adding a DNS TXT record.
What is the base URL of the The Jira Cloud platform REST API?
Requests go to https://your-domain.atlassian.net. Endpoint paths are added to this base URL.
How do I authenticate with the The Jira Cloud platform REST API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 183 scopes; HTTP Basic authentication (username and password).
How many endpoints does the The Jira Cloud platform REST API have?
487 operations on 317 paths (224 GET, 95 PUT, 93 POST, 75 DELETE). The largest groups are Dashboards, Issue field configurations, Filters, Issues. This listing's collection holds the first 400.
Is forking the The Jira Cloud platform REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.