Announcement banner2
This resource represents an announcement banner. Use it to retrieve and update banner configuration.
GET/rest/api/3/announcementBannerGet announcement banner configuration
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | AnnouncementBannerConfiguration |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
PUT/rest/api/3/announcementBannerUpdate announcement banner configuration
Request bodyapplication/json — AnnouncementBannerConfigurationUpdate (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if an invalid parameter is passed. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
App data policies2
This resource represents app access rule data policies.
GET/rest/api/3/data-policyGet data policy for the workspace
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful | WorkspaceDataPolicy |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the client is not authorized to make the request. | ErrorCollection |
GET/rest/api/3/data-policy/projectGet data policy for projects
Parameters| Name | In | Required | Type |
|---|
ids | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectDataPolicies |
400 | Returned if the request is not valid or includes invalid or not-permitted project identifiers. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the client is not authorized to make the request. | ErrorCollection |
App migration3
This resource supports [app migrations](https://developer.atlassian.com/platform/app-migration/). Use it to:
- [to request migrated workflow rules details](https://developer.atlassian.com/platform/app-migration/tutorials/migration-app-workflow-rules/).
- [perform bulk updates of entity properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).
- [perform bulk updates of issue custom field values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/).
PUT/rest/atlassian-connect/1/migration/fieldBulk update custom field value
Parameters| Name | In | Required | Type |
|---|
Atlassian-Transfer-Id | header | yes | string |
Request bodyapplication/json — ConnectCustomFieldValues (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
403 | Returned if:
* the transfer ID is not found.
* the authorisation credentials are incorrect or missing. | — |
PUT/rest/atlassian-connect/1/migration/properties/{entityType}Bulk update entity properties
Parameters| Name | In | Required | Type |
|---|
Atlassian-Transfer-Id | header | yes | string |
entityType | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
403 | Returned if the authorisation credentials are incorrect or missing. | — |
POST/rest/atlassian-connect/1/migration/workflow/rule/searchGet workflow transition rule configurations
Parameters| Name | In | Required | Type |
|---|
Atlassian-Transfer-Id | header | yes | string |
Request bodyapplication/json — WorkflowRulesSearch (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowRulesSearchDetails |
400 | Returned if the request is not valid. | — |
403 | Returned if the authorisation credentials are incorrect or missing. | — |
App properties8
This resource represents app properties. Use it to store arbitrary data for your
[Connect app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
GET/rest/atlassian-connect/1/addons/{addonKey}/propertiesGet app properties
Parameters| Name | In | Required | Type |
|---|
addonKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
401 | Returned if the authentication credentials are incorrect or missing. | OperationMessage |
GET/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}Get app property
Parameters| Name | In | Required | Type |
|---|
addonKey | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
400 | Returned if the property key is longer than 127 characters. | OperationMessage |
401 | Returned if the authentication credentials are incorrect or missing. | OperationMessage |
404 | Returned if the property is not found or doesn't belong to the app. | OperationMessage |
PUT/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}Set app property
Parameters| Name | In | Required | Type |
|---|
addonKey | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the property is updated. | OperationMessage |
201 | Returned is the property is created. | OperationMessage |
400 | Returned if:
* the property key is longer than 127 characters.
* the value is not valid JSON.
* the value is longer than 32768 characters. | OperationMessage |
401 | Returned if the authentication credentials are incorrect or missing. | OperationMessage |
403 | Returned if the property key is reserved and read-only. | OperationMessage |
DELETE/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}Delete app property
Parameters| Name | In | Required | Type |
|---|
addonKey | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the property key is longer than 127 characters. | OperationMessage |
401 | Returned if the authentication credentials are incorrect or missing. | OperationMessage |
403 | Returned if the property key is reserved and read-only. | OperationMessage |
404 | Returned if the property is not found or doesn't belong to the app. | OperationMessage |
GET/rest/forge/1/app/propertiesGet app property keys (Forge)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request isn't made directly by an app or if it's an impersonated request. | — |
GET/rest/forge/1/app/properties/{propertyKey}Get app property (Forge)
Parameters| Name | In | Required | Type |
|---|
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the property key is longer than 127 characters. | OperationMessage |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request isn't made directly by an app or if it's an impersonated request. | — |
404 | Returned if the property isn't found or doesn't belong to the app. | OperationMessage |
PUT/rest/forge/1/app/properties/{propertyKey}Set app property (Forge)
Parameters| Name | In | Required | Type |
|---|
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the property is updated. | OperationMessage |
201 | Returned is the property is created. | OperationMessage |
400 | Returned if:
* the property key is longer than 127 characters.
* the value isn't valid JSON.
* the value is longer than 32768 characters. | OperationMessage |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request isn't made directly by an app or if it's an impersonated request. | — |
DELETE/rest/forge/1/app/properties/{propertyKey}Delete app property (Forge)
Parameters| Name | In | Required | Type |
|---|
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the property key is longer than 127 characters. | OperationMessage |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request isn't made directly by an app or if it's an impersonated request. | — |
404 | Returned if the property isn't found or doesn't belong to the app. | OperationMessage |
Application roles2
This resource represents application roles. Use it to get details of an application role or all application roles.
GET/rest/api/3/applicationroleGet all application roles
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user is not an administrator. | — |
GET/rest/api/3/applicationrole/{key}Get application role
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ApplicationRole |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user is not an administrator. | — |
404 | Returned if the role is not found. | — |
Audit records1
This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records.
GET/rest/api/3/auditing/recordGet audit records
Parameters| Name | In | Required | Type |
|---|
offset | query | no | integer |
limit | query | no | integer |
filter | query | no | string |
from | query | no | string |
to | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | AuditRecords |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if:
* the user does not have the required permissions.
* all Jira products are on free plans. Audit logs are available when at least one Jira product is on a paid plan. | ErrorCollection |
Avatars7
This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project, issue type or priority and obtain avatar images.
GET/rest/api/3/avatar/{type}/systemGet system avatars by type
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SystemAvatars |
401 | Returned if the authentication credentials are incorrect or missing. | — |
500 | Returned if an error occurs while retrieving the list of avatars. | — |
GET/rest/api/3/universal_avatar/type/{type}/owner/{entityId}Get avatars
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
entityId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Avatars |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found. | — |
POST/rest/api/3/universal_avatar/type/{type}/owner/{entityId}Load avatar
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
entityId | path | yes | string |
x | query | no | integer |
y | query | no | integer |
size | query | yes | integer |
Request body*/* (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Avatar |
400 | Returned if:
* an image isn't included in the request.
* the image type is unsupported.
* the crop parameters extend the crop area beyond the edge of the image. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permissions. | — |
404 | Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found. | — |
DELETE/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}Delete avatar
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
owningObjectId | path | yes | string |
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
403 | Returned if the user does not have permission to delete the avatar, the avatar is not deletable. | — |
404 | Returned if the avatar type, associated item ID, or avatar ID is invalid. | — |
GET/rest/api/3/universal_avatar/view/type/{type}Get avatar image by type
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
size | query | no | string |
format | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if an avatar is not found or an avatar matching the requested size is not found. | — |
GET/rest/api/3/universal_avatar/view/type/{type}/avatar/{id}Get avatar image by ID
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
id | path | yes | integer |
size | query | no | string |
format | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if an avatar is not found or an avatar matching the requested size is not found. | — |
GET/rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}Get avatar image by owner
Parameters| Name | In | Required | Type |
|---|
type | path | yes | string |
entityId | path | yes | string |
size | query | no | string |
format | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if an avatar is not found or an avatar matching the requested size is not found. | — |
Classification levels1
This resource represents classification levels.
GET/rest/api/3/classification-levelsGet all classification levels
Parameters| Name | In | Required | Type |
|---|
status | query | no | array |
orderBy | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DataClassificationLevelsBean |
401 | Returned if the authentication credentials are incorrect or missing. | — |
Dashboards17
This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards.
GET/rest/api/3/dashboardGet all dashboards
Parameters| Name | In | Required | Type |
|---|
filter | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageOfDashboards |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
POST/rest/api/3/dashboardCreate dashboard
Parameters| Name | In | Required | Type |
|---|
extendAdminPermissions | query | no | boolean |
Request bodyapplication/json — DashboardDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Dashboard |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
PUT/rest/api/3/dashboard/bulk/editBulk edit dashboards
Request bodyapplication/json — BulkEditShareableEntityRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkEditShareableEntityResponse |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
GET/rest/api/3/dashboard/gadgetsGet available gadgets
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | AvailableDashboardGadgetsResponse |
400 | 400 response | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
GET/rest/api/3/dashboard/searchSearch for dashboards
Parameters| Name | In | Required | Type |
|---|
dashboardName | query | no | string |
accountId | query | no | string |
owner | query | no | string |
groupname | query | no | string |
groupId | query | no | string |
projectId | query | no | integer |
orderBy | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
status | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanDashboard |
400 | Returned if:
* `orderBy` is invalid.
* `expand` includes an invalid value.
* `accountId` and `owner` are provided.
* `groupname` and `groupId` are provided. | ErrorCollection |
401 | 401 response | ErrorCollection |
GET/rest/api/3/dashboard/{dashboardId}/gadgetGet gadgets
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | integer |
moduleKey | query | no | array |
uri | query | no | array |
gadgetId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DashboardGadgetResponse |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the dashboard is not found. | ErrorCollection |
POST/rest/api/3/dashboard/{dashboardId}/gadgetAdd gadget to dashboard
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | integer |
Request bodyapplication/json — DashboardGadgetSettings (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DashboardGadget |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the dashboard is not found. | ErrorCollection |
PUT/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}Update gadget on dashboard
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | integer |
gadgetId | path | yes | integer |
Request bodyapplication/json — DashboardGadgetUpdateRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the gadget or the dashboard is not found. | ErrorCollection |
DELETE/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}Remove gadget from dashboard
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | integer |
gadgetId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the gadget or the dashboard is not found. | ErrorCollection |
GET/rest/api/3/dashboard/{dashboardId}/items/{itemId}/propertiesGet dashboard item property keys
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | string |
itemId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the dashboard or dashboard item is not found, or the dashboard is not owned by or shared with the user. | ErrorCollection |
GET/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}Get dashboard item property
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | string |
itemId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the dashboard, the dashboard item, or dashboard item property is not found, or the dashboard is not owned by or shared with the user. | ErrorCollection |
PUT/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}Set dashboard item property
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | string |
itemId | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the dashboard item property is updated. | — |
201 | Returned if the dashboard item property is created. | — |
400 | Returned if:
* Request is invalid
* Or if all of these conditions are met in the request:
* The dashboard item has a spec URI and no complete module key
* The value of propertyKey is equal to "config"
* The request body contains a JSON object whose keys and values are not strings. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user is not the owner of the dashboard. | ErrorCollection |
404 | Returned if the dashboard item is not found or the dashboard is not shared with the user. | ErrorCollection |
DELETE/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}Delete dashboard item property
Parameters| Name | In | Required | Type |
|---|
dashboardId | path | yes | string |
itemId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the dashboard item property is deleted. | — |
400 | Returned if the dashboard or dashboard item ID is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user is not the owner of the dashboard. | ErrorCollection |
404 | Returned if the dashboard item is not found or the dashboard is not shared with the user. | ErrorCollection |
GET/rest/api/3/dashboard/{id}Get dashboard
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Dashboard |
400 | 400 response | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the dashboard is not found or the dashboard is not owned by or shared with the user. | — |
PUT/rest/api/3/dashboard/{id}Update dashboard
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
extendAdminPermissions | query | no | boolean |
Request bodyapplication/json — DashboardDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Dashboard |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the dashboard is not found or the dashboard is not owned by the user. | ErrorCollection |
DELETE/rest/api/3/dashboard/{id}Delete dashboard
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the dashboard is deleted. | — |
400 | 400 response | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
POST/rest/api/3/dashboard/{id}/copyCopy dashboard
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
extendAdminPermissions | query | no | boolean |
Request bodyapplication/json — DashboardDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Dashboard |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the dashboard is not found or the dashboard is not owned by or shared with the user. | ErrorCollection |
Dynamic modules3
This resource represents [modules registered dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)
by [Connect apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
GET/rest/atlassian-connect/1/app/module/dynamicGet modules
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ConnectModules |
401 | Returned if the call is not from a Connect app. | ErrorMessage |
POST/rest/atlassian-connect/1/app/module/dynamicRegister modules
Request bodyapplication/json — ConnectModules (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* any of the provided modules is invalid. For example, required properties are missing.
* any of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.
Details of the issues encountered are included in the error message. | ErrorMessage |
401 | Returned if the call is not from a Connect app. | ErrorMessage |
DELETE/rest/atlassian-connect/1/app/module/dynamicRemove modules
Parameters| Name | In | Required | Type |
|---|
moduleKey | query | no | array |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the call is not from a Connect app. | ErrorMessage |
Field schemes15
This resource represents field schemes which are replacing field configuration schemes to control field associations. They are currently in beta and only available to customers who have opted-in to the beta program. For more information see [RFC-103: Jira Field Configuration Overhaul: Admin Experience and API Changes](https://community.developer.atlassian.com/t/rfc-103-jira-field-configuration-overhaul-admin-experience-and-api-changes/94205)
GET/rest/api/3/config/fieldschemesGet field schemes
Parameters| Name | In | Required | Type |
|---|
projectId | query | no | array |
query | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Pagianted list of field association schemes | PageBean2GetFieldAssociationSchemeResponse |
400 | Returned if the request parameters are invalid (e.g., negative startAt, maxResults exceeding limit). | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the feature flag is disabled. | — |
POST/rest/api/3/config/fieldschemesCreate field scheme
Request bodyapplication/json — CreateFieldAssociationSchemeRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the creation was successful. | CreateFieldAssociationSchemeResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
404 | Returned if the feature flag is disabled or the scheme ID is not found. | — |
PUT/rest/api/3/config/fieldschemes/fieldsUpdate fields associated with field schemes
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the field association update was successful. | FieldSchemeToFieldsResponse |
204 | The request completed successfully. No additional content will be sent in the response. | — |
207 | Returned if the field association update was partially successful. | FieldSchemeToFieldsResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. If request is well-formed but contains invalid scheme or field IDs, returns failure details. | FieldSchemeToFieldsResponse |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
DELETE/rest/api/3/config/fieldschemes/fieldsRemove fields associated with field schemes
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the field association update was successful. | MinimalFieldSchemeToFieldsResponse |
204 | The request completed successfully. No additional content will be sent in the response. | — |
207 | Returned if the field association update was partially successful. | MinimalFieldSchemeToFieldsResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. If request is well-formed but contains invalid scheme or field IDs, returns failure details. | MinimalFieldSchemeToFieldsResponse |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
PUT/rest/api/3/config/fieldschemes/fields/parametersUpdate field parameters
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the field parameter update was successful. | UpdateFieldSchemeParametersResponse |
204 | The request completed successfully. No additional content will be sent in the response. | — |
207 | Returned if the field parameter update was partially successful. | UpdateFieldSchemeParametersResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. If request is well-formed but contains invalid scheme or field IDs, returns failure details. | UpdateFieldSchemeParametersResponse |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
DELETE/rest/api/3/config/fieldschemes/fields/parametersRemove field parameters
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the removal was successful. | — |
204 | The request completed successfully. No additional content will be sent in the response. | — |
207 | Returned if the removal was partially successful. | RemoveFieldParametersResult |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. If request is well-formed but contains invalid scheme or project IDs, returns failure details. | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
GET/rest/api/3/config/fieldschemes/projectsGet projects with field schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returns the list of project with field association schemes. | PageBean2GetProjectsWithFieldSchemesResponse |
400 | Returned if the request is invalid. | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the feature flag is disabled. | — |
PUT/rest/api/3/config/fieldschemes/projectsAssociate projects to field schemes
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the association was successful. | FieldSchemeToProjectsResponse |
204 | The request completed successfully. No additional content will be sent in the response. | — |
207 | Returned if the association was partially successful. | FieldSchemeToProjectsResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. If request is well-formed but contains invalid scheme or project IDs, returns failure details. | FieldSchemeToProjectsResponse |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
GET/rest/api/3/config/fieldschemes/{id}Get field scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if a field association scheme matches the given scheme ID | GetFieldAssociationSchemeByIdResponse |
403 | Returned if the user does not have the required permissions | — |
404 | Returned if provided ID does not match any field association schemes | — |
PUT/rest/api/3/config/fieldschemes/{id}Update field scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — UpdateFieldAssociationSchemeRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the update was successful. | UpdateFieldAssociationSchemeResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
404 | Returned if the feature flag is disabled or the scheme ID is not found. | — |
DELETE/rest/api/3/config/fieldschemes/{id}Delete a field scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the field association scheme deletion was successful. | DeleteFieldAssociationSchemeResponse |
400 | Returned if the scheme that the user is attempting to delete is a system scheme. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
404 | Return if the provided ID does not match any existing field association scheme | — |
409 | Return if the scheme that the user is attempting to delete is still in use. | — |
POST/rest/api/3/config/fieldschemes/{id}/cloneClone field scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — CreateFieldAssociationSchemeRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the clone was successful. | CreateFieldAssociationSchemeResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
404 | Returned if the feature flag is disabled or the source scheme ID is not found. | — |
GET/rest/api/3/config/fieldschemes/{id}/fieldsSearch field scheme fields
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
fieldId | query | no | array |
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returns the matching fields, at the specified page of the results. | PageBean2FieldAssociationSchemeFieldSearchResult |
400 | Returned if the request parameters are invalid (e.g., negative startAt, maxResults exceeding limit, duplicate fieldIds). | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the feature flag is disabled or the scheme ID is not found. | — |
GET/rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parametersGet field parameters
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
fieldId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the parameters fetched were successful. | GetFieldAssociationParametersResponse |
400 | Returned if the request is invalid. If request is malformed, returns a collection of errors. | ErrorCollections |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions | — |
GET/rest/api/3/config/fieldschemes/{id}/projectsSearch field scheme projects
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | no | array |
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returns a paginated list of projects associated with the field association scheme, matching the specified filter criteria. | PageBean2FieldAssociationSchemeProjectSearchResult |
400 | 400 response | — |
401 | 401 response | — |
403 | 403 response | — |
404 | 404 response | — |
Filter sharing6
This resource represents options for sharing [filters](#api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters.
GET/rest/api/3/filter/defaultShareScopeGet default share scope
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DefaultShareScope |
401 | Returned if the authentication credentials are incorrect or missing. | — |
PUT/rest/api/3/filter/defaultShareScopeSet default share scope
Request bodyapplication/json — DefaultShareScope (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DefaultShareScope |
400 | Returned if an invalid scope is set. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/filter/{id}/permissionGet share permissions
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the filter is not found.
* the user does not have permission to view the filter. | — |
POST/rest/api/3/filter/{id}/permissionAdd share permission
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — SharePermissionInputBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | — |
400 | Returned if:
* the request object is invalid. For example, it contains an invalid type, the ID does not match the type, or the project or group is not found.
* the user does not own the filter.
* the user does not have the required permissions. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the filter is not found.
* the user does not have permission to view the filter. | — |
GET/rest/api/3/filter/{id}/permission/{permissionId}Get share permission
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
permissionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SharePermission |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the filter is not found.
* the permission is not found.
* the user does not have permission to view the filter. | — |
DELETE/rest/api/3/filter/{id}/permission/{permissionId}Delete share permission
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
permissionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the filter is not found.
* the user does not own the filter. | — |
Filters13
This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.
POST/rest/api/3/filterCreate filter
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
overrideSharePermissions | query | no | boolean |
Request bodyapplication/json — Filter (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Filter |
400 | Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/filter/favouriteGet favorite filters
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/filter/myGet my filters
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
includeFavourites | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/filter/searchSearch for filters
Parameters| Name | In | Required | Type |
|---|
filterName | query | no | string |
accountId | query | no | string |
owner | query | no | string |
groupname | query | no | string |
groupId | query | no | string |
projectId | query | no | integer |
id | query | no | array |
orderBy | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
expand | query | no | string |
overrideSharePermissions | query | no | boolean |
isSubstringMatch | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFilterDetails |
400 | Returned if:
* `owner` and `accountId` are provided.
* `expand` includes an invalid value.
* `orderBy` is invalid.
* `id` identifies more than 200 filter IDs. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/filter/{id}Get filter
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
expand | query | no | string |
overrideSharePermissions | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Filter |
400 | Returned if the filter is not found or the user does not have permission to view it. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
PUT/rest/api/3/filter/{id}Update filter
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
expand | query | no | string |
overrideSharePermissions | query | no | boolean |
Request bodyapplication/json — Filter (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Filter |
400 | Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
DELETE/rest/api/3/filter/{id}Delete filter
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the filter is not found. | — |
401 | Returned if the user does not have permission to delete the filter. | — |
GET/rest/api/3/filter/{id}/columnsGet columns
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the user does not have permission to view the filter. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if a column configuration is not set for the filter. | — |
PUT/rest/api/3/filter/{id}/columnsSet columns
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request body*/* — ColumnRequestBody (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* a non-navigable field is set as a column.
* the user does not have permission to view the filter. | — |
403 | Returned if the requesting user is not an owner of the filter. | — |
DELETE/rest/api/3/filter/{id}/columnsReset columns
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if:
* the filter is not found.
* the user does not have permission to view the filter. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
PUT/rest/api/3/filter/{id}/favouriteAdd filter as favorite
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Filter |
400 | Returned if:
* the filter is not found.
* the user does not have permission to favorite the filter. | — |
DELETE/rest/api/3/filter/{id}/favouriteRemove filter as favorite
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Filter |
400 | Returned if:
* the filter is not found.
* the user does not have permission to view the filter. | — |
PUT/rest/api/3/filter/{id}/ownerChange filter owner
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — ChangeFilterOwner (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned when:
* The new owner of the filter owns a filter with the same name.
* An attempt is made to change owner of the default filter. | — |
403 | Returned if the requesting user is not an owner of the filter or does not have *Administer Jira* global permission. | — |
404 | Returned if the filter or the new owner of the filter is not found. | — |
Group and user picker1
This resource represents a list of users and a list of groups. Use it to obtain the details to populate user and group picker suggestions list.
GET/rest/api/3/groupuserpickerFind users and groups
Parameters| Name | In | Required | Type |
|---|
query | query | yes | string |
maxResults | query | no | integer |
showAvatar | query | no | boolean |
fieldId | query | no | string |
projectId | query | no | array |
issueTypeId | query | no | array |
avatarSize | query | no | string |
caseInsensitive | query | no | boolean |
excludeConnectAddons | query | no | boolean |
includeAiAgents | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | FoundUsersAndGroups |
400 | Returned if the query parameter is not provided. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
Groups8
This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)
GET/rest/api/3/groupGet group
Parameters| Name | In | Required | Type |
|---|
groupname | query | no | string |
groupId | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Group |
400 | Returned if the group name is not specified. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the calling user does not have the Administer Jira global permission. | — |
404 | Returned if the group is not found. | — |
POST/rest/api/3/groupCreate group
Request bodyapplication/json — AddGroupBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Group |
400 | Returned if group name is not specified or the group name is in use. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
DELETE/rest/api/3/groupRemove group
Parameters| Name | In | Required | Type |
|---|
groupname | query | no | string |
groupId | query | no | string |
swapGroup | query | no | string |
swapGroupId | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the group name is not specified. | — |
401 | Returned if the authentication credentials are incorrect or missing from the request. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the group is not found. | — |
GET/rest/api/3/group/bulkBulk get groups
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
groupId | query | no | array |
groupName | query | no | array |
accessType | query | no | string |
applicationKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanGroupDetails |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
500 | Returned if the group with the given access level can't be retrieved. | — |
GET/rest/api/3/group/memberGet users from group
Parameters| Name | In | Required | Type |
|---|
groupname | query | no | string |
groupId | query | no | string |
includeInactiveUsers | query | no | boolean |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanUserDetails |
400 | Returned if the group name is not specified. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the calling user does not have the Administer Jira global permission. | — |
404 | Returned if the group is not found. | — |
POST/rest/api/3/group/userAdd user to group
Parameters| Name | In | Required | Type |
|---|
groupname | query | no | string |
groupId | query | no | string |
Request bodyapplication/json — UpdateUserToGroupBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Group |
400 | Returned if:
* `groupname` is not provided.
* `accountId` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing from the request. | — |
403 | Returned if the calling user does not have the necessary permission. | — |
404 | Returned if the group or user are not found. | — |
429 | Returned if rate limiting is being enforced. | — |
DELETE/rest/api/3/group/userRemove user from group
Parameters| Name | In | Required | Type |
|---|
groupname | query | no | string |
groupId | query | no | string |
username | query | no | string |
accountId | query | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* `groupName` is missing.
* `accountId` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing from the request. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the group or user are not found. | — |
429 | Returned if rate limiting is being enforced. | — |
GET/rest/api/3/groups/pickerFind groups
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
query | query | no | string |
exclude | query | no | array |
excludeId | query | no | array |
maxResults | query | no | integer |
caseInsensitive | query | no | boolean |
userName | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | FoundGroups |
Issue attachments8
This resource represents issue attachments and the attachment settings for Jira. Use it to get the metadata for an attachment, delete an attachment, and view the metadata for the contents of an attachment. Also, use it to get the attachment settings for Jira.
GET/rest/api/3/attachment/content/{id}Get attachment content
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
redirect | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful when `redirect` is set to `false`. | — |
206 | Returned if the request is successful when a `Range` header is provided and `redirect` is set to `false`. | — |
303 | Returned if the request is successful. See the `Location` header for the download URL. | — |
400 | Returned if the range supplied in the `Range` header is malformed. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | The user does not have the necessary permission. | — |
404 | Returned if:
* the attachment is not found.
* attachments are disabled in the Jira settings. | — |
416 | Returned if the server is unable to satisfy the range of bytes provided. | — |
GET/rest/api/3/attachment/metaGet Jira attachment settings
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | AttachmentSettings |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/attachment/thumbnail/{id}Get attachment thumbnail
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
redirect | query | no | boolean |
fallbackToDefault | query | no | boolean |
width | query | no | integer |
height | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful when `redirect` is set to `false`. | — |
303 | Returned if the request is successful. See the `Location` header for the download URL. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | The user does not have the necessary permission. | — |
404 | Returned if:
* the attachment is not found.
* attachments are disabled in the Jira settings.
* `fallbackToDefault` is `false` and the request thumbnail cannot be downloaded. | — |
GET/rest/api/3/attachment/{id}Get attachment metadata
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | AttachmentMetadata |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if:
* the attachment is not found.
* attachments are disabled in the Jira settings. | — |
DELETE/rest/api/3/attachment/{id}Delete attachment
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if:
* the attachment is not found.
* attachments are disabled in the Jira settings. | — |
GET/rest/api/3/attachment/{id}/expand/humanGet all metadata for an expanded attachment
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive. | AttachmentArchiveMetadataReadable |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | The user does not have the necessary permission. | — |
404 | Returned if:
* the attachment is not found.
* attachments are disabled in the Jira settings. | — |
409 | Returned if the attachment is an archive, but not a supported archive format. | — |
GET/rest/api/3/attachment/{id}/expand/rawGet contents metadata for an expanded attachment
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive. | AttachmentArchiveImpl |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | The user does not have the necessary permission. | — |
404 | Returned if:
* the attachment is not found.
* attachments are disabled in the Jira settings. | — |
409 | Returned if the attachment is an archive, but not a supported archive format. | — |
POST/rest/api/3/issue/{issueIdOrKey}/attachmentsAdd attachment
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodymultipart/form-data (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* the issue is not found.
* the user does not have permission to view the issue. | — |
413 | Returned if any of the following is true:
* the attachments exceed the maximum attachment size for issues.
* more than 60 files are requested to be uploaded.
* the per-issue limit for attachments has been breached.
See [Configuring file attachments](https://confluence.atlassian.com/x/wIXKM) for details. | — |
Issue bulk operations9
This resource represents the issue bulk operations. Use it to move multiple issues from one project to another project or edit fields of multiple issues in one go.
For additional clarity, we have created a page with further examples and answers to frequently asked questions related to these APIs. You can access it here: [Bulk operation APIs: additional examples and FAQ](https://developer.atlassian.com/cloud/jira/platform/bulk-operation-additional-examples-and-faqs/).
### Authentication ###
Access to the issue bulk operations requires authentication. For information on how to authenticate API requests, refer to the [Basic auth for REST APIs documentation](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).
### Rate limiting ###
The bulk edit and move APIs are subject to the usual rate limiting infrastructure in Jira. For more information, refer to [Rate limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/). Additionally, at any given time, only 5 concurrent requests can be sent across all users.
POST/rest/api/3/bulk/issues/deleteBulk delete issues
Request bodyapplication/json — IssueBulkDeletePayload (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SubmittedBulkOperation |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
403 | Returned if the user does not have the necessary permission. | BulkOperationErrorResponse |
GET/rest/api/3/bulk/issues/fieldsGet bulk editable fields
Parameters| Name | In | Required | Type |
|---|
issueIdsOrKeys | query | yes | string |
searchText | query | no | string |
endingBefore | query | no | string |
startingAfter | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkEditGetFields |
400 | Returned if the request is not valid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
403 | Returned if the user does not have the necessary permission. | BulkOperationErrorResponse |
404 | Returned if no editable fields are found for the provided issue IDs. | BulkOperationErrorResponse |
POST/rest/api/3/bulk/issues/fieldsBulk edit issues
Request bodyapplication/json — IssueBulkEditPayload (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SubmittedBulkOperation |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
POST/rest/api/3/bulk/issues/moveBulk move issues
Request bodyapplication/json — IssueBulkMovePayload (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SubmittedBulkOperation |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
GET/rest/api/3/bulk/issues/transitionGet available transitions
Parameters| Name | In | Required | Type |
|---|
issueIdsOrKeys | query | yes | string |
endingBefore | query | no | string |
startingAfter | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkTransitionGetAvailableTransitions |
400 | Returned if the request is not valid. For example, if a provided issue ID or key is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
403 | Returned if the user does not have the necessary permission. | BulkOperationErrorResponse |
POST/rest/api/3/bulk/issues/transitionBulk transition issue statuses
Request bodyapplication/json — IssueBulkTransitionPayload (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SubmittedBulkOperation |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
403 | Returned if the user does not have the necessary permission. | BulkOperationErrorResponse |
POST/rest/api/3/bulk/issues/unwatchBulk unwatch issues
Request bodyapplication/json — IssueBulkWatchOrUnwatchPayload (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SubmittedBulkOperation |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
403 | Returned if the user does not have the necessary permission. | BulkOperationErrorResponse |
POST/rest/api/3/bulk/issues/watchBulk watch issues
Request bodyapplication/json — IssueBulkWatchOrUnwatchPayload (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SubmittedBulkOperation |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
403 | Returned if the user does not have the necessary permission. | BulkOperationErrorResponse |
GET/rest/api/3/bulk/queue/{taskId}Get bulk issue operation progress
Parameters| Name | In | Required | Type |
|---|
taskId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkOperationProgress |
400 | Returned if the request is invalid. | BulkOperationErrorResponse |
401 | Returned if the authentication credentials are incorrect or missing. | BulkOperationErrorResponse |
Issue comment properties4
This resource represents [issue comment](#api-group-Issue-comments) properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issue comment properties as well as obtain the keys of all properties on a comment. Comment properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
GET/rest/api/3/comment/{commentId}/propertiesGet comment property keys
Parameters| Name | In | Required | Type |
|---|
commentId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
400 | Returned if the comment ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the comment is not found. | — |
GET/rest/api/3/comment/{commentId}/properties/{propertyKey}Get comment property
Parameters| Name | In | Required | Type |
|---|
commentId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the comment or the property is not found. | — |
PUT/rest/api/3/comment/{commentId}/properties/{propertyKey}Set comment property
Parameters| Name | In | Required | Type |
|---|
commentId | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the comment property is updated. | — |
201 | Returned if the comment property is created. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the comment is not found. | — |
DELETE/rest/api/3/comment/{commentId}/properties/{propertyKey}Delete comment property
Parameters| Name | In | Required | Type |
|---|
commentId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the comment or the property is not found. | — |
Issue comments6
This resource represents issue comments. Use it to:
* get, create, update, and delete a comment from an issue.
* get all comments from issue.
* get a list of comments by comment ID.
POST/rest/api/3/comment/listGet comments by IDs
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Request bodyapplication/json — IssueCommentListRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanComment |
400 | Returned if the request contains more than 1000 IDs or is empty. | — |
GET/rest/api/3/issue/{issueIdOrKey}/commentGet comments
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
orderBy | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageOfComments |
400 | Returned if `orderBy` is set to a value other than *created*. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
POST/rest/api/3/issue/{issueIdOrKey}/commentAdd comment
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
expand | query | no | string |
Request bodyapplication/json — Comment (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Comment |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
413 | Returned if the per-issue limit has been breached for one of the following fields:
* comments
* attachments | — |
GET/rest/api/3/issue/{issueIdOrKey}/comment/{id}Get comment
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
id | path | yes | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Comment |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue or comment is not found or the user does not have permission to view the issue or comment. | — |
PUT/rest/api/3/issue/{issueIdOrKey}/comment/{id}Update comment
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
id | path | yes | string |
notifyUsers | query | no | boolean |
overrideEditableFlag | query | no | boolean |
expand | query | no | string |
Request bodyapplication/json — Comment (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Comment |
400 | Returned if the user does not have permission to edit the comment or the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue or comment is not found or the user does not have permission to view the issue or comment. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/comment/{id}Delete comment
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the user does not have permission to delete the comment. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue or comment is not found or the user does not have permission to view the issue or comment. | — |
405 | Returned if an anonymous call is made to the operation. | — |
Issue custom field associations2
This resource represents the fields associated to project and issue type contexts. Use it to:
* assign custom field to projects and issue types.
PUT/rest/api/3/field/associationCreate associations
Request bodyapplication/json — FieldAssociationsRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the field association validation passes. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the field, project, or issue type is not found. | — |
DELETE/rest/api/3/field/associationRemove associations
Request bodyapplication/json — FieldAssociationsRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the field association validation passes. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the field, project, or issue type is not found. | — |
Issue custom field configuration (apps)3
This resource represents configurations stored against a custom field context by a [Forge app](https://developer.atlassian.com/platform/forge/). Configurations are information used by the Forge app at runtime to determine how to handle or process the data in a custom field in a given context. Use this resource to set and read configurations.
POST/rest/api/3/app/field/context/configuration/listBulk get custom field configurations
Parameters| Name | In | Required | Type |
|---|
id | query | no | array |
fieldContextId | query | no | array |
issueId | query | no | integer |
projectKeyOrId | query | no | string |
issueTypeId | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Request bodyapplication/json — ConfigurationsListParameters (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanBulkContextualConfiguration |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field. | — |
404 | Returned if the custom field is not found. | — |
GET/rest/api/3/app/field/{fieldIdOrKey}/context/configurationGet custom field configurations
Parameters| Name | In | Required | Type |
|---|
fieldIdOrKey | path | yes | string |
id | query | no | array |
fieldContextId | query | no | array |
issueId | query | no | integer |
projectKeyOrId | query | no | string |
issueTypeId | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanContextualConfiguration |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field. | — |
404 | Returned if the custom field is not found. | — |
PUT/rest/api/3/app/field/{fieldIdOrKey}/context/configurationUpdate custom field configurations
Parameters| Name | In | Required | Type |
|---|
fieldIdOrKey | path | yes | string |
Request bodyapplication/json — CustomFieldConfigurations (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field. | — |
404 | Returned if the custom field is not found. | — |
Issue custom field contexts14
This resource represents issue custom field contexts. Use it to:
* get, create, update, and delete custom field contexts.
* get context to issue types and projects mappings.
* get custom field contexts for projects and issue types.
* assign custom field contexts to projects.
* remove custom field contexts from projects.
* add issue types to custom field contexts.
GET/rest/api/3/field/{fieldId}/contextGet custom field contexts
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
isAnyIssueType | query | no | boolean |
isGlobalContext | query | no | boolean |
contextId | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanCustomFieldContext |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field was not found. | — |
POST/rest/api/3/field/{fieldId}/contextCreate custom field context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
Request bodyapplication/json — CreateCustomFieldContext (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the custom field context is created. | CreateCustomFieldContext |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the field, project, or issue type is not found. | — |
409 | Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings. | — |
GET/rest/api/3/field/{fieldId}/context/defaultValueGet custom field contexts default values
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanCustomFieldContextDefaultValue |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field is not found. | — |
PUT/rest/api/3/field/{fieldId}/context/defaultValueSet custom field contexts default values
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
Request bodyapplication/json — CustomFieldContextDefaultValueUpdate (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if operation is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field, a context, an option, or a cascading option is not found. | — |
GET/rest/api/3/field/{fieldId}/context/defaultValuesGet default values for a custom field grouped by context and issue type
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | query | no | array |
issueTypeId | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanContextDefaultValues |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field is not found. | — |
GET/rest/api/3/field/{fieldId}/context/issuetypemappingGet issue types for custom field context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if operation is successful. | PageBeanIssueTypeToContextMapping |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
POST/rest/api/3/field/{fieldId}/context/mappingGet custom field contexts for projects and issue types
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Request bodyapplication/json — ProjectIssueTypeMappings (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanContextForProjectAndIssueType |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field, project, or issue type is not found. | — |
GET/rest/api/3/field/{fieldId}/context/projectmappingGet project mappings for custom field context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanCustomFieldContextProjectMapping |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field is not found. | — |
PUT/rest/api/3/field/{fieldId}/context/{contextId}Update custom field context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — CustomFieldContextUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the context is updated. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field or the context is not found. | — |
DELETE/rest/api/3/field/{fieldId}/context/{contextId}Delete custom field context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the context is deleted. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field or the context is not found. | — |
PUT/rest/api/3/field/{fieldId}/context/{contextId}/issuetypeAdd issue types to context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — IssueTypeIds (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if operation is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field, context, or one or more issue types are not found. | — |
409 | Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings. | — |
POST/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/removeRemove issue types from context
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — IssueTypeIds (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if operation is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field, context, or one or more issue types are not found. | — |
PUT/rest/api/3/field/{fieldId}/context/{contextId}/projectAssign custom field context to projects
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — ProjectIds (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if operation is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field, context, or project is not found. | — |
POST/rest/api/3/field/{fieldId}/context/{contextId}/project/removeRemove custom field context from projects
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — ProjectIds (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the custom field context is removed from the projects. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field, context, or one or more projects are not found. | — |
Issue custom field options7
This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types:
* Checkboxes.
* Radio Buttons.
* Select List (single choice).
* Select List (multiple choices).
* Select List (cascading).
See [Issue custom field options (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom issue field select list options created by a Connect app.
Use it to retrieve, create, update, order, and delete custom field options.
GET/rest/api/3/customFieldOption/{id}Get custom field option
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | CustomFieldOption |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the custom field option is not found.
* the user does not have permission to view the custom field. | — |
GET/rest/api/3/field/{fieldId}/context/{contextId}/optionGet custom field options (context)
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
optionId | query | no | integer |
onlyOptions | query | no | boolean |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanCustomFieldContextOption |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the custom field is not found or the context doesn't match the custom field. | — |
POST/rest/api/3/field/{fieldId}/context/{contextId}/optionCreate custom field options (context)
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — BulkCustomFieldOptionCreateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | CustomFieldCreatedContextOptionsList |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the custom field is not found or the context doesn't match the custom field. | — |
PUT/rest/api/3/field/{fieldId}/context/{contextId}/optionUpdate custom field options (context)
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — BulkCustomFieldOptionUpdateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | CustomFieldUpdatedContextOptionsList |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field, context, or one or more options is not found. | — |
PUT/rest/api/3/field/{fieldId}/context/{contextId}/option/moveReorder custom field options (context)
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
Request bodyapplication/json — OrderOfCustomFieldOptions (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if options are reordered. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field, the context, or one or more of the options is not found.. | — |
DELETE/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}Delete custom field options (context)
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
contextId | path | yes | integer |
optionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the option is deleted. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field, the context, or the option is not found. | — |
DELETE/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issueReplace custom field options
Parameters| Name | In | Required | Type |
|---|
replaceWith | query | no | integer |
jql | query | no | string |
fieldId | path | yes | string |
optionId | path | yes | integer |
contextId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
303 | Returned if the long-running task to deselect the option is started. | TaskProgressBeanRemoveOptionFromIssuesResult |
400 | Returned if the request is not valid. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field is not found or does not support options, or the options to be replaced are not found. | — |
Issue custom field options (apps)8
This resource represents custom issue field select list options created by a Connect app. See [Issue custom field options](#api-group-Issue-custom-field-options) to manipulate options created in Jira or using the REST API.
A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select an option from a list. Use it to add, remove, and update the options of a select list issue field.
GET/rest/api/3/field/{fieldKey}/optionGet all issue field options
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
fieldKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueFieldOption |
400 | Returned if the field is not found or does not support options. | — |
403 | Returned if the request is not authenticated as a Jira administrator or the app that provided the field. | — |
POST/rest/api/3/field/{fieldKey}/optionCreate issue field option
Parameters| Name | In | Required | Type |
|---|
fieldKey | path | yes | string |
Request bodyapplication/json — IssueFieldOptionCreateBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueFieldOption |
400 | Returned if the option is invalid. | — |
403 | Returned if the request is not authenticated as a Jira administrator or the app that provided the field. | — |
404 | Returned if the field is not found or does not support options. | — |
GET/rest/api/3/field/{fieldKey}/option/suggestions/editGet selectable issue field options
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | no | integer |
fieldKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueFieldOption |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the field is not found or does not support options. | — |
GET/rest/api/3/field/{fieldKey}/option/suggestions/searchGet visible issue field options
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | no | integer |
fieldKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueFieldOption |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the field is not found or does not support options. | — |
GET/rest/api/3/field/{fieldKey}/option/{optionId}Get issue field option
Parameters| Name | In | Required | Type |
|---|
fieldKey | path | yes | string |
optionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the requested option is returned. | IssueFieldOption |
400 | Returned if the field is not found or does not support options. | — |
403 | Returned if the request is not authenticated as a Jira administrator or the app that provided the field. | — |
404 | Returned if the option is not found. | — |
PUT/rest/api/3/field/{fieldKey}/option/{optionId}Update issue field option
Parameters| Name | In | Required | Type |
|---|
fieldKey | path | yes | string |
optionId | path | yes | integer |
Request bodyapplication/json — IssueFieldOption (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the option is updated or created. | IssueFieldOption |
400 | Returned if the option is invalid, or the *ID* in the request object does not match the *optionId* parameter. | — |
403 | Returned if the request is not authenticated as a Jira administrator or the app that provided the field. | — |
404 | Returned if field is not found. | — |
DELETE/rest/api/3/field/{fieldKey}/option/{optionId}Delete issue field option
Parameters| Name | In | Required | Type |
|---|
fieldKey | path | yes | string |
optionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the field option is deleted. | — |
403 | Returned if the request is not authenticated as a Jira administrator or the app that provided the field. | — |
404 | Returned if the field or option is not found. | — |
409 | Returned if the option is selected for the field in any issue. | — |
DELETE/rest/api/3/field/{fieldKey}/option/{optionId}/issueReplace issue field option
Parameters| Name | In | Required | Type |
|---|
replaceWith | query | no | integer |
jql | query | no | string |
overrideScreenSecurity | query | no | boolean |
overrideEditableFlag | query | no | boolean |
fieldKey | path | yes | string |
optionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
303 | Returned if the long-running task to deselect the option is started. | TaskProgressBeanRemoveOptionFromIssuesResult |
400 | Returned if the request is not valid. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field is not found or does not support options, or the options to be replaced are not found. | — |
Issue custom field values (apps)2
This resource represents the values of custom fields added by [Forge apps](https://developer.atlassian.com/platform/forge/). Use it to update the value of a custom field on issues.
POST/rest/api/3/app/field/valueUpdate custom fields
Parameters| Name | In | Required | Type |
|---|
generateChangelog | query | no | boolean |
generateAppEvents | query | no | boolean |
Request bodyapplication/json — MultipleCustomFieldValuesUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
403 | Returned if the request is not authenticated as the app that provided all the fields. | — |
404 | Returned if any field is not found. | — |
PUT/rest/api/3/app/field/{fieldIdOrKey}/valueUpdate custom field value
Parameters| Name | In | Required | Type |
|---|
fieldIdOrKey | path | yes | string |
generateChangelog | query | no | boolean |
generateAppEvents | query | no | boolean |
Request bodyapplication/json — CustomFieldValueUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
403 | Returned if the request is not authenticated as the app that provided the field. | — |
404 | Returned if the field is not found. | — |
Issue field configurations15
This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes.
GET/rest/api/3/fieldconfigurationGet all field configurations
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
isDefault | query | no | boolean |
query | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFieldConfigurationDetails |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
POST/rest/api/3/fieldconfigurationCreate field configuration
Request bodyapplication/json — FieldConfigurationDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | FieldConfiguration |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
PUT/rest/api/3/fieldconfiguration/{id}Update field configuration
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — FieldConfigurationDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field configuration is not found. | — |
DELETE/rest/api/3/fieldconfiguration/{id}Delete field configuration
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field configuration is not found. | — |
GET/rest/api/3/fieldconfiguration/{id}/fieldsGet field configuration items
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFieldConfigurationItem |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field configuration is not found. | — |
PUT/rest/api/3/fieldconfiguration/{id}/fieldsUpdate field configuration items
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — FieldConfigurationItemsDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field configuration is not found. | — |
GET/rest/api/3/fieldconfigurationschemeGet all field configuration schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFieldConfigurationScheme |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permissions. | — |
POST/rest/api/3/fieldconfigurationschemeCreate field configuration scheme
Request bodyapplication/json — UpdateFieldConfigurationSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | FieldConfigurationScheme |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permissions. | — |
GET/rest/api/3/fieldconfigurationscheme/mappingGet field configuration issue type items
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
fieldConfigurationSchemeId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFieldConfigurationIssueTypeItem |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if no field configuration schemes are found. | — |
GET/rest/api/3/fieldconfigurationscheme/projectGet field configuration schemes for projects
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFieldConfigurationSchemeProjects |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
PUT/rest/api/3/fieldconfigurationscheme/projectAssign field configuration scheme to project
Request bodyapplication/json — FieldConfigurationSchemeProjectAssociation (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the project is not a classic project. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permissions. | — |
404 | Returned if the project is missing. | — |
PUT/rest/api/3/fieldconfigurationscheme/{id}Update field configuration scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — UpdateFieldConfigurationSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permissions. | — |
404 | Returned if the field configuration scheme is not found. | — |
DELETE/rest/api/3/fieldconfigurationscheme/{id}Delete field configuration scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field configuration scheme is not found. | — |
PUT/rest/api/3/fieldconfigurationscheme/{id}/mappingAssign issue types to field configurations
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — AssociateFieldConfigurationsWithIssueTypesRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field configuration scheme, the field configuration, or the issue type is not found. | — |
POST/rest/api/3/fieldconfigurationscheme/{id}/mapping/deleteRemove issue types from field configuration scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — IssueTypeIdsToRemove (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
404 | Returned if the field configuration scheme or the issue types are not found. | ErrorCollection |
Issue fields11
This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields.
GET/rest/api/3/fieldGet fields
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/fieldCreate custom field
Request bodyapplication/json — CustomFieldDefinitionJsonBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the custom field is created. | FieldDetails |
400 | Returned if:
* the user does not have permission to create custom fields.
* any of the request object properties have invalid or missing values. | — |
GET/rest/api/3/field/searchGet fields paginated
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
type | query | no | array |
id | query | no | array |
query | query | no | string |
orderBy | query | no | string |
expand | query | no | string |
projectIds | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanField |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
GET/rest/api/3/field/search/trashedGet fields in trash paginated
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
query | query | no | string |
expand | query | no | string |
orderBy | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanField |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
PUT/rest/api/3/field/{fieldId}Update custom field
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
Request bodyapplication/json — UpdateCustomFieldDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the custom field is not found. | — |
GET/rest/api/3/field/{fieldId}/association/projectGet field project associations
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanFieldProjectAssociation |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/field/{fieldId}/contextsGet contexts for a field
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanContext |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
DELETE/rest/api/3/field/{id}Delete custom field
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if any of these are true:
* The custom field is locked.
* The custom field is used in a issue security scheme or a permission scheme.
* The custom field ID format is incorrect. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
404 | Returned if the custom field is not found. | ErrorCollection |
409 | Returned if a task to delete the custom field is running. | ErrorCollection |
POST/rest/api/3/field/{id}/restoreRestore custom field from trash
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
404 | Returned if the custom field is not found. | ErrorCollection |
POST/rest/api/3/field/{id}/trashMove custom field to trash
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
404 | Returned if the custom field is not found. | ErrorCollection |
GET/rest/api/3/projects/fieldsGet fields for projects
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | yes | array |
workTypeId | query | yes | array |
fieldId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBean2ProjectFieldBean |
400 | Returned if the request parameters are invalid. | — |
401 | Returned if authentication is missing. | — |
403 | Returned if the user does not have permission to view the projects or work types. | — |
404 | Returned if the endpoint is not enabled via feature flag. | — |
Issue link types5
This resource represents [issue link](#api-group-Issue-links) types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.
To use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
GET/rest/api/3/issueLinkTypeGet issue link types
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueLinkTypes |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if issue linking is disabled. | — |
POST/rest/api/3/issueLinkTypeCreate issue link type
Request bodyapplication/json — IssueLinkType (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | IssueLinkType |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the issue link type name is in use.
* the user does not have the required permissions. | — |
GET/rest/api/3/issueLinkType/{issueLinkTypeId}Get issue link type
Parameters| Name | In | Required | Type |
|---|
issueLinkTypeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueLinkType |
400 | Returned if the issue link type ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the issue link type is not found.
* the user does not have the required permissions. | — |
PUT/rest/api/3/issueLinkType/{issueLinkTypeId}Update issue link type
Parameters| Name | In | Required | Type |
|---|
issueLinkTypeId | path | yes | string |
Request bodyapplication/json — IssueLinkType (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueLinkType |
400 | Returned if the issue link type ID or the request body are invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the issue link type is not found.
* the user does not have the required permissions. | — |
DELETE/rest/api/3/issueLinkType/{issueLinkTypeId}Delete issue link type
Parameters| Name | In | Required | Type |
|---|
issueLinkTypeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the issue link type ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the issue link type is not found.
* the user does not have the required permissions. | — |
Issue links3
This resource represents links between issues. Use it to get, create, and delete links between issues.
To use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
POST/rest/api/3/issueLinkCreate issue link
Request bodyapplication/json — LinkIssueRequestJsonBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | — |
400 | Returned if the comment is not created. The response contains an error message indicating why the comment wasn't created. The issue link is also not created. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the user cannot view one or both of the issues. For example, the user doesn't have *Browse project* project permission for a project containing one of the issues.
* the user does not have *link issues* project permission.
* either of the link issues are not found.
* the issue link type is not found. | — |
413 | Returned if the per-issue limit for issue links has been breached. | — |
GET/rest/api/3/issueLink/{linkId}Get issue link
Parameters| Name | In | Required | Type |
|---|
linkId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueLink |
400 | Returned if the issue link ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the issue link is not found.
* the user doesn't have the required permissions. | — |
DELETE/rest/api/3/issueLink/{linkId}Delete issue link
Parameters| Name | In | Required | Type |
|---|
linkId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | 200 response | — |
204 | Returned if the request is successful. | — |
400 | Returned if the issue link ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* issue linking is disabled.
* the issue link is not found.
* the user doesn't have the required permissions. | — |
Issue navigator settings2
This resource represents issue navigator settings. Use it to get and set issue navigator default columns.
GET/rest/api/3/settings/columnsGet issue navigator default columns
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
PUT/rest/api/3/settings/columnsSet issue navigator default columns
Request body*/* — ColumnRequestBody (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if invalid parameters are passed. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if a navigable field value is not found. | — |
Issue notification schemes8
This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes.
### About notification schemes ###
A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the `notificationSchemeEvents` object and contains pairs of `events` and `notifications`:
* `event` Identifies the type of event. The events can be [Jira system events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/) (see the *Events* section) or [custom events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/).
* `notifications` Identifies the [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients) of notifications for each event. Recipients can be any of the following types:
* `CurrentAssignee`
* `Reporter`
* `CurrentUser`
* `ProjectLead`
* `ComponentLead`
* `User` (the `parameter` is the user key)
* `Group` (the `parameter` is the group name)
* `ProjectRole` (the `parameter` is the project role ID)
* `EmailAddress` *(deprecated)*
* `AllWatchers`
* `UserCustomField` (the `parameter` is the ID of the custom field)
* `GroupCustomField`(the `parameter` is the ID of the custom field)
GET/rest/api/3/notificationschemeGet notification schemes paginated
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
id | query | no | array |
projectId | query | no | array |
onlyDefault | query | no | boolean |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. Only returns notification schemes that the user has permission to access. An empty list is returned if the user lacks permission to access all notification schemes. | PageBeanNotificationScheme |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/notificationschemeCreate notification scheme
Request bodyapplication/json — CreateNotificationSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | NotificationSchemeId |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
GET/rest/api/3/notificationscheme/projectGet projects using notification schemes paginated
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
notificationSchemeId | query | no | array |
projectId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanNotificationSchemeAndProjectMappingJsonBean |
400 | Returned if search criteria are invalid, strings vs numbers for projectId, notificationSchemeId, startAt and maxResult | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
GET/rest/api/3/notificationscheme/{id}Get notification scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | NotificationScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the notification scheme is not found or the user does not have permission to view it. | — |
PUT/rest/api/3/notificationscheme/{id}Update notification scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — UpdateNotificationSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the notification scheme isn't found. | ErrorCollection |
PUT/rest/api/3/notificationscheme/{id}/notificationAdd notifications to notification scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — AddNotificationsDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the notification scheme isn't found. | ErrorCollection |
DELETE/rest/api/3/notificationscheme/{notificationSchemeId}Delete notification scheme
Parameters| Name | In | Required | Type |
|---|
notificationSchemeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the notification scheme isn't found. | ErrorCollection |
DELETE/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}Remove notification from notification scheme
Parameters| Name | In | Required | Type |
|---|
notificationSchemeId | path | yes | string |
notificationId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if either the notification scheme or notification isn't found. | ErrorCollection |
Issue panels1
This resource supports bulk pinning and unpinning of [issue panels](https://developer.atlassian.com/platform/forge/) that are added by a Forge app. Only Jira administrators can use it.
POST/rest/api/3/forge/panel/action/bulk/asyncBulk pin or unpin issue panel to projects
Request bodyapplication/json — ForgePanelProjectPinRequest (required)
Responses| Status | Description | Schema |
|---|
202 | Accepted. Returns the task ID for polling progress. | ForgePanelProjectPinAsyncResponse |
400 | Returned if the request body is invalid. | ErrorCollection |
403 | Returned if the user does not have permission to administer Jira. | ErrorCollection |
500 | Returned if the task could not be submitted (server error). | ErrorCollection |
Issue priorities8
This resource represents issue priorities. Use it to get, create and update issue priorities and details for individual issue priorities.
GET/rest/api/3/priorityGet priorities
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/priorityCreate priority
Request bodyapplication/json — CreatePriorityDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | PriorityId |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
PUT/rest/api/3/priority/defaultSet default priority
Request bodyapplication/json — SetDefaultPriorityRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue priority isn't found. | ErrorCollection |
PUT/rest/api/3/priority/moveMove priorities
Request bodyapplication/json — ReorderIssuePriorities (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue priority isn't found. | ErrorCollection |
GET/rest/api/3/priority/searchSearch priorities
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
id | query | no | array |
projectId | query | no | array |
priorityName | query | no | string |
onlyDefault | query | no | boolean |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanPriority |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
GET/rest/api/3/priority/{id}Get priority
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Priority |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the issue priority isn't found. | — |
PUT/rest/api/3/priority/{id}Update priority
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — UpdatePriorityDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue priority isn't found. | ErrorCollection |
DELETE/rest/api/3/priority/{id}Delete priority
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue priority isn't found. | ErrorCollection |
409 | Returned if a task to delete the issue priority is already running. | ErrorCollection |
Issue properties8
This resource represents [issue](#api-group-Issues) properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as obtain details of all properties on an issue. Operations to bulk update and delete issue properties are also provided. Issue properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
POST/rest/api/3/issue/propertiesBulk set issues properties by list
Request bodyapplication/json — IssueEntityProperties (required)
Responses| Status | Description | Schema |
|---|
303 | Returned if the operation is successful. | — |
400 | Return if the request is invalid or the user does not have the necessary permission. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect. | ErrorCollection |
409 | Returned if another bulk update on the same issues is already in progress. Retry the request later. | ErrorCollection |
POST/rest/api/3/issue/properties/multiBulk set issue properties by issue
Request bodyapplication/json — MultiIssueEntityProperties (required)
Responses| Status | Description | Schema |
|---|
303 | Returned if the operation is successful. | — |
400 | Return if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect. | ErrorCollection |
403 | Return if the user does not have the necessary permission. | ErrorCollection |
409 | Returned if another bulk update on the same issues is already in progress. Retry the request later. | ErrorCollection |
PUT/rest/api/3/issue/properties/{propertyKey}Bulk set issue property
Parameters| Name | In | Required | Type |
|---|
propertyKey | path | yes | string |
Request bodyapplication/json — BulkIssuePropertyUpdateRequest (required)
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
DELETE/rest/api/3/issue/properties/{propertyKey}Bulk delete issue property
Parameters| Name | In | Required | Type |
|---|
propertyKey | path | yes | string |
Request bodyapplication/json — IssueFilterForBulkPropertyDelete (required)
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
GET/rest/api/3/issue/{issueIdOrKey}/propertiesGet issue property keys
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
404 | Returned if the issue is not found or the user does not have permissions to view the issue. | — |
GET/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}Get issue property
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue or property is not found or the user does not have permission to see the issue. | — |
PUT/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}Set issue property
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the issue property is updated. | — |
201 | Returned if the issue property is created. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to edit the issue. | — |
404 | Returned if the issue is not found or the user does not have permission to view the issue. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}Delete issue property
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue or property is not found, or the user does not have permission to edit the issue. | — |
Issue redaction2
This resource represents Issue Redaction. Provides APIs to redact issue data.
POST/rest/api/3/redactRedact
Request bodyapplication/json — BulkRedactionRequest (required)
Responses| Status | Description | Schema |
|---|
202 | Returned if the job submission is successful. The response contains the job id. | — |
400 | Returned if the redaction request is invalid. | ErrorCollection |
401 | Returned if the user / app is not authorised to redact data | — |
403 | Returned if the AGP subscription is not present. | ErrorCollection |
GET/rest/api/3/redact/status/{jobId}Get redaction status
Parameters| Name | In | Required | Type |
|---|
jobId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the job status is successfully retrieved. | RedactionJobStatusResponse |
403 | Returned if the AGP subscription is not present. | ErrorCollection |
404 | Returned if the job id is not found. | ErrorCollection |
Issue remote links6
This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier.
GET/rest/api/3/issue/{issueIdOrKey}/remotelinkGet remote issue links
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
globalId | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. A single RemoteIssueLink will be returned when specifying `globalId`, otherwise an array of RemoteIssueLink is returned. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if issue linking is disabled. | — |
404 | Returned if the issue or remote issue link is not found or the user does not have permission to view the issue. | — |
413 | Returned if the per-issue limit for remote links has been breached. | — |
POST/rest/api/3/issue/{issueIdOrKey}/remotelinkCreate or update remote issue link
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodyapplication/json — RemoteIssueLinkRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the remote issue link is updated. | RemoteIssueLinkIdentifies |
201 | Returned if the remote issue link is created. | RemoteIssueLinkIdentifies |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to link issues. | — |
404 | Returned if the issue is not found or the user does not have permission to view the issue. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/remotelinkDelete remote issue link by global ID
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
globalId | query | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if a global ID isn't provided. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to link issues. | — |
404 | Returned if the issue or remote issue link is not found or the user does not have permission to view the issue. | — |
GET/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}Get remote issue link by ID
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
linkId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | RemoteIssueLink |
400 | Returned if the link ID is invalid or the remote issue link does not belong to the issue. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if issue linking is disabled. | — |
404 | Returned if the issue or remote issue link is not found or the user does not have permission to view the issue. | — |
PUT/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}Update remote issue link by ID
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
linkId | path | yes | string |
Request bodyapplication/json — RemoteIssueLinkRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if:
* the link ID is invalid.
* the remote issue link does not belong to the issue.
* the request body is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to link issues. | — |
404 | Returned if the issue or remote issue link is not found or the user does not have permission to view the issue. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}Delete remote issue link by ID
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
linkId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the link ID is invalid or the remote issue link does not belong to the issue. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to link issues. | — |
404 | Returned if the issue or remote issue link is not found or the user does not have permission to view the issue. | — |
Issue resolutions8
This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values.
GET/rest/api/3/resolutionGet resolutions
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/resolutionCreate resolution
Request bodyapplication/json — CreateResolutionDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | ResolutionId |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
PUT/rest/api/3/resolution/defaultSet default resolution
Request bodyapplication/json — SetDefaultResolutionRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue resolution isn't found. | ErrorCollection |
PUT/rest/api/3/resolution/moveMove resolutions
Request bodyapplication/json — ReorderIssueResolutionsRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue resolution isn't found. | ErrorCollection |
GET/rest/api/3/resolution/searchSearch resolutions
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
id | query | no | array |
onlyDefault | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanResolutionJsonBean |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
GET/rest/api/3/resolution/{id}Get resolution
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Resolution |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue resolution value is not found. | — |
PUT/rest/api/3/resolution/{id}Update resolution
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — UpdateResolutionDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue resolution isn't found. | ErrorCollection |
DELETE/rest/api/3/resolution/{id}Delete resolution
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
replaceWith | query | yes | string |
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue resolution isn't found. | ErrorCollection |
409 | Returned if a task to delete the issue resolution is already running. | ErrorCollection |
Issue search7
This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker.
GET/rest/api/3/issue/pickerGet issue picker suggestions
Parameters| Name | In | Required | Type |
|---|
query | query | no | string |
currentJQL | query | no | string |
currentIssueKey | query | no | string |
currentProjectId | query | no | string |
showSubTasks | query | no | boolean |
showSubTaskParent | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssuePickerSuggestions |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/jql/matchCheck issues against JQL
Request bodyapplication/json — IssuesAndJQLQueries (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueMatches |
400 | Returned if `jqls` exceeds the maximum number of JQL queries or `issueIds` exceeds the maximum number of issue IDs. | — |
GET/rest/api/3/searchCurrently being removed. Search for issues using JQL (GET)
Parameters| Name | In | Required | Type |
|---|
jql | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
validateQuery | query | no | string |
fields | query | no | array |
expand | query | no | string |
properties | query | no | array |
fieldsByKeys | query | no | boolean |
failFast | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SearchResults |
400 | Returned if the JQL query is invalid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/searchCurrently being removed. Search for issues using JQL (POST)
Request bodyapplication/json — SearchRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SearchResults |
400 | Returned if the JQL query is invalid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/search/approximate-countCount issues using JQL
Request bodyapplication/json — JQLCountRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | JQLCountResultsBean |
400 | Returned if the JQL query cannot be parsed. | — |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/search/jqlSearch for issues using JQL enhanced search (GET)
Parameters| Name | In | Required | Type |
|---|
jql | query | no | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
fields | query | no | array |
expand | query | no | string |
properties | query | no | array |
fieldsByKeys | query | no | boolean |
failFast | query | no | boolean |
reconcileIssues | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SearchAndReconcileResults |
400 | Returned if the search request is invalid | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/search/jqlSearch for issues using JQL enhanced search (POST)
Request bodyapplication/json — SearchAndReconcileRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SearchAndReconcileResults |
400 | Returned if the search request is invalid | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
Issue security level2
This resource represents issue security levels. Use it to obtain the details of any issue security level. For more information about issue security levels, see [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg).
GET/rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/membersGet issue security level members by issue security scheme
Parameters| Name | In | Required | Type |
|---|
issueSecuritySchemeId | path | yes | integer |
startAt | query | no | integer |
maxResults | query | no | integer |
issueSecurityLevelId | query | no | array |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueSecurityLevelMember |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if no issue security level members are found. | — |
GET/rest/api/3/securitylevel/{id}Get issue security level
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SecurityLevel |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the issue security level is not found. | — |
Issue security schemes16
This resource represents issue security schemes. Use it to get an issue security scheme or a list of issue security schemes.
Issue security schemes control which users or groups of users can view an issue. When an issue security scheme is associated with a project, its security levels can be applied to issues in that project. Sub-tasks also inherit the security level of their parent issue.
GET/rest/api/3/issuesecurityschemesGet issue security schemes
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SecuritySchemes |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have permission to administer issue security schemes. | — |
POST/rest/api/3/issuesecurityschemesCreate issue security scheme
Request bodyapplication/json — CreateIssueSecuritySchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | SecuritySchemeId |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
GET/rest/api/3/issuesecurityschemes/levelGet issue security levels
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
id | query | no | array |
schemeId | query | no | array |
onlyDefault | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanSecurityLevel |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
PUT/rest/api/3/issuesecurityschemes/level/defaultSet default issue security levels
Request bodyapplication/json — SetDefaultLevelsRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue resolution isn't found. | ErrorCollection |
GET/rest/api/3/issuesecurityschemes/level/memberGet issue security level members
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
id | query | no | array |
schemeId | query | no | array |
levelId | query | no | array |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanSecurityLevelMember |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user doesn't have the necessary permission. | — |
GET/rest/api/3/issuesecurityschemes/projectGet projects using issue security schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
issueSecuritySchemeId | query | no | array |
projectId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueSecuritySchemeToProjectMapping |
400 | Returned if the search criteria is invalid.If you specify the project ID parameter | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
PUT/rest/api/3/issuesecurityschemes/projectAssociate security scheme to project
Request bodyapplication/json — AssociateSecuritySchemeWithProjectDetails (required)
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the security scheme isn't found. | ErrorCollection |
409 | Returned if a task to remove the issue security level is already running. | ErrorCollection |
GET/rest/api/3/issuesecurityschemes/searchSearch issue security schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
id | query | no | array |
projectId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanSecuritySchemeWithProjects |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user doesn't have the necessary permission. | — |
GET/rest/api/3/issuesecurityschemes/{id}Get issue security scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SecurityScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the administrator permission and the scheme is not used in any project where the user has administrative permission. | — |
PUT/rest/api/3/issuesecurityschemes/{id}Update issue security scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — UpdateIssueSecuritySchemeRequestBean (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue security scheme isn't found. | ErrorCollection |
DELETE/rest/api/3/issuesecurityschemes/{schemeId}Delete issue security scheme
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue security scheme isn't found. | ErrorCollection |
PUT/rest/api/3/issuesecurityschemes/{schemeId}/levelAdd issue security levels
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | string |
Request bodyapplication/json — AddSecuritySchemeLevelsRequestBean (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the security scheme isn't found. | ErrorCollection |
PUT/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}Update issue security level
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | string |
levelId | path | yes | string |
Request bodyapplication/json — UpdateIssueSecurityLevelDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue security level isn't found. | ErrorCollection |
DELETE/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}Remove issue security level
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | string |
levelId | path | yes | string |
replaceWith | query | no | string |
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if the request isn't valid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the issue security level isn't found. | ErrorCollection |
409 | Returned if a task to remove the issue security level is already running. | ErrorCollection |
PUT/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/memberAdd issue security level members
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | string |
levelId | path | yes | string |
Request bodyapplication/json — SecuritySchemeMembersRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the security scheme isn't found. | ErrorCollection |
DELETE/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}Remove member from issue security level
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | string |
levelId | path | yes | string |
memberId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user doesn't have the necessary permission. | ErrorCollection |
404 | Returned if the security scheme isn't found. | ErrorCollection |
Issue type properties4
This resource represents [issue type](#api-group-Issue-types) properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
GET/rest/api/3/issuetype/{issueTypeId}/propertiesGet issue type property keys
Parameters| Name | In | Required | Type |
|---|
issueTypeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
400 | Returned if the issue type ID is invalid. | — |
404 | Returned if:
* the issue type is not found.
* the user does not have the required permissions. | — |
GET/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}Get issue type property
Parameters| Name | In | Required | Type |
|---|
issueTypeId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
400 | Returned if the issue type ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue type or property is not found or the user does not have the required permissions. | — |
PUT/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}Set issue type property
Parameters| Name | In | Required | Type |
|---|
issueTypeId | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the issue type property is updated. | — |
201 | Returned if the issue type property is created. | — |
400 | Returned if:
* the issue type ID is invalid.
* a property value is not provided.
* the property value JSON content is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to modify the issue type. | — |
404 | Returned if:
* the issue type is not found.
* the user does not have the permission view the issue type. | — |
DELETE/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}Delete issue type property
Parameters| Name | In | Required | Type |
|---|
issueTypeId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the issue type property is deleted. | — |
400 | Returned if the issue type ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the issue type or property is not found. | — |
Issue type schemes10
This resource represents issue type schemes in classic projects. Use it to:
* get issue type schemes and a list of the projects that use them.
* associate issue type schemes with projects.
* add issue types to issue type schemes.
* delete issue types from issue type schemes.
* create, update, and delete issue type schemes.
* change the order of issue types in issue type schemes.
GET/rest/api/3/issuetypeschemeGet all issue type schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
orderBy | query | no | string |
expand | query | no | string |
queryString | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueTypeScheme |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
POST/rest/api/3/issuetypeschemeCreate issue type scheme
Request bodyapplication/json — IssueTypeSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | IssueTypeSchemeID |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
409 | Returned if the scheme name is used by another scheme. | — |
GET/rest/api/3/issuetypescheme/mappingGet issue type scheme items
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
issueTypeSchemeId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueTypeSchemeMapping |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
GET/rest/api/3/issuetypescheme/projectGet issue type schemes for projects
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueTypeSchemeProjects |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
PUT/rest/api/3/issuetypescheme/projectAssign issue type scheme to project
Request bodyapplication/json — IssueTypeSchemeProjectAssociation (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type scheme or the project is not found. | — |
PUT/rest/api/3/issuetypescheme/{issueTypeSchemeId}Update issue type scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeSchemeId | path | yes | integer |
Request bodyapplication/json — IssueTypeSchemeUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type scheme is not found. | — |
DELETE/rest/api/3/issuetypescheme/{issueTypeSchemeId}Delete issue type scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeSchemeId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the issue type scheme is deleted. | — |
400 | Returned if the request is to delete the default issue type scheme or if the scheme is associated with a project | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type scheme is not found. | — |
PUT/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetypeAdd issue types to issue type scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeSchemeId | path | yes | integer |
Request bodyapplication/json — IssueTypeIds (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type or the issue type scheme is not found. | — |
PUT/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/moveChange order of issue types
Parameters| Name | In | Required | Type |
|---|
issueTypeSchemeId | path | yes | integer |
Request bodyapplication/json — OrderOfIssueTypes (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type scheme is not found. | — |
DELETE/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}Remove issue type from issue type scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeSchemeId | path | yes | integer |
issueTypeId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type scheme is missing or the issue type is not found in the issue type scheme. | — |
Issue type screen schemes11
This resource represents issue type screen schemes. Use it to:
* get issue type screen schemes and a list of the projects that use them.
* create issue type screen schemes.
* update issue type screen schemes.
* delete issue type screen schemes.
* associate issue type screen schemes with projects.
* append issue type to screen scheme mappings to issue type screen schemes.
* remove issue type to screen scheme mappings from issue type screen schemes.
* update default screen scheme of issue type screen scheme.
GET/rest/api/3/issuetypescreenschemeGet issue type screen schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
queryString | query | no | string |
orderBy | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueTypeScreenScheme |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
POST/rest/api/3/issuetypescreenschemeCreate issue type screen scheme
Request bodyapplication/json — IssueTypeScreenSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | IssueTypeScreenSchemeId |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type or screen scheme is not found. | — |
409 | Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings. | — |
GET/rest/api/3/issuetypescreenscheme/mappingGet issue type screen scheme items
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
issueTypeScreenSchemeId | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueTypeScreenSchemeItem |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
GET/rest/api/3/issuetypescreenscheme/projectGet issue type screen schemes for projects
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
projectId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanIssueTypeScreenSchemesProjects |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
PUT/rest/api/3/issuetypescreenscheme/projectAssign issue type screen scheme to project
Request bodyapplication/json — IssueTypeScreenSchemeProjectAssociation (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if:
* project is not found.
* issue type screen scheme is not found.
* the project is not a classic project. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type screen scheme or the project are missing. | — |
PUT/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}Update issue type screen scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeScreenSchemeId | path | yes | string |
Request bodyapplication/json — IssueTypeScreenSchemeUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type screen scheme is not found. | — |
DELETE/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}Delete issue type screen scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeScreenSchemeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the issue type screen scheme is deleted. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type screen scheme is not found. | — |
PUT/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mappingAppend mappings to issue type screen scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeScreenSchemeId | path | yes | string |
Request bodyapplication/json — IssueTypeScreenSchemeMappingDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type screen scheme, issue type, or screen scheme is not found. | — |
409 | Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings. | — |
PUT/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/defaultUpdate issue type screen scheme default screen scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeScreenSchemeId | path | yes | string |
Request bodyapplication/json — UpdateDefaultScreenScheme (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type screen scheme or the screen scheme is not found, or the screen scheme isn't used in classic projects. | — |
POST/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/removeRemove mappings from issue type screen scheme
Parameters| Name | In | Required | Type |
|---|
issueTypeScreenSchemeId | path | yes | string |
Request bodyapplication/json — IssueTypeIds (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the screen scheme mappings are removed from the issue type screen scheme. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the issue type screen scheme or one or more issue type mappings are not found. | — |
GET/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/projectGet issue type screen scheme projects
Parameters| Name | In | Required | Type |
|---|
issueTypeScreenSchemeId | path | yes | integer |
startAt | query | no | integer |
maxResults | query | no | integer |
query | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanProjectDetails |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
Issue types8
This resource represents issues types. Use it to:
* get, create, update, and delete issue types.
* get all issue types for a user.
* get alternative issue types.
* set an avatar for an issue type.
GET/rest/api/3/issuetypeGet all issue types for user
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
POST/rest/api/3/issuetypeCreate issue type
Request bodyapplication/json — IssueTypeCreateBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | IssueTypeDetails |
400 | Returned if the request is invalid because:
* no content is sent.
* the issue type name exceeds 60 characters.
* a subtask issue type is requested on an instance where subtasks are disabled. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
409 | Returned if the issue type name is in use. | — |
GET/rest/api/3/issuetype/projectGet issue types for project
Parameters| Name | In | Required | Type |
|---|
projectId | query | yes | integer |
level | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
404 | Returned if:
* the project is not found.
* the user does not have the necessary permission. | — |
GET/rest/api/3/issuetype/{id}Get issue type
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueTypeDetails |
400 | Returned if the issue type ID is invalid. | — |
404 | Returned if:
* the issue type is not found.
* the user does not have the required permissions. | — |
PUT/rest/api/3/issuetype/{id}Update issue type
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — IssueTypeUpdateBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueTypeDetails |
400 | Returned if the request is invalid because:
* no content is sent.
* the issue type name exceeds 60 characters.
* the avatar is not associated with this issue type. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the issue type is not found. | — |
409 | Returned if the issue type name is in use. | — |
DELETE/rest/api/3/issuetype/{id}Delete issue type
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
alternativeIssueTypeId | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if any issues cannot be updated with the alternative issue type. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if:
* the issue type is in use and an alternative issue type is not specified.
* the issue type or alternative issue type is not found. | — |
409 | Returned if the issue type is in use and:
* also specified as the alternative issue type.
* is a *standard* issue type and the alternative issue type is a *subtask*. | — |
423 | Returned if a resource related to deletion is locked. | — |
GET/rest/api/3/issuetype/{id}/alternativesGet alternative issue types
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
404 | Returned if:
* the issue type is not found.
* the user does not have the required permissions. | — |
POST/rest/api/3/issuetype/{id}/avatar2Load issue type avatar
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
x | query | no | integer |
y | query | no | integer |
size | query | yes | integer |
Request body*/* (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Avatar |
400 | Returned if:
* an image isn't included in the request.
* the image type is unsupported.
* the crop parameters extend the crop area beyond the edge of the image.
* `cropSize` is missing.
* the issue type ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the issue type is not found. | — |
Issue votes3
This resource represents votes cast by users on an issue. Use it to get details of votes on an issue as well as cast and withdrawal votes.
GET/rest/api/3/issue/{issueIdOrKey}/votesGet votes
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Votes |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* voting is disabled.
* the user does not have permission to view the issue.
* the issue is not found. | — |
POST/rest/api/3/issue/{issueIdOrKey}/votesAdd vote
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* voting is disabled.
* the issue is not found. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/votesDelete vote
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* voting is disabled.
* the user has not voted on the issue.
* the issue is not found. | — |
Issue watchers4
This resource represents users watching an issue. Use it to get details of users watching an issue as well as start and stop a user watching an issue.
POST/rest/api/3/issue/watchingGet is watching issue bulk
Request bodyapplication/json — IssueList (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful | BulkIssueIsWatching |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/issue/{issueIdOrKey}/watchersGet issue watchers
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful | Watchers |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
POST/rest/api/3/issue/{issueIdOrKey}/watchersAdd watcher
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the permission to manage the watcher list. | — |
404 | Returned if the issue or the user is not found or the user does not have permission to view the issue. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/watchersDelete watcher
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
username | query | no | string |
accountId | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if `accountId` is not supplied. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the permission to manage the watcher list. | — |
404 | Returned if the issue or the user is not found or the user does not have permission to view the issue. | — |
Issue worklog properties4
This resource represents [issue worklog](#api-group-Issue-worklogs) properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete issue worklog properties as well as obtain the keys of all properties on a issue worklog. Issue worklog properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
GET/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/propertiesGet worklog property keys
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
worklogId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
400 | Returned if the worklog ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the issue or worklog is not found.
* the user does not have permission to view the issue or worklog. | — |
GET/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}Get worklog property
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
worklogId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
400 | Returned if the worklog ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the issue, worklog, or property is not found.
* the user does not have permission to view the issue or worklog. | — |
PUT/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}Set worklog property
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
worklogId | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the worklog property is updated. | — |
201 | Returned if the worklog property is created. | — |
400 | Returned if the worklog ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to edit the worklog. | — |
404 | Returned if:
* the issue or worklog is not found.
* the user does not have permission to view the issue or worklog. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}Delete worklog property
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
worklogId | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the worklog property is removed. | — |
400 | Returned if the worklog key or id is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to edit the worklog. | — |
404 | Returned if:
* the issue, worklog, or property is not found.
* the user does not have permission to view the issue or worklog. | — |
Issue worklogs10
This resource represents issue worklogs. Use it to:
* get, create, update, and delete worklogs.
* obtain lists of updated or deleted worklogs.
GET/rest/api/3/issue/{issueIdOrKey}/worklogGet issue worklogs
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
startedAfter | query | no | integer |
startedBefore | query | no | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful | PageOfWorklogs |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the issue is not found or the user does not have permission to view the issue.
* `startAt` or `maxResults` has non-numeric values.
* time tracking is disabled. | — |
POST/rest/api/3/issue/{issueIdOrKey}/worklogAdd worklog
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
notifyUsers | query | no | boolean |
adjustEstimate | query | no | string |
newEstimate | query | no | string |
reduceBy | query | no | string |
expand | query | no | string |
overrideEditableFlag | query | no | boolean |
Request bodyapplication/json — Worklog (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Worklog |
400 | Returned if:
* `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.
* `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.
* the user does not have permission to add the worklog.
* the request JSON is malformed. | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
413 | Returned if the per-issue limit has been breached for one of the following fields:
* worklogs
* attachments | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/worklogBulk delete worklogs
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
adjustEstimate | query | no | string |
overrideEditableFlag | query | no | boolean |
Request bodyapplication/json — WorklogIdsRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the bulk deletion request was partially successful, with a message indicating partial success. | — |
204 | Returned if the request is successful. | — |
400 | Returned if:
* `request` is not provided or is invalid
* the user does not have permission to delete the worklogs
* the number of worklogs being deleted exceeds the limit | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if:
* the issue is not found or user does not have permission to view the issue
* at least one of the worklogs is not associated with the provided issue
* time tracking is disabled | — |
POST/rest/api/3/issue/{issueIdOrKey}/worklog/moveBulk move worklogs
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
adjustEstimate | query | no | string |
overrideEditableFlag | query | no | boolean |
Request bodyapplication/json — WorklogsMoveRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is partially successful. | — |
204 | Returned if the request is successful. | — |
400 | Returned if:
* `request` is not provided or is invalid
* the user does not have permission to move the worklogs
* the number of worklogs being moved exceeds the limit
* the total size of worklogs being moved is too large
* any worklog contains attachments | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if:
* the source or destination issue is not found or the user does not have permission to view the issues
* at least one of the worklogs is not associated with the provided issue
* time tracking is disabled | — |
GET/rest/api/3/issue/{issueIdOrKey}/worklog/{id}Get worklog
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
id | path | yes | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Worklog |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if:
* the issue is not found or the user does not have permission to view it.
* the worklog is not found or the user does not have permission to view it.
* time tracking is disabled.
. | — |
PUT/rest/api/3/issue/{issueIdOrKey}/worklog/{id}Update worklog
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
id | path | yes | string |
notifyUsers | query | no | boolean |
adjustEstimate | query | no | string |
newEstimate | query | no | string |
expand | query | no | string |
overrideEditableFlag | query | no | boolean |
Request bodyapplication/json — Worklog (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful | Worklog |
400 | Returned if:
* `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.
* the user does not have permission to update the worklog.
* the request JSON is malformed. | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if:
* the issue is not found or user does not have permission to view the issue.
* the worklog is not found or the user does not have permission to view it.
* time tracking is disabled. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}/worklog/{id}Delete worklog
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
id | path | yes | string |
notifyUsers | query | no | boolean |
adjustEstimate | query | no | string |
newEstimate | query | no | string |
increaseBy | query | no | string |
overrideEditableFlag | query | no | boolean |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if:
* `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.
* `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.
* the user does not have permission to delete the worklog. | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if:
* the issue is not found or user does not have permission to view the issue.
* the worklog is not found or the user does not have permission to view it.
* time tracking is disabled. | — |
GET/rest/api/3/worklog/deletedGet IDs of deleted worklogs
Parameters| Name | In | Required | Type |
|---|
since | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ChangedWorklogs |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/worklog/listGet worklogs
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Request bodyapplication/json — WorklogIdsRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request contains more than 1000 worklog IDs or is empty. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/worklog/updatedGet IDs of updated worklogs
Parameters| Name | In | Required | Type |
|---|
since | query | no | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ChangedWorklogs |
401 | Returned if the authentication credentials are incorrect or missing. | — |
Issues23
This resource represents Jira issues. Use it to:
* create or edit issues, individually or in bulk.
* retrieve metadata about the options for creating or editing issues.
* delete an issue.
* assign a user to an issue.
* get issue changelogs.
* send notifications about an issue.
* get details of the transitions available for an issue.
* transition an issue.
* Archive issues.
* Unarchive issues.
* Export archived issues.
POST/rest/api/3/changelog/bulkfetchBulk fetch changelogs
Request bodyapplication/json — BulkChangelogRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkChangelogResponseBean |
400 | Returned if there are input validation problems such as no issue IDs/keys were present, or more than 1000 issue IDs/keys were requested. | — |
GET/rest/api/3/eventsGet events
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to complete this request. | — |
POST/rest/api/3/issueCreate issue
Parameters| Name | In | Required | Type |
|---|
updateHistory | query | no | boolean |
Request bodyapplication/json — IssueUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | CreatedIssue |
400 | Returned if the request:
* is missing required fields.
* contains invalid field values.
* contains fields that cannot be set for the issue type.
* is by a user who does not have the necessary permission.
* is to create a subtype in a project different that of the parent issue.
* is for a subtask when the option to create subtasks is disabled.
* is invalid for any other reason. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
422 | Returned if a configuration problem prevents the creation of the issue. | ErrorCollection |
POST/rest/api/3/issue/archiveArchive issue(s) by JQL
Request bodyapplication/json — ArchiveIssueAsyncRequest (required)
Responses| Status | Description | Schema |
|---|
202 | Returns the URL to check the status of the submitted request. | — |
400 | Returned if no issues were archived due to a bad request, for example an invalid JQL query. | — |
401 | Returned if no issues were archived because the provided authentication credentials are either missing or invalid. | — |
403 | Returned if no issues were archived because the user lacks the required Jira admin or site admin permissions. | — |
412 | Returned if a request to archive issue(s) is already running. | — |
PUT/rest/api/3/issue/archiveArchive issue(s) by issue ID/key
Request bodyapplication/json — IssueArchivalSyncRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if there is at least one valid issue to archive in the request. The return message will include the count of archived issues and subtasks, as well as error details for issues which failed to get archived. | IssueArchivalSyncResponse |
400 | Returned if none of the issues in the request can be archived. Possible reasons:
* the issues weren't found
* the issues are subtasks
* the issues belong to unlicensed projects
* the issues belong to archived projects | — |
401 | Returned if no issues were archived because the provided authentication credentials are either missing or invalid. | — |
403 | Returned if no issues were archived because the user lacks the required Jira admin or site admin permissions. | — |
412 | Returned if one or more issues were successfully archived, but the operation was incomplete because the number of issue IDs or keys provided exceeds 1000. | — |
POST/rest/api/3/issue/bulkBulk create issue
Request bodyapplication/json — IssuesUpdateBean (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if any of the issue or subtask creation requests were successful. A request may be unsuccessful when it:
* is missing required fields.
* contains invalid field values.
* contains fields that cannot be set for the issue type.
* is by a user who does not have the necessary permission.
* is to create a subtype in a project different that of the parent issue.
* is for a subtask when the option to create subtasks is disabled.
* is invalid for any other reason. | CreatedIssues |
400 | Returned if all requests are invalid. Requests may be unsuccessful when they:
* are missing required fields.
* contain invalid field values.
* contain fields that cannot be set for the issue type.
* are by a user who does not have the necessary permission.
* are to create a subtype in a project different that of the parent issue.
* is for a subtask when the option to create subtasks is disabled.
* are invalid for any other reason. | CreatedIssues |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/issue/bulkfetchBulk fetch issues
Request bodyapplication/json — BulkFetchIssueRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. A response may contain both successful issues and issue errors. | BulkIssueResults |
400 | Returned if no issue IDs/keys were present, or more than 100 issue IDs/keys were requested. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/issue/createmetaGet create issue metadata
Parameters| Name | In | Required | Type |
|---|
projectIds | query | no | array |
projectKeys | query | no | array |
issuetypeIds | query | no | array |
issuetypeNames | query | no | array |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueCreateMetadata |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypesGet create metadata issue types for a project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageOfCreateMetaIssueTypes |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}Get create field metadata for a project and issue type id
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
issueTypeId | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageOfCreateMetaIssueTypeWithField |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/issue/limit/reportGet issue limit report
Parameters| Name | In | Required | Type |
|---|
isReturningKeys | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueLimitReportResponseBean |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to complete this request. | — |
PUT/rest/api/3/issue/unarchiveUnarchive issue(s) by issue keys/ID
Request bodyapplication/json — IssueArchivalSyncRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if there is at least one valid issue to unarchive in the request. It will return the count of unarchived issues, which also includes the count of the subtasks unarchived, and it will show the detailed errors for those issues which are not unarchived. | IssueArchivalSyncResponse |
400 | Returned if none of the issues in the request are eligible to be unarchived. Possible reasons:
* the issues weren't found
* the issues are subtasks
* the issues belong to archived projects | — |
401 | Returned if no issues were unarchived because the provided authentication credentials are either missing or invalid. | — |
403 | Returned if no issues were unarchived because the user lacks the required Jira admin or site admin permissions. | — |
412 | Returned if one or more issues were successfully unarchived, but the operation was incomplete because the number of issue IDs or keys provided exceeds 1000. | — |
GET/rest/api/3/issue/{issueIdOrKey}Get issue
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
fields | query | no | array |
fieldsByKeys | query | no | boolean |
expand | query | no | string |
properties | query | no | array |
updateHistory | query | no | boolean |
failFast | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueBean |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
PUT/rest/api/3/issue/{issueIdOrKey}Edit issue
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
notifyUsers | query | no | boolean |
overrideScreenSecurity | query | no | boolean |
overrideEditableFlag | query | no | boolean |
returnIssue | query | no | boolean |
expand | query | no | string |
Request bodyapplication/json — IssueUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful and the `returnIssue` parameter is `true` | — |
204 | Returned if the request is successful. | — |
400 | Returned if:
* the request body is missing.
* the user does not have the necessary permission to edit one or more fields.
* the request includes one or more fields that don't exist or aren't associated with the project and issue type.
* the request includes an invalid transition. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user uses `overrideScreenSecurity` or `overrideEditableFlag` but doesn't have the necessary permission. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
409 | Returned if the issue could not be updated due to a conflicting update. | — |
422 | Returned if a configuration problem prevents the issue being updated. | — |
DELETE/rest/api/3/issue/{issueIdOrKey}Delete issue
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
deleteSubtasks | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the issue has subtasks and `deleteSubtasks` is not set to *true*. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have permission to delete the issue. | — |
404 | Returned if the issue is not found or the user does not have permission to view the issue. | — |
PUT/rest/api/3/issue/{issueIdOrKey}/assigneeAssign issue
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodyapplication/json — User (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if:
* the user is not found.
* `name`, `key`, or `accountId` is missing.
* more than one of `name`, `key`, and `accountId` are provided. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the issue is not found. | — |
GET/rest/api/3/issue/{issueIdOrKey}/changelogGet changelogs
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanChangelog |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
POST/rest/api/3/issue/{issueIdOrKey}/changelog/listGet changelogs by IDs
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodyapplication/json — IssueChangelogIds (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageOfChangelogs |
400 | Returned if the request is not valid. | — |
404 | Returned if the issue is not found or the user does not have the necessary permission. | — |
GET/rest/api/3/issue/{issueIdOrKey}/editmetaGet edit issue metadata
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
overrideScreenSecurity | query | no | boolean |
overrideEditableFlag | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueUpdateMetadata |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user uses an override parameter but doesn't have permission to do so. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
POST/rest/api/3/issue/{issueIdOrKey}/notifySend notification for issue
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodyapplication/json — Notification (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the email is queued for sending. | — |
400 | Returned if:
* the recipient is the same as the calling user.
* the recipient is invalid. For example, the recipient is set to the assignee, but the issue is unassigned.
* the issueIdOrKey is of an invalid/null issue.
* the request is invalid. For example, required fields are missing or have invalid values. | — |
403 | Returned if:
* outgoing emails are disabled.
* no SMTP server is configured. | — |
404 | Returned if the issue is not found. | — |
GET/rest/api/3/issue/{issueIdOrKey}/transitionsGet transitions
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
expand | query | no | string |
transitionId | query | no | string |
skipRemoteOnlyCondition | query | no | boolean |
includeUnavailableTransitions | query | no | boolean |
sortByOpsBarAndStatus | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Transitions |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
POST/rest/api/3/issue/{issueIdOrKey}/transitionsTransition issue
Parameters| Name | In | Required | Type |
|---|
issueIdOrKey | path | yes | string |
Request bodyapplication/json — IssueUpdateDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if:
* no transition is specified.
* the user does not have permission to transition the issue.
* a field that isn't included on the transition screen is defined in `fields` or `update`.
* a field is specified in both `fields` and `update`.
* the request is invalid for any other reason. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue is not found or the user does not have permission to view it. | — |
409 | Returned if the issue could not be updated due to a conflicting update. | — |
413 | Returned if a per-issue limit has been breached for one of the following fields:
* comments
* worklogs
* attachments
* issue links
* remote issue links | — |
422 | Returned if a configuration problem prevents the creation of the issue. | — |
PUT/rest/api/3/issues/archive/exportExport archived issue(s)
Request bodyapplication/json — ArchivedIssuesFilterRequest (required)
Responses| Status | Description | Schema |
|---|
202 | Returns the details of your export task. You can use the [get task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) API to view the progress of your request. | ExportArchivedIssuesTaskProgressResponse |
400 | Returned when:
* The request is invalid, or the filters provided are incorrect
* You requested too many issues for export. The limit is one million issues per request | — |
401 | Returned if no issues were unarchived because the provided authentication credentials are either missing or invalid. | — |
403 | Returned if no issues were unarchived because the user lacks the required Jira admin or site admin permissions. | — |
412 | Returned if a request to export archived issues is already running. | — |
JQL6
This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom query builders. It also provides operations to:
* convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.
* convert readable details in one or more JQL queries to IDs where a user doesn't have permission to view the entity whose details are readable.
GET/rest/api/3/jql/autocompletedataGet field reference data (GET)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | JQLReferenceData |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/jql/autocompletedataGet field reference data (POST)
Request bodyapplication/json — SearchAutoCompleteFilter (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | JQLReferenceData |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/jql/autocompletedata/suggestionsGet field auto complete suggestions
Parameters| Name | In | Required | Type |
|---|
fieldName | query | no | string |
fieldValue | query | no | string |
predicateName | query | no | string |
predicateValue | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | AutoCompleteSuggestions |
400 | Returned if an invalid combination of parameters is passed. | — |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/jql/parseParse JQL query
Parameters| Name | In | Required | Type |
|---|
validation | query | yes | string |
Request bodyapplication/json — JqlQueriesToParse (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ParsedJqlQueries |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/jql/pdcleanerConvert user identifiers to account IDs in JQL queries
Request bodyapplication/json — JQLPersonalDataMigrationRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. Note that the JQL queries are returned in the same order that they were passed. | ConvertedJQLQueries |
400 | Returned if at least one of the queries cannot be converted. For example, the JQL has invalid operators or invalid keywords, or the users in the query cannot be found. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/jql/sanitizeSanitize JQL queries
Request bodyapplication/json — JqlQueriesToSanitize (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SanitizedJqlQueries |
400 | Returned if the request is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
JQL functions (apps)3
This resource represents JQL function's precomputations. Precomputation is a mapping between custom function call and JQL fragment returned by this function. Use it to get and update precomputations.
GET/rest/api/3/jql/function/computationGet precomputations (apps)
Parameters| Name | In | Required | Type |
|---|
functionKey | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
orderBy | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBean2JqlFunctionPrecomputationBean |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request is not authenticated as the app that provided the function. | — |
404 | Returned if the function is not found. | — |
POST/rest/api/3/jql/function/computationUpdate precomputations (apps)
Parameters| Name | In | Required | Type |
|---|
skipNotFoundPrecomputations | query | no | boolean |
Request bodyapplication/json — JqlFunctionPrecomputationUpdateRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | 200 response | JqlFunctionPrecomputationUpdateResponse |
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | JqlFunctionPrecomputationUpdateErrorResponse |
403 | Returned if the request is not authenticated as the app that provided the function. | JqlFunctionPrecomputationUpdateErrorResponse |
404 | Returned if the function is not found. | JqlFunctionPrecomputationUpdateErrorResponse |
POST/rest/api/3/jql/function/computation/searchGet precomputations by ID (apps)
Parameters| Name | In | Required | Type |
|---|
orderBy | query | no | string |
Request bodyapplication/json — JqlFunctionPrecomputationGetByIdRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | JqlFunctionPrecomputationGetByIdResponse |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request is not authenticated as the app that provided the function. | — |
404 | Returned if the function is not found. | — |
Jira expressions3
This resource is a collection of operations for [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
POST/rest/api/3/expression/analyseAnalyse Jira expression
Parameters| Name | In | Required | Type |
|---|
check | query | no | string |
Request bodyapplication/json — JiraExpressionForAnalysis (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | JiraExpressionsAnalysis |
400 | 400 response | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | 404 response | ErrorCollection |
POST/rest/api/3/expression/evalCurrently being removed. Evaluate Jira expression
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Request bodyapplication/json — JiraExpressionEvalRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object. | JiraExpressionResult |
400 | Returned if:
* the request is invalid, that is:
* invalid data is provided, such as a request including issue ID and key.
* the expression is invalid and can not be parsed.
* evaluation fails at runtime. This may happen for various reasons. For example, accessing a property on a null object (such as the expression `issue.id` where `issue` is `null`). In this case an error message is provided. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if any object provided in the request context is not found or the user does not have permission to view it. | ErrorCollection |
POST/rest/api/3/expression/evaluateEvaluate Jira expression using enhanced search API
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Request bodyapplication/json — JiraExpressionEvaluateRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object. | JExpEvaluateJiraExpressionResultBean |
400 | Returned if:
* the request is invalid, that is:
* invalid data is provided, such as a request including issue ID and key.
* the expression is invalid and can not be parsed.
* evaluation fails at runtime. This may happen for various reasons. For example, accessing a property on a null object (such as the expression `issue.id` where `issue` is `null`). In this case an error message is provided.
* If jql is unbounded or empty.
* If nextPageToken is invalid | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if any object provided in the request context is not found or the user does not have permission to view it. | ErrorCollection |
Jira settings4
This resource represents various settings in Jira. Use it to get and update Jira settings and properties.
GET/rest/api/3/application-propertiesGet application property
Parameters| Name | In | Required | Type |
|---|
key | query | no | string |
permissionLevel | query | no | string |
keyFilter | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the application property is not found or the user does not have permission to view it. | ErrorCollection |
GET/rest/api/3/application-properties/advanced-settingsGet advanced settings
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user is not an administrator. | — |
PUT/rest/api/3/application-properties/{id}Set application property
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — SimpleApplicationPropertyBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ApplicationProperty |
400 | Returned if the data type of the `value` does not match the application property's data type. For example, a string is provided instead of an integer. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have permission to edit the property. | ErrorCollection |
404 | Returned if the property is not found or the user does not have permission to view it. | ErrorCollection |
GET/rest/api/3/configurationGet global settings
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Configuration |
401 | Returned if the authentication credentials are incorrect or missing. | — |
Labels1
This resource represents available labels. Use it to get available labels for the global label field.
GET/rest/api/3/labelGet all labels
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanString |
License metrics3
This resource represents license metrics. Use it to get available metrics for Jira licences.
GET/rest/api/3/instance/licenseGet license
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | License |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/license/approximateLicenseCountGet approximate license count
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | LicenseMetric |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollections |
403 | Returned if the user does not have permission to complete this request. | ErrorCollections |
GET/rest/api/3/license/approximateLicenseCount/product/{applicationKey}Get approximate application license count
Parameters| Name | In | Required | Type |
|---|
applicationKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | LicenseMetric |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have permission to complete this request. | ErrorCollection |
Migration of Connect modules to Forge2
This resource supports the migration of some Connect modules to their equivalent Forge modules.
GET/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/taskGet Connect issue field migration task
Parameters| Name | In | Required | Type |
|---|
connectKey | path | yes | string |
jiraIssueFieldsKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful and a migration task is found. | TaskProgress |
401 | Returned if the authentication credentials are incorrect or missing. | OperationMessage |
404 | Returned if:
* no migrated Forge module with the given key is found.
* no ongoing migration task exists for the custom field. | OperationMessage |
POST/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/taskSubmit Connect issue field migration task
Parameters| Name | In | Required | Type |
|---|
connectKey | path | yes | string |
jiraIssueFieldsKey | path | yes | string |
retriggerCompletedMigration | query | no | boolean |
Responses| Status | Description | Schema |
|---|
202 | Returned if the migration task was submitted successfully. | — |
401 | Returned if the authentication credentials are incorrect or missing. | OperationMessage |
404 | Returned if no migrated Forge module with the given key is found. | OperationMessage |
409 | Returned if a migration task is already in progress for the field. | OperationMessage |
Myself6
This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale.
GET/rest/api/3/mypreferencesGet preference
Parameters| Name | In | Required | Type |
|---|
key | query | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the key is not provided or not found. | — |
PUT/rest/api/3/mypreferencesSet preference
Parameters| Name | In | Required | Type |
|---|
key | query | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the key or value is not provided or invalid. | — |
DELETE/rest/api/3/mypreferencesDelete preference
Parameters| Name | In | Required | Type |
|---|
key | query | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the key is not provided or not found. | — |
GET/rest/api/3/mypreferences/localeGet locale
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Locale |
401 | Returned if the authentication credentials are incorrect or missing. | — |
PUT/rest/api/3/mypreferences/localeSet locale
Request bodyapplication/json — Locale (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/myselfGet current user
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | User |
401 | Returned if the authentication credentials are incorrect or missing. | — |
Permission schemes9
This resource represents permission schemes. Use it to get, create, update, and delete permission schemes as well as get, create, update, and delete details of the permissions granted in those schemes.
GET/rest/api/3/permissionschemeGet all permission schemes
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermissionSchemes |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/permissionschemeCreate permission scheme
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Request bodyapplication/json — PermissionScheme (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the permission scheme is created. | PermissionScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or the feature is not available in the Jira plan. | — |
GET/rest/api/3/permissionscheme/{schemeId}Get permission scheme
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermissionScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the permission scheme is not found or the user does not have the necessary permission. | — |
PUT/rest/api/3/permissionscheme/{schemeId}Update permission scheme
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
expand | query | no | string |
Request bodyapplication/json — PermissionScheme (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the scheme is updated. | PermissionScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if:
* the user does not have the necessary permission to update permission schemes.
* the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be updated on free plans. | — |
404 | Returned if the permission scheme is not found. | — |
DELETE/rest/api/3/permissionscheme/{schemeId}Delete permission scheme
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the permission scheme is deleted. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the permission scheme is not found. | — |
GET/rest/api/3/permissionscheme/{schemeId}/permissionGet permission scheme grants
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermissionGrants |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the permission schemes is not found or the user does not have the necessary permission. | — |
POST/rest/api/3/permissionscheme/{schemeId}/permissionCreate permission grant
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
expand | query | no | string |
Request bodyapplication/json — PermissionGrant (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the scheme permission is created. | PermissionGrant |
400 | Returned if the value for expand is invalid or the same permission grant is present. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}Get permission scheme grant
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
permissionId | path | yes | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermissionGrant |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the permission scheme or permission grant is not found or the user does not have the necessary permission. | — |
DELETE/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}Delete permission scheme grant
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
permissionId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the permission grant is deleted. | — |
400 | Returned if permission grant with the provided ID is not found. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
Permissions4
This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.
GET/rest/api/3/mypermissionsGet my permissions
Parameters| Name | In | Required | Type |
|---|
projectKey | query | no | string |
projectId | query | no | string |
issueKey | query | no | string |
issueId | query | no | string |
permissions | query | no | string |
projectUuid | query | no | string |
projectConfigurationUuid | query | no | string |
commentId | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Permissions |
400 | Returned if `permissions` is empty, contains an invalid key, or does not equal BROWSE\_PROJECTS when commentId is provided. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
404 | Returned if the project or issue is not found or the user does not have permission to view the project or issue. | ErrorCollection |
GET/rest/api/3/permissionsGet all permissions
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Permissions |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
POST/rest/api/3/permissions/checkGet bulk permissions
Request bodyapplication/json — BulkPermissionsRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkPermissionGrants |
400 | Returned if:
* `projectPermissions` is provided without at least one project permission being provided.
* an invalid global permission is provided in the global permissions list.
* an invalid project permission is provided in the project permissions list.
* more than 1000 valid project IDs or more than 1000 valid issue IDs are provided.
* an invalid account ID is provided. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
POST/rest/api/3/permissions/projectGet permitted projects
Request bodyapplication/json — PermissionsKeysBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermittedProjects |
400 | Returned if a project permission is not found. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
Plans7
This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans.
GET/rest/api/3/plans/planGet plans paginated
Parameters| Name | In | Required | Type |
|---|
includeTrashed | query | no | boolean |
includeArchived | query | no | boolean |
cursor | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageWithCursorGetPlanResponseForPage |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
POST/rest/api/3/plans/planCreate plan
Parameters| Name | In | Required | Type |
|---|
useGroupId | query | no | boolean |
Request bodyapplication/json — CreatePlanRequest (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
GET/rest/api/3/plans/plan/{planId}Get plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
useGroupId | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | GetPlanResponse |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan is not found. | ErrorCollection |
PUT/rest/api/3/plans/plan/{planId}Update plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
useGroupId | query | no | boolean |
Request bodyapplication/json-patch+json (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan is not found. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
PUT/rest/api/3/plans/plan/{planId}/archiveArchive plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan is not found. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
POST/rest/api/3/plans/plan/{planId}/duplicateDuplicate plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
Request bodyapplication/json — DuplicatePlanRequest (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan to duplicate is not found. | ErrorCollection |
409 | Returned if the plan to duplicate is not active. | ErrorCollection |
PUT/rest/api/3/plans/plan/{planId}/trashTrash plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan is not found. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
Priority schemes8
This resource represents issue priority schemes. Use it to get priority schemes and related information, and to create, update and delete priority schemes.
GET/rest/api/3/priorityschemeGet priority schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
priorityId | query | no | array |
schemeId | query | no | array |
schemeName | query | no | string |
onlyDefault | query | no | boolean |
orderBy | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
POST/rest/api/3/priorityschemeCreate priority scheme
Request bodyapplication/json — CreatePrioritySchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is completed. | PrioritySchemeId |
202 | Returned if the request is accepted. | PrioritySchemeId |
400 | Returned if the request isn't valid.
**Mappings Validation Errors**
* ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'in' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``in`` mappings but are required, add them to the mappings object. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user doesn't have the necessary permissions. | — |
409 | Returned if an action with this priority scheme is still in progress. | — |
POST/rest/api/3/priorityscheme/mappingsSuggested priorities for mappings
Request bodyapplication/json — SuggestedMappingsRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanPriorityWithSequence |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/priorityscheme/priorities/availableGet available priorities by priority scheme
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
query | query | no | string |
schemeId | query | yes | string |
exclude | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanPriorityWithSequence |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
PUT/rest/api/3/priorityscheme/{schemeId}Update priority scheme
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
Request bodyapplication/json — UpdatePrioritySchemeRequestBean (required)
Responses| Status | Description | Schema |
|---|
202 | Returned if the request is accepted. | UpdatePrioritySchemeResponseBean |
400 | Returned if the request isn't valid.
**Mappings Validation Errors**
* ``The changes to priority schemes require mapping of priorities. Please provide a value for the 'in' mappings object.`` Priorities are being removed and/or projects are being added to the scheme, but ``in`` mappings are not provided.
* ``The changes to priority schemes require mapping of priorities. Please provide a value for the 'out' mappings object.`` Projects are being removed from the scheme, but ``out`` mappings are not provided.
* ``The priorities with IDs [ID 1, ID 2, ...] provided as keys for the 'in' mappings object do not exist. Please provide existing priority IDs.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but do not exist. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site which are used by projects being added to the current scheme, but are not in use by the current scheme.
* ``The priorities with IDs [ID 1, ID 2, ...] provided as values for the 'in' mappings object do not exist. Please provide existing priority IDs used by the current priority scheme.`` The listed priority ID(s) have been provided as values for ``in`` mappings but do not exist. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the current scheme.
* ``The priorities with IDs [ID 1, ID 2, ...] provided as keys for the 'out' mappings object do not exist. Please provide existing priority IDs used by the current priority scheme.`` The listed priority ID(s) have been provided as keys for ``out`` mappings but are invalid. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the current scheme.
* ``The priorities with IDs [ID 1, ID 2, ...] provided as values for the 'out' mappings object do not exist. Please provide existing priority IDs used by the default scheme.`` The listed priority ID(s) have been provided as values for ``out`` mappings but are invalid. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the Default Priority Scheme, but are not in use by the current scheme.
* ``The priorities with IDs [ID 1, ID 2, ...] do not require mapping. Please remove these keys and their corresponding values from the 'in' mappings object.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but are not required, they can be removed from the mappings object.
* ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'in' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``in`` mappings but are required, add them to the mappings object.
* ``The priorities with IDs [ID 1, ID 2, ...] being mapped to are not in the current scheme. Please remove these values and their corresponding keys from the 'in' mappings object.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but are not in use by the current scheme, they can be removed from the mappings object.
* ``The priorities with IDs [ID 1, ID 2, ...] do not require mapping. Please remove these keys and their corresponding values from the 'out' mappings object.`` The listed priority ID(s) hve been provided as keys for ``out`` mappings but are not required, they can be removed from the mappings object.
* ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'out' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``out`` mappings but are required, add them to the mappings object.
* ``The priorities with IDs [ID 1, ID 2, ...] being mapped to are not in the default scheme. Please remove these values and their corresponding keys from the 'out' mappings object.`` The listed priority ID(s) have been provided as keys for ``out`` mappings but are not in use by the Default Priority Scheme, they can be removed from the mappings object. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user doesn't have the necessary permissions. | — |
409 | Returned if an action with this priority scheme is still in progress. | — |
DELETE/rest/api/3/priorityscheme/{schemeId}Delete priority scheme
Parameters| Name | In | Required | Type |
|---|
schemeId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user doesn't have the necessary permissions. | — |
GET/rest/api/3/priorityscheme/{schemeId}/prioritiesGet priorities by priority scheme
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
schemeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanPriorityWithSequence |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/priorityscheme/{schemeId}/projectsGet projects by priority scheme
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | string |
maxResults | query | no | string |
projectId | query | no | array |
schemeId | path | yes | string |
query | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanProject |
400 | Returned if the request isn't valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
Project avatars4
This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars.
PUT/rest/api/3/project/{projectIdOrKey}/avatarSet project avatar
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Request bodyapplication/json — Avatar (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to administer the project. | — |
404 | Returned if the project or avatar is not found or the user does not have permission to view the project. | — |
DELETE/rest/api/3/project/{projectIdOrKey}/avatar/{id}Delete project avatar
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the avatar is a system avatar or the user does not have permission to administer the project. | — |
404 | Returned if the project or avatar is not found or the user does not have permission to view the project. | — |
POST/rest/api/3/project/{projectIdOrKey}/avatar2Load project avatar
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
x | query | no | integer |
y | query | no | integer |
size | query | no | integer |
Request body*/* (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Avatar |
400 | Returned if:
* an image isn't included in the request.
* the image type is unsupported.
* the crop parameters extend the crop area beyond the edge of the image. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to administer the project or an anonymous call is made to the operation. | — |
404 | Returned if the project is not found or the user does not have permission to view the project. | — |
GET/rest/api/3/project/{projectIdOrKey}/avatarsGet all project avatars
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if request is successful. | ProjectAvatars |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to view the project. | — |
Project categories5
This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories. For more information on managing project categories, see [Adding, assigning, and deleting project categories](https://confluence.atlassian.com/x/-A5WMg).
GET/rest/api/3/projectCategoryGet all project categories
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/projectCategoryCreate project category
Request bodyapplication/json — ProjectCategory (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | ProjectCategory |
400 | Returned if:
* `name` is not provided or exceeds 255 characters.
* `description` exceeds 1000 characters. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
409 | Returned if the project category name is in use. | — |
GET/rest/api/3/projectCategory/{id}Get project category by ID
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectCategory |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project category is not found. | — |
PUT/rest/api/3/projectCategory/{id}Update project category
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — ProjectCategory (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | UpdatedProjectCategory |
400 | Returned if:
* `name` has been modified and exceeds 255 characters.
* `description` has been modified and exceeds 1000 characters. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the project category is not found. | — |
DELETE/rest/api/3/projectCategory/{id}Delete project category
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the project category is not found. | — |
Project classification levels4
This resource represents classification levels used in a project. Use it to view and manage classification levels in your projects.
GET/rest/api/3/project/{projectIdOrKey}/classification-configGet the classification configuration for a project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the project is not found or the feature is disabled. | — |
GET/rest/api/3/project/{projectIdOrKey}/classification-level/defaultGet the default data classification level of a project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the project is not found. | — |
PUT/rest/api/3/project/{projectIdOrKey}/classification-level/defaultUpdate the default data classification level of a project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Request bodyapplication/json — UpdateDefaultProjectClassificationBean (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the project is not found. | — |
DELETE/rest/api/3/project/{projectIdOrKey}/classification-level/defaultRemove the default data classification level from a project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the project is not found. | — |
Project components8
This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component.
GET/rest/api/3/componentFind components for projects
Parameters| Name | In | Required | Type |
|---|
projectIdsOrKeys | query | no | array |
startAt | query | no | integer |
maxResults | query | no | integer |
orderBy | query | no | string |
query | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBean2ComponentJsonBean |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
POST/rest/api/3/componentCreate component
Request bodyapplication/json — ProjectComponent (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | ProjectComponent |
400 | Returned if:
* the user is not found.
* `name` is not provided.
* `name` is over 255 characters in length.
* `projectId` is not provided.
* `assigneeType` is an invalid value. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira. | — |
404 | Returned if the project is not found or the user does not have permission to browse the project containing the component. | — |
GET/rest/api/3/component/{id}Get component
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectComponent |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the component is not found or the user does not have permission to browse the project containing the component. | — |
PUT/rest/api/3/component/{id}Update component
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — ProjectComponent (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectComponent |
400 | Returned if:
* the user is not found.
* `assigneeType` is an invalid value.
* `name` is over 255 characters in length. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira. | — |
404 | Returned if the component is not found or the user does not have permission to browse the project containing the component. | — |
DELETE/rest/api/3/component/{id}Delete component
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
moveIssuesTo | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira. | — |
404 | Returned if:
* the component is not found.
* the replacement component is not found.
* the user does not have permission to browse the project containing the component. | — |
GET/rest/api/3/component/{id}/relatedIssueCountsGet component issues count
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ComponentIssuesCount |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the component is not found. | — |
GET/rest/api/3/project/{projectIdOrKey}/componentGet project components paginated
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
orderBy | query | no | string |
componentSource | query | no | string |
query | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanComponentWithIssueCount |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
GET/rest/api/3/project/{projectIdOrKey}/componentsGet project components
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
componentSource | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
Project email2
This resource represents the email address used to send a project's notifications. Use it to get and set the [project's sender email address](https://confluence.atlassian.com/x/dolKLg).
GET/rest/api/3/project/{projectId}/emailGet project's sender email
Parameters| Name | In | Required | Type |
|---|
projectId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectEmailAddress |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to read project. | — |
404 | Returned if the project or project's sender email address is not found. | — |
PUT/rest/api/3/project/{projectId}/emailSet project's sender email
Parameters| Name | In | Required | Type |
|---|
projectId | path | yes | integer |
Request bodyapplication/json — ProjectEmailAddress (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the project's sender email address is successfully set. | — |
400 | Returned if the request is not valid, if the email address is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to administer the project. | — |
404 | Returned if the project is not found. | — |
Project features2
This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects.
GET/rest/api/3/project/{projectIdOrKey}/featuresGet project features
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ContainerForProjectFeatures |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the project is not found. | — |
PUT/rest/api/3/project/{projectIdOrKey}/features/{featureKey}Set project feature state
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
featureKey | path | yes | string |
Request bodyapplication/json — ProjectFeatureState (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ContainerForProjectFeatures |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the project or project feature is not found. | — |
Project key and name validation3
This resource provides validation for project keys and names.
GET/rest/api/3/projectvalidate/keyValidate project key
Parameters| Name | In | Required | Type |
|---|
key | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/projectvalidate/validProjectKeyGet valid project key
Parameters| Name | In | Required | Type |
|---|
key | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/projectvalidate/validProjectNameGet valid project name
Parameters| Name | In | Required | Type |
|---|
name | query | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if a valid project name cannot be generated. | — |
Project permission schemes4
This resource represents permission schemes for a project. Use this resource to:
* get details of a project's issue security levels available to the calling user.
* get the permission scheme associated with the project or assign different permission scheme to the project.
* get details of a project's issue security scheme.
See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes.
GET/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelschemeGet project issue security scheme
Parameters| Name | In | Required | Type |
|---|
projectKeyOrId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | SecurityScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the project is visible to the user but the user doesn't have administrative permissions. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
GET/rest/api/3/project/{projectKeyOrId}/permissionschemeGet assigned permission scheme
Parameters| Name | In | Required | Type |
|---|
projectKeyOrId | path | yes | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermissionScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to view the project's configuration. | — |
404 | Returned if the project is not found or the user does not have permission to view the project. | — |
PUT/rest/api/3/project/{projectKeyOrId}/permissionschemeAssign permission scheme
Parameters| Name | In | Required | Type |
|---|
projectKeyOrId | path | yes | string |
expand | query | no | string |
Request bodyapplication/json — IdBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PermissionScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if:
* the user does not have the necessary permission to edit the project's configuration.
* the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be assigned to projects on free plans. | — |
404 | Returned if the project or permission scheme is not found. | — |
GET/rest/api/3/project/{projectKeyOrId}/securitylevelGet project issue security levels
Parameters| Name | In | Required | Type |
|---|
projectKeyOrId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectIssueSecurityLevels |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
Project properties4
This resource represents [project](#api-group-Projects) properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
GET/rest/api/3/project/{projectIdOrKey}/propertiesGet project property keys
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have permission to view the project. | — |
404 | Returned if the project is not found. | — |
GET/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}Get project property
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have permission to view the project. | — |
404 | Returned if the project or property is not found. | — |
PUT/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}Set project property
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the project property is updated. | — |
201 | Returned if the project property is created. | — |
400 | Returned if the project key or id is invalid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have permission to administer the project. | — |
404 | Returned if the project is not found. | — |
DELETE/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}Delete project property
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the project property is deleted. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have permission to administer the project. | — |
404 | Returned if the project or property is not found. | — |
Project role actors6
This resource represents the users assigned to [project roles](#api-group-Issue-comments). Use it to get, add, and remove default users from project roles. Also use it to add and remove users from a project role associated with a project.
POST/rest/api/3/project/{projectIdOrKey}/role/{id}Add actors to project role
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
id | path | yes | integer |
Request bodyapplication/json — ActorsMap (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. The complete list of actors for the project is returned.
For example, the cURL request above adds a group, *jira-developers*. For the response below to be returned as a result of that request, the user *Mia Krystof* would have previously been added as a `user` actor for this project. | ProjectRole |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project. | — |
404 | Returned if:
* the project is not found.
* the user or group is not found.
* the group or user is not active. | — |
PUT/rest/api/3/project/{projectIdOrKey}/role/{id}Set actors for project role
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
id | path | yes | integer |
Request bodyapplication/json — ProjectRoleActorsUpdateBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. The complete list of actors for the project is returned. | ProjectRole |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project. | — |
404 | Returned if:
* the project is not found.
* a user or group is not found.
* a group or user is not active. | — |
DELETE/rest/api/3/project/{projectIdOrKey}/role/{id}Delete actors from project role
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
id | path | yes | integer |
user | query | no | string |
group | query | no | string |
groupId | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
404 | Returned if:
* the project or project role is not found.
* the calling user does not have administrative permission. | — |
GET/rest/api/3/role/{id}/actorsGet default actors for project role
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role is not found. | — |
POST/rest/api/3/role/{id}/actorsAdd default actors to project role
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — ActorInputBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role is not found. | — |
DELETE/rest/api/3/role/{id}/actorsDelete default actors from project role
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
user | query | no | string |
groupId | query | no | string |
group | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role is not found. | — |
Project roles9
This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.
GET/rest/api/3/project/{projectIdOrKey}/roleGet project roles for project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing or if the user lacks administrative permissions for the project. | — |
404 | Returned if the project is not found or or if the user does not have administrative permissions for the project. | — |
GET/rest/api/3/project/{projectIdOrKey}/role/{id}Get project role for project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
id | path | yes | integer |
excludeInactiveUsers | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the project or project role is not found.
* the user does not have administrative permission. | — |
GET/rest/api/3/project/{projectIdOrKey}/roledetailsGet project role details
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
currentMember | query | no | boolean |
excludeConnectAddons | query | no | boolean |
excludeOtherServiceRoles | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or if the user does not have the necessary permissions for the project. | — |
GET/rest/api/3/roleGet all project roles
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
POST/rest/api/3/roleCreate project role
Request bodyapplication/json — CreateUpdateRoleRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
409 | Returned if a project role with the provided name already exists. | — |
GET/rest/api/3/role/{id}Get project role by ID
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role is not found. | — |
POST/rest/api/3/role/{id}Partial update project role
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — CreateUpdateRoleRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role is not found. | — |
PUT/rest/api/3/role/{id}Fully update project role
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — CreateUpdateRoleRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectRole |
400 | Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role is not found. | — |
DELETE/rest/api/3/role/{id}Delete project role
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
swap | query | no | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid or if the replacement project role is not found. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have administrative permissions. | — |
404 | Returned if the project role being deleted is not found. | — |
409 | Returned if the project role being deleted is in use and a replacement project role is not specified in the request. | — |
Project templates5
This resource represents project templates. Use it to create a new project from a custom template.
POST/rest/api/3/project-templateCreate custom project
Request bodyapplication/json — ProjectCustomTemplateCreateRequestDTO (required)
Responses| Status | Description | Schema |
|---|
303 | The project creation task has been queued for execution | — |
PUT/rest/api/3/project-template/edit-templateEdit a custom project template
Request bodyapplication/json — EditTemplateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | 200 response | — |
GET/rest/api/3/project-template/live-templateGets a custom project template
Parameters| Name | In | Required | Type |
|---|
projectId | query | no | string |
templateKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | 200 response | ProjectTemplateModel |
DELETE/rest/api/3/project-template/remove-templateDeletes a custom project template
Parameters| Name | In | Required | Type |
|---|
templateKey | query | yes | string |
Responses| Status | Description | Schema |
|---|
200 | 200 response | — |
POST/rest/api/3/project-template/save-templateSave a custom project template
Request bodyapplication/json — SaveTemplateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | 200 response | SaveTemplateResponse |
Project types4
This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type.
GET/rest/api/3/project/typeGet all project types
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect. | — |
GET/rest/api/3/project/type/accessibleGet licensed project types
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
GET/rest/api/3/project/type/{projectTypeKey}Get project type by key
Parameters| Name | In | Required | Type |
|---|
projectTypeKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectType |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the project type is not found. | — |
GET/rest/api/3/project/type/{projectTypeKey}/accessibleGet accessible project type by key
Parameters| Name | In | Required | Type |
|---|
projectTypeKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectType |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project type is not accessible to the user. | — |
Project versions15
This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by version.
GET/rest/api/3/project/{projectIdOrKey}/versionGet project versions paginated
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
orderBy | query | no | string |
query | query | no | string |
status | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanVersion |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
GET/rest/api/3/project/{projectIdOrKey}/versionsGet project versions
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
POST/rest/api/3/versionCreate version
Request bodyapplication/json — Version (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Version |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the project is not found.
* the user does not have the required permissions. | — |
GET/rest/api/3/version/{id}Get version
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Version |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the version is not found or the user does not have the necessary permission. | — |
PUT/rest/api/3/version/{id}Update version
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — Version (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Version |
400 | Returned if:
* the request is invalid.
* the user does not have the required permissions. | — |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if the version is not found. | — |
DELETE/rest/api/3/version/{id}Delete version
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
moveFixIssuesTo | query | no | string |
moveAffectedIssuesTo | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the version is deleted. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if:
* the authentication credentials are incorrect.
* the user does not have the required permissions. | — |
404 | Returned if the version is not found. | — |
PUT/rest/api/3/version/{id}/mergeto/{moveIssuesTo}Merge versions
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
moveIssuesTo | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the version is deleted. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if:
* the authentication credentials are incorrect or missing.
* the user does not have the required permissions. | — |
404 | Returned if the version to be deleted or the version to merge to are not found. | — |
POST/rest/api/3/version/{id}/moveMove version
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — VersionMoveBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Version |
400 | Returned if:
* no body parameters are provided.
* `after` and `position` are provided.
* `position` is invalid. | — |
401 | Returned if:
* the authentication credentials are incorrect or missing
* the user does not have the required commissions. | — |
404 | Returned if the version or move after version are not found. | — |
GET/rest/api/3/version/{id}/relatedIssueCountsGet version's related issues count
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | VersionIssueCounts |
401 | Returned if the authentication credentials are incorrect. | — |
404 | Returned if:
* the version is not found.
* the user does not have the required permissions. | — |
GET/rest/api/3/version/{id}/relatedworkGet related work
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the version is not found or the user does not have the necessary permission. | — |
500 | Returned if reading related work fails | — |
POST/rest/api/3/version/{id}/relatedworkCreate related work
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — VersionRelatedWork (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | VersionRelatedWork |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the version is not found. | — |
PUT/rest/api/3/version/{id}/relatedworkUpdate related work
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — VersionRelatedWork (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful together with updated related work. | VersionRelatedWork |
400 | Returned if the request data is invalid | — |
401 | Returned if the authentication credentials are incorrect. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the version or the related work is not found. | — |
POST/rest/api/3/version/{id}/removeAndSwapDelete and replace version
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Request bodyapplication/json — DeleteAndReplaceVersionBean (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the version is deleted. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the version to delete is not found.
* the user does not have the required permissions. | — |
GET/rest/api/3/version/{id}/unresolvedIssueCountGet version's unresolved issues count
Parameters| Name | In | Required | Type |
|---|
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | VersionUnresolvedIssuesCount |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the version is not found.
* the user does not have the required permissions. | — |
DELETE/rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}Delete related work
Parameters| Name | In | Required | Type |
|---|
versionId | path | yes | string |
relatedWorkId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the related work is deleted. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if
the authentication credentials are incorrect. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the version/related work is not found. | — |
Projects13
This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type.
GET/rest/api/3/projectGet all projects
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
recent | query | no | integer |
properties | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
POST/rest/api/3/projectCreate project
Request bodyapplication/json — CreateProjectDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the project is created. | ProjectIdentifiers |
400 | Returned if the request is not valid and the project could not be created. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have permission to create projects. | — |
GET/rest/api/3/project/recentGet recent projects
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
properties | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/project/searchGet projects paginated
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
orderBy | query | no | string |
id | query | no | array |
keys | query | no | array |
query | query | no | string |
typeKey | query | no | string |
categoryId | query | no | integer |
action | query | no | string |
expand | query | no | string |
status | query | no | array |
properties | query | no | array |
propertyQuery | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanProject |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if no projects matching the search criteria are found. | — |
GET/rest/api/3/project/{projectIdOrKey}Get project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
expand | query | no | string |
properties | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if successful. | Project |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
PUT/rest/api/3/project/{projectIdOrKey}Update project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
expand | query | no | string |
Request bodyapplication/json — UpdateProjectDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the project is updated. | Project |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if:
* the user does not have the necessary permission to update project details.
* the permission scheme is being changed and the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be changed on free plans. | — |
404 | Returned if the project is not found. | — |
DELETE/rest/api/3/project/{projectIdOrKey}Delete project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
enableUndo | query | no | boolean |
Responses| Status | Description | Schema |
|---|
204 | Returned if the project is deleted. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to delete it. | — |
POST/rest/api/3/project/{projectIdOrKey}/archiveArchive project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permissions. | — |
404 | Returned if the project is not found. | — |
POST/rest/api/3/project/{projectIdOrKey}/deleteDelete project asynchronously
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have the necessary permission. | — |
POST/rest/api/3/project/{projectIdOrKey}/restoreRestore deleted or archived project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Project |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have the necessary permission. | — |
GET/rest/api/3/project/{projectIdOrKey}/statusesGet all statuses for project
Parameters| Name | In | Required | Type |
|---|
projectIdOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have permission to view it. | — |
GET/rest/api/3/project/{projectId}/hierarchyGet project issue type hierarchy
Parameters| Name | In | Required | Type |
|---|
projectId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ProjectIssueTypeHierarchy |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user does not have the necessary permission. | — |
GET/rest/api/3/project/{projectKeyOrId}/notificationschemeGet project notification scheme
Parameters| Name | In | Required | Type |
|---|
projectKeyOrId | path | yes | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | NotificationScheme |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project is not found or the user is not an administrator. | — |
Screen schemes4
This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes.
GET/rest/api/3/screenschemeGet screen schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
expand | query | no | string |
queryString | query | no | string |
orderBy | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanScreenScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
POST/rest/api/3/screenschemeCreate screen scheme
Request bodyapplication/json — ScreenSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | ScreenSchemeId |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if a screen used as one of the screen types in the screen scheme is not found. | — |
PUT/rest/api/3/screenscheme/{screenSchemeId}Update screen scheme
Parameters| Name | In | Required | Type |
|---|
screenSchemeId | path | yes | string |
Request bodyapplication/json — UpdateScreenSchemeDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the screen scheme or a screen used as one of the screen types is not found. | — |
DELETE/rest/api/3/screenscheme/{screenSchemeId}Delete screen scheme
Parameters| Name | In | Required | Type |
|---|
screenSchemeId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the screen scheme is deleted. | — |
400 | Returned if the screen scheme is used in an issue type screen scheme. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen scheme is not found. | — |
Screen tab fields4
This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs.
GET/rest/api/3/screens/{screenId}/tabs/{tabId}/fieldsGet all screen tab fields
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
projectKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen or screen tab is not found. | — |
POST/rest/api/3/screens/{screenId}/tabs/{tabId}/fieldsAdd screen tab field
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
skipFieldAssociation | query | no | boolean |
Request bodyapplication/json — AddFieldBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ScreenableField |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen, screen tab, or field is not found. | — |
DELETE/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}Remove screen tab field
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
id | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen, screen tab, or field is not found. | — |
POST/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/moveMove screen tab field
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
id | path | yes | string |
Request bodyapplication/json — MoveFieldBean (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen, screen tab, or field is not found or the field can't be moved to the requested position. | — |
Screen tabs6
This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs.
GET/rest/api/3/screens/tabsGet bulk screen tabs
Parameters| Name | In | Required | Type |
|---|
screenId | query | no | array |
tabId | query | no | array |
startAt | query | no | integer |
maxResult | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the screen ID or the tab ID is empty. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/screens/{screenId}/tabsGet all screen tabs
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
projectKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the screen ID is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen is not found. | — |
POST/rest/api/3/screens/{screenId}/tabsCreate screen tab
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
Request bodyapplication/json — ScreenableTab (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ScreenableTab |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen is not found. | — |
PUT/rest/api/3/screens/{screenId}/tabs/{tabId}Update screen tab
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
Request bodyapplication/json — ScreenableTab (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ScreenableTab |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen or screen tab is not found. | — |
DELETE/rest/api/3/screens/{screenId}/tabs/{tabId}Delete screen tab
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen or screen tab is not found. | — |
POST/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}Move screen tab
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
tabId | path | yes | integer |
pos | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen or screen tab is not found or the position is invalid. | — |
Screens7
This resource represents the screens used to record issue details. Use it to:
* get details of all screens.
* get details of all the fields available for use on screens.
* create screens.
* delete screens.
* update screens.
* add a field to the default screen.
GET/rest/api/3/field/{fieldId}/screensGet screens for a field
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanScreenWithTab |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/screensGet screens
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
id | query | no | array |
queryString | query | no | string |
scope | query | no | array |
orderBy | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanScreen |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
POST/rest/api/3/screensCreate screen
Request bodyapplication/json — ScreenDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | Screen |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
POST/rest/api/3/screens/addToDefault/{fieldId}Add field to default screen
Parameters| Name | In | Required | Type |
|---|
fieldId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the field it not found or the field is already present. | — |
PUT/rest/api/3/screens/{screenId}Update screen
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
Request bodyapplication/json — UpdateScreenDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | Screen |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen is not found. | — |
DELETE/rest/api/3/screens/{screenId}Delete screen
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen is not found. | — |
GET/rest/api/3/screens/{screenId}/availableFieldsGet available screen fields
Parameters| Name | In | Required | Type |
|---|
screenId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the screen is not found. | — |
Server info1
This resource provides information about the Jira instance.
GET/rest/api/3/serverInfoGet Jira instance info
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ServerInformation |
401 | Returned if the authentication credentials are incorrect. | — |
Service Registry1
This resource represents a service registry. Use it to retrieve attributes related to a [service registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/) in JSM.
GET/rest/atlassian-connect/1/service-registryRetrieve the attributes of service registries
Parameters| Name | In | Required | Type |
|---|
serviceIds | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
401 | The request needs to be authenticated. | — |
403 | The request isn't authorized. | — |
500 | The endpoint failed internally. | — |
501 | The endpoint isn't ready for receiving requests. | — |
504 | The upstream service is busy. | — |
Status9
This resource represents statuses. Use it to search, get, create, delete, and change statuses.
GET/rest/api/3/statusesBulk get statuses
Parameters| Name | In | Required | Type |
|---|
id | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
POST/rest/api/3/statusesBulk create statuses
Request bodyapplication/json — StatusCreateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
409 | Returned if another workflow configuration update task is ongoing. | — |
PUT/rest/api/3/statusesBulk update statuses
Request bodyapplication/json — StatusUpdateRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
409 | Returned if another workflow configuration update task is ongoing. | — |
DELETE/rest/api/3/statusesBulk delete Statuses
Parameters| Name | In | Required | Type |
|---|
id | query | yes | array |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/statuses/byNamesBulk get statuses by name
Parameters| Name | In | Required | Type |
|---|
name | query | yes | array |
projectId | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/statuses/searchSearch statuses paginated
Parameters| Name | In | Required | Type |
|---|
projectId | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
searchString | query | no | string |
statusCategory | query | no | string |
includeGlobalStatuses | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageOfStatuses |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/statuses/{statusId}/project/{projectId}/issueTypeUsagesGet issue type usages by status and project
Parameters| Name | In | Required | Type |
|---|
statusId | path | yes | string |
projectId | path | yes | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | StatusProjectIssueTypeUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the status with the given ID does not exist. | — |
GET/rest/api/3/statuses/{statusId}/projectUsagesGet project usages by status
Parameters| Name | In | Required | Type |
|---|
statusId | path | yes | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | StatusProjectUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the status with the given ID does not exist. | — |
GET/rest/api/3/statuses/{statusId}/workflowUsagesGet workflow usages by status
Parameters| Name | In | Required | Type |
|---|
statusId | path | yes | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | StatusWorkflowUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the status with the given ID does not exist. | — |
Tasks2
This resource represents a [long-running asynchronous tasks](#async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task.
GET/rest/api/3/task/{taskId}Get task
Parameters| Name | In | Required | Type |
|---|
taskId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | TaskProgressBeanObject |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the task is not found. | — |
POST/rest/api/3/task/{taskId}/cancelCancel task
Parameters| Name | In | Required | Type |
|---|
taskId | path | yes | string |
Responses| Status | Description | Schema |
|---|
202 | Returned if the request is successful. | — |
400 | Returned if cancellation of the task is not possible. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the task is not found. | — |
Teams in plan9
This resource represents planning settings for plan-only and Atlassian teams in a plan. Use it to get, create, update and delete planning settings.
GET/rest/api/3/plans/plan/{planId}/teamGet teams in plan paginated
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
cursor | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageWithCursorGetTeamResponseForPage |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan is not found. | ErrorCollection |
POST/rest/api/3/plans/plan/{planId}/team/atlassianAdd Atlassian team to plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
Request bodyapplication/json — AddAtlassianTeamRequest (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or Atlassian team is not found. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
GET/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}Get Atlassian team in plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
atlassianTeamId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | GetAtlassianTeamResponse |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or Atlassian team is not found, or the Atlassian team is not associated with the plan. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
PUT/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}Update Atlassian team in plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
atlassianTeamId | path | yes | string |
Request bodyapplication/json-patch+json (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or Atlassian team is not found, or the Atlassian team is not associated with the plan. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
DELETE/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}Remove Atlassian team from plan
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
atlassianTeamId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or Atlassian team is not found, or the Atlassian team is not associated with the plan. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
POST/rest/api/3/plans/plan/{planId}/team/planonlyCreate plan-only team
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
Request bodyapplication/json — CreatePlanOnlyTeamRequest (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan is not found. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
GET/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}Get plan-only team
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
planOnlyTeamId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | GetPlanOnlyTeamResponse |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or plan-only team is not found, or the plan-only team is not associated with the plan. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
PUT/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}Update plan-only team
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
planOnlyTeamId | path | yes | integer |
Request bodyapplication/json-patch+json (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | ErrorCollection |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or plan-only team is not found, or the plan-only team is not associated with the plan. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
DELETE/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}Delete plan-only team
Parameters| Name | In | Required | Type |
|---|
planId | path | yes | integer |
planOnlyTeamId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the user is not logged in. | ErrorCollection |
403 | Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. | ErrorCollection |
404 | Returned if the plan or plan-only team is not found, or the plan-only team is not associated with the plan. | ErrorCollection |
409 | Returned if the plan is not active. | ErrorCollection |
Time tracking5
This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking.
GET/rest/api/3/configuration/timetrackingGet selected time tracking provider
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful and time tracking is enabled. | TimeTrackingProvider |
204 | Returned if the request is successful but time tracking is disabled. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
PUT/rest/api/3/configuration/timetrackingSelect time tracking provider
Request bodyapplication/json — TimeTrackingProvider (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the time tracking provider is not found. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/configuration/timetracking/listGet all time tracking providers
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/configuration/timetracking/optionsGet time tracking settings
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | TimeTrackingConfiguration |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
PUT/rest/api/3/configuration/timetracking/optionsSet time tracking settings
Request bodyapplication/json — TimeTrackingConfiguration (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | TimeTrackingConfiguration |
400 | Returned if the request object is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
UI modifications (apps)4
UI modifications is a feature available for **Forge apps only**. It enables Forge apps to control how selected Jira and Jira Service Management fields behave on the following views:
* Jira global issue create
* Jira issue view
* Jira issue transition
* Jira Service Management request portal create.
For example: hide specific fields, set them as required, etc.
GET/rest/api/3/uiModificationsGet UI modifications
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanUiModificationDetails |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request is not from a Forge app. | — |
POST/rest/api/3/uiModificationsCreate UI modification
Request bodyapplication/json — CreateUiModificationDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the UI modification is created. | UiModificationIdentifiers |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request is not from a Forge app. | — |
404 | Returned if a project, issue type, portal, or request type in the context are not found. | DetailedErrorCollection |
PUT/rest/api/3/uiModifications/{uiModificationId}Update UI modification
Parameters| Name | In | Required | Type |
|---|
uiModificationId | path | yes | string |
Request bodyapplication/json — UpdateUiModificationDetails (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the UI modification is updated. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request is not from a Forge app. | — |
404 | Returned if the UI modification, a project, issue type, portal, or request type in the context are not found. | DetailedErrorCollection |
DELETE/rest/api/3/uiModifications/{uiModificationId}Delete UI modification
Parameters| Name | In | Required | Type |
|---|
uiModificationId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the UI modification is deleted. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the request is not from a Forge app. | — |
404 | Returned if the UI modification is not found. | — |
User properties4
This resource represents [user](#api-group-Users) properties and provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a list of property keys for a user. This resourse is designed for integrations and apps to store per-user data and settings. This enables data used to customized the user experience to be kept in the Jira Cloud instance's database. User properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
This resource does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.
GET/rest/api/3/user/propertiesGet user property keys
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
userKey | query | no | string |
username | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PropertyKeys |
400 | Returned if `accountId` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
404 | Returned if the user is not found. | — |
GET/rest/api/3/user/properties/{propertyKey}Get user property
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
userKey | query | no | string |
username | query | no | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | EntityProperty |
400 | Returned if `accountId` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
404 | Returned if the user is not found. | — |
PUT/rest/api/3/user/properties/{propertyKey}Set user property
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
userKey | query | no | string |
username | query | no | string |
propertyKey | path | yes | string |
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the user property is updated. | — |
201 | Returned if the user property is created. | — |
400 | Returned if `accountId` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
404 | Returned if the user is not found. | — |
405 | Returned if the property key is not specified. | — |
DELETE/rest/api/3/user/properties/{propertyKey}Delete user property
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
userKey | query | no | string |
username | query | no | string |
propertyKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the user property is deleted. | — |
400 | Returned if `accountId` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
404 | Returned if the user or the property is not found. | — |
User search8
This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. Note that the operations in this resource only return users found within the first 1000 users.
GET/rest/api/3/user/assignable/multiProjectSearchFind users assignable to projects
Parameters| Name | In | Required | Type |
|---|
query | query | no | string |
username | query | no | string |
accountId | query | no | string |
projectKeys | query | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* `projectKeys` is missing.
* `query` or `accountId` is missing.
* `query` and `accountId` are provided. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if one or more of the projects is not found. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
GET/rest/api/3/user/assignable/searchFind users assignable to issues
Parameters| Name | In | Required | Type |
|---|
query | query | no | string |
sessionId | query | no | string |
username | query | no | string |
accountId | query | no | string |
project | query | no | string |
issueKey | query | no | string |
issueId | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
actionDescriptorId | query | no | integer |
recommend | query | no | boolean |
accountType | query | no | array |
appType | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* None of `issueKey`, `issueId` or `project` is present.
* `issueId` parameter is not valid.
* `query` or `accountId` is missing.
* `query` and `accountId` are provided. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the project, issue, or transition is not found. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
GET/rest/api/3/user/permission/searchFind users with permissions
Parameters| Name | In | Required | Type |
|---|
query | query | no | string |
username | query | no | string |
accountId | query | no | string |
permissions | query | yes | string |
issueKey | query | no | string |
projectKey | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* `issueKey` or `projectKey` is missing.
* `query` or `accountId` is missing.
* `query` and `accountId` are provided.
* `permissions` is empty or contains an invalid entry. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the issue or project is not found. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
GET/rest/api/3/user/pickerFind users for picker
Parameters| Name | In | Required | Type |
|---|
query | query | yes | string |
maxResults | query | no | integer |
showAvatar | query | no | boolean |
exclude | query | no | array |
excludeAccountIds | query | no | array |
avatarSize | query | no | string |
excludeConnectUsers | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | FoundUsers |
400 | Returned if `exclude` and `excludeAccountIds` are provided. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
GET/rest/api/3/user/searchFind users
Parameters| Name | In | Required | Type |
|---|
query | query | no | string |
username | query | no | string |
accountId | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
property | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* `accountId`, `query` or `property` is missing.
* `query` and `accountId` are provided.
* `property` parameter is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
GET/rest/api/3/user/search/queryFind users by query
Parameters| Name | In | Required | Type |
|---|
query | query | yes | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanUser |
400 | Returned if the query is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
408 | Returned if the search is timed out. | ErrorCollection |
GET/rest/api/3/user/search/query/keyFind user keys by query
Parameters| Name | In | Required | Type |
|---|
query | query | yes | string |
startAt | query | no | integer |
maxResult | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanUserKey |
400 | Returned if the query is invalid. | ErrorCollection |
401 | Returned if the authentication credentials are incorrect or missing. | ErrorCollection |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
408 | Returned if the search is timed out. | ErrorCollection |
GET/rest/api/3/user/viewissue/searchFind users with browse permission
Parameters| Name | In | Required | Type |
|---|
query | query | no | string |
username | query | no | string |
accountId | query | no | string |
issueKey | query | no | string |
projectKey | query | no | string |
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if:
* `issueKey` or `projectKey` is missing.
* `query` or `accountId` is missing.
* `query` and `accountId` are provided. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the issue or project is not found. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
Users13
This resource represent users. Use it to:
* get, get a list of, create, and delete users.
* get, set, and reset a user's default issue table columns.
* get a list of the groups the user belongs to.
* get a list of user account IDs for a list of usernames or user keys.
GET/rest/api/3/userGet user
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
username | query | no | string |
key | query | no | string |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | User |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the calling user does not have the *Browse users and groups* global permission. | — |
404 | Returned if the user is not found. | — |
POST/rest/api/3/userCreate user
Request bodyapplication/json — NewUserDetails (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | User |
400 | Returned if the request is invalid, the user already exists but does not have access to jira, or the number of licensed users is exceeded. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
DELETE/rest/api/3/userDelete user
Parameters| Name | In | Required | Type |
|---|
accountId | query | yes | string |
username | query | no | string |
key | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the user cannot be removed. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the user is not found. | — |
GET/rest/api/3/user/bulkBulk get users
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
username | query | no | array |
key | query | no | array |
accountId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanUser |
400 | Returned if `accountID` is missing. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/user/bulk/migrationGet account IDs for users
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
username | query | no | array |
key | query | no | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if `key` or `username` | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/user/columnsGet user default columns
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
username | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
404 | Returned if the requested user is not found. | — |
PUT/rest/api/3/user/columnsSet user default columns
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
Request body*/* — UserColumnRequestBody (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
404 | Returned if the requested user is not found. | — |
429 | Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header. | — |
500 | Returned if an invalid issue table column ID is sent. | — |
DELETE/rest/api/3/user/columnsReset user default columns
Parameters| Name | In | Required | Type |
|---|
accountId | query | no | string |
username | query | no | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission or is not accessing their user record. | — |
GET/rest/api/3/user/emailGet user email
Parameters| Name | In | Required | Type |
|---|
accountId | query | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | UnrestrictedUserEmail |
400 | Returned if the calling app is not approved to use this API. | — |
401 | Returned if the authentication credentials are incorrect or missing from the request (for example if a user is trying to access this API). | — |
404 | Returned if a user with the given `accountId` doesn't exist | — |
503 | Indicates the API is not currently enabled | — |
GET/rest/api/3/user/email/bulkGet user email bulk
Parameters| Name | In | Required | Type |
|---|
accountId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | UnrestrictedUserEmail |
400 | Returned if the calling app is not approved to use this API. | — |
401 | Returned if the authentication credentials are incorrect, or missing from the request (for example if a user is trying to access this API). | — |
503 | Indicates the API is not currently enabled. | — |
GET/rest/api/3/user/groupsGet user groups
Parameters| Name | In | Required | Type |
|---|
accountId | query | yes | string |
username | query | no | string |
key | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the calling user does not have the *Browse users and groups* global permission. | — |
404 | Returned if the user is not found. | — |
GET/rest/api/3/usersGet all users default
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
403 | Returned if the user doesn't have the necessary permission. | — |
409 | Returned if the request takes longer than 10 seconds or is interrupted. | — |
GET/rest/api/3/users/searchGet all users
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is invalid. | — |
403 | Returned if the user doesn't have the necessary permission. | — |
409 | Returned if the request takes longer than 10 seconds or is interrupted. | — |
Webhooks5
This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register and manage webhooks. For more information, see [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
GET/rest/api/3/webhookGet dynamic webhooks for app
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanWebhook |
400 | Returned if the request is invalid. | ErrorCollection |
403 | Returned if the caller isn't an app. | ErrorCollection |
POST/rest/api/3/webhookRegister dynamic webhooks
Request bodyapplication/json — WebhookRegistrationDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ContainerForRegisteredWebhooks |
400 | Returned if the request is invalid. | ErrorCollection |
403 | Returned if the caller isn't an app. | ErrorCollection |
DELETE/rest/api/3/webhookDelete webhooks by ID
Request bodyapplication/json — ContainerForWebhookIDs (required)
Responses| Status | Description | Schema |
|---|
202 | Returned if the request is successful. | — |
400 | Returned if the list of webhook IDs is missing. | ErrorCollection |
403 | Returned if the caller isn't an app. | ErrorCollection |
GET/rest/api/3/webhook/failedGet failed webhooks
Parameters| Name | In | Required | Type |
|---|
maxResults | query | no | integer |
after | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | FailedWebhooks |
400 | 400 response | ErrorCollection |
403 | Returned if the caller is not a Connect app. | ErrorCollection |
PUT/rest/api/3/webhook/refreshExtend webhook life
Request bodyapplication/json — ContainerForWebhookIDs (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WebhooksExpirationDate |
400 | Returned if the request is invalid. | ErrorCollection |
403 | Returned if the caller isn't an app. | ErrorCollection |
Workflow scheme drafts14
This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes.
A workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.
Active workflow schemes (workflow schemes that are used by projects) cannot be edited. Editing an active workflow scheme creates a draft copy of the scheme. The draft workflow scheme can then be edited and published (replacing the active scheme).
See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information.
POST/rest/api/3/workflowscheme/{id}/createdraftCreate draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
GET/rest/api/3/workflowscheme/{id}/draftGet draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if:
* the original active workflow scheme is not found.
* the original active workflow scheme does not have a draft. | — |
PUT/rest/api/3/workflowscheme/{id}/draftUpdate draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — WorkflowScheme (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if:
* the original active workflow scheme is not found.
* the original active workflow scheme does not have a draft. | — |
DELETE/rest/api/3/workflowscheme/{id}/draftDelete draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission.. | — |
404 | Returned if:
* the original active workflow scheme is not found.
* the original active workflow scheme does not have a draft. | — |
GET/rest/api/3/workflowscheme/{id}/draft/defaultGet draft default workflow
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DefaultWorkflow |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission.. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow scheme does not have a draft. | — |
PUT/rest/api/3/workflowscheme/{id}/draft/defaultUpdate draft default workflow
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — DefaultWorkflow (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow scheme does not have a draft. | — |
DELETE/rest/api/3/workflowscheme/{id}/draft/defaultDelete draft default workflow
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow scheme does not have a draft. | — |
GET/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}Get workflow for issue type in draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
issueType | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueTypeWorkflowMapping |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme or issue type is not found. | — |
PUT/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}Set workflow for issue type in draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
issueType | path | yes | string |
Request bodyapplication/json — IssueTypeWorkflowMapping (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme or issue type is not found. | — |
DELETE/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}Delete workflow for issue type in draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
issueType | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme or issue type is not found. | — |
POST/rest/api/3/workflowscheme/{id}/draft/publishPublish draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
validateOnly | query | no | boolean |
Request bodyapplication/json — PublishDraftWorkflowScheme (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is only for validation and is successful. | — |
303 | Returned if the request is successful. | TaskProgressBeanObject |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of these are true:
* The workflow scheme is not found.
* The workflow scheme does not have a draft.
* A new status in the draft workflow scheme is not found. | — |
GET/rest/api/3/workflowscheme/{id}/draft/workflowGet issue types for workflows in draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
workflowName | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueTypesWorkflowMapping |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if either the workflow scheme or workflow (if specified) is not found. session. | — |
PUT/rest/api/3/workflowscheme/{id}/draft/workflowSet issue types for workflow in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
workflowName | query | yes | string |
Request bodyapplication/json — IssueTypesWorkflowMapping (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow scheme does not have a draft.
* The workflow is not found.
* The workflow is not specified. | — |
DELETE/rest/api/3/workflowscheme/{id}/draft/workflowDelete issue types for workflow in draft workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
workflowName | query | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow scheme does not have a draft.
* The workflow is not found.
* The workflow is not specified. | — |
Workflow scheme project associations2
This resource represents the associations between workflow schemes and projects.
For more information, see [Managing your workflows](https://confluence.atlassian.com/x/q4hKLg).
GET/rest/api/3/workflowscheme/projectGet workflow scheme project associations
Parameters| Name | In | Required | Type |
|---|
projectId | query | yes | array |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | ContainerOfWorkflowSchemeAssociations |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
PUT/rest/api/3/workflowscheme/projectAssign workflow scheme to project
Request bodyapplication/json — WorkflowSchemeProjectAssociation (required)
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the workflow scheme or the project are not found. | — |
Workflow schemes19
This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types.
A workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.
Active workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme).
See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information.
GET/rest/api/3/workflowschemeGet all workflow schemes
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanWorkflowScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
POST/rest/api/3/workflowschemeCreate workflow scheme
Request bodyapplication/json — WorkflowScheme (required)
Responses| Status | Description | Schema |
|---|
201 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
POST/rest/api/3/workflowscheme/project/switchSwitch workflow scheme for project
Request bodyapplication/json — WorkflowSchemeProjectSwitchBean (required)
Responses| Status | Description | Schema |
|---|
303 | Returned if the request is successful and the task has been started. | TaskProgressBeanObject |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
409 | Returned if a conflicting task is already running. | — |
POST/rest/api/3/workflowscheme/readBulk get workflow schemes
Request bodyapplication/json — WorkflowSchemeReadRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
POST/rest/api/3/workflowscheme/updateUpdate workflow scheme
Request bodyapplication/json — WorkflowSchemeUpdateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful and there is no asynchronous task. | — |
303 | Returned if the request is successful and there is an asynchronous task for the migrations. | TaskProgressBeanObject |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
409 | Returned if another workflow configuration update task is ongoing. | — |
POST/rest/api/3/workflowscheme/update/mappingsGet required status mappings for workflow scheme update
Request bodyapplication/json — WorkflowSchemeUpdateRequiredMappingsRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowSchemeUpdateRequiredMappingsResponse |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/workflowscheme/{id}Get workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
returnDraftIfExists | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme is not found. | — |
PUT/rest/api/3/workflowscheme/{id}Classic update workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — WorkflowScheme (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme is not found. | — |
DELETE/rest/api/3/workflowscheme/{id}Delete workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
204 | Returned if the request is successful. | — |
400 | Returned if the scheme is active. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme is not found. | — |
GET/rest/api/3/workflowscheme/{id}/defaultGet default workflow
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
returnDraftIfExists | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DefaultWorkflow |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme is not found. | — |
PUT/rest/api/3/workflowscheme/{id}/defaultUpdate default workflow
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
Request bodyapplication/json — DefaultWorkflow (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme is not found. | — |
DELETE/rest/api/3/workflowscheme/{id}/defaultDelete default workflow
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
updateDraftIfNeeded | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme is not found. | — |
GET/rest/api/3/workflowscheme/{id}/issuetype/{issueType}Get workflow for issue type in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
issueType | path | yes | string |
returnDraftIfExists | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueTypeWorkflowMapping |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme or issue type is not found. | — |
PUT/rest/api/3/workflowscheme/{id}/issuetype/{issueType}Set workflow for issue type in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
issueType | path | yes | string |
Request bodyapplication/json — IssueTypeWorkflowMapping (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme or issue type is not found. | — |
DELETE/rest/api/3/workflowscheme/{id}/issuetype/{issueType}Delete workflow for issue type in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
issueType | path | yes | string |
updateDraftIfNeeded | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if the workflow scheme or issue type is not found. | — |
GET/rest/api/3/workflowscheme/{id}/workflowGet issue types for workflows in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
workflowName | query | no | string |
returnDraftIfExists | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | IssueTypesWorkflowMapping |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if either the workflow scheme or workflow is not found. | — |
PUT/rest/api/3/workflowscheme/{id}/workflowSet issue types for workflow in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
workflowName | query | yes | string |
Request bodyapplication/json — IssueTypesWorkflowMapping (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowScheme |
400 | Returned if the request is invalid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow is not found.
* The workflow is not specified. | — |
DELETE/rest/api/3/workflowscheme/{id}/workflowDelete issue types for workflow in workflow scheme
Parameters| Name | In | Required | Type |
|---|
id | path | yes | integer |
workflowName | query | yes | string |
updateDraftIfNeeded | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
400 | Returned if the workflow cannot be edited and `updateDraftIfNeeded` is not true. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | — |
404 | Returned if any of the following is true:
* The workflow scheme is not found.
* The workflow is not found.
* The workflow is not specified. | — |
GET/rest/api/3/workflowscheme/{workflowSchemeId}/projectUsagesGet projects which are using a given workflow scheme
Parameters| Name | In | Required | Type |
|---|
workflowSchemeId | path | yes | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowSchemeProjectUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the workflow scheme with the given ID does not exist. | — |
Workflow status categories2
This resource represents status categories. Use it to obtain a list of all status categories and the details of a category. Status categories provided a mechanism for categorizing [statuses](#api-group-Workflow-statuses).
GET/rest/api/3/statuscategoryGet all status categories
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/statuscategory/{idOrKey}Get status category
Parameters| Name | In | Required | Type |
|---|
idOrKey | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | StatusCategory |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if the status category is not found. | — |
Workflow statuses2
This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status.
GET/rest/api/3/statusGet all statuses
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
GET/rest/api/3/status/{idOrName}Get status
Parameters| Name | In | Required | Type |
|---|
idOrName | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | StatusDetails |
401 | Returned if the authentication credentials are incorrect or missing. | — |
404 | Returned if:
* the status is not found.
* the status is not associated with a workflow.
* the user does not have the required permissions. | — |
Workflow transition rules3
This resource represents workflow transition rules. Workflow transition rules define a Connect or a Forge app routine, such as a [workflow post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) that is executed in association with the workflow. Use it to read and modify configuration of workflow transition rules.
GET/rest/api/3/workflow/rule/configGet workflow transition rule configurations
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
types | query | yes | array |
keys | query | no | array |
workflowNames | query | no | array |
withTags | query | no | array |
draft | query | no | boolean |
expand | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanWorkflowTransitionRules |
400 | Returned if the request is invalid. | ErrorCollection |
403 | Returned if the caller is not a Connect or Forge app. | ErrorCollection |
404 | Returned if any transition rule type is not supported. | — |
503 | Returned if we encounter a problem while trying to access the required data. | — |
PUT/rest/api/3/workflow/rule/configUpdate workflow transition rule configurations
Request bodyapplication/json — WorkflowTransitionRulesUpdate (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowTransitionRulesUpdateErrors |
400 | Returned if the request is invalid. | ErrorCollection |
403 | Returned if the caller is not a Connect or Forge app. | ErrorCollection |
503 | Returned if we encounter a problem while trying to access the required data. | — |
PUT/rest/api/3/workflow/rule/config/deleteDelete workflow transition rule configurations
Request bodyapplication/json — WorkflowsWithTransitionRulesDetails (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowTransitionRulesUpdateErrors |
400 | Returned if the request is invalid. | ErrorCollection |
403 | Returned if the caller is not a Connect app. | ErrorCollection |
Workflows16
This resource represents workflows. Use it to:
* Get workflows
* Create workflows
* Update workflows
* Delete inactive workflows
* Get workflow capabilities
POST/rest/api/3/workflow/historyRead workflow version from history
Request bodyapplication/json — WorkflowHistoryReadRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowHistoryReadResponseDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
POST/rest/api/3/workflow/history/listList workflow history entries
Parameters| Name | In | Required | Type |
|---|
expand | query | no | string |
Request bodyapplication/json — WorkflowHistoryListRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowHistoryListResponseDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/workflow/searchGet workflows paginated
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
workflowName | query | no | array |
expand | query | no | string |
queryString | query | no | string |
orderBy | query | no | string |
isActive | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | PageBeanWorkflow |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the necessary permission. | ErrorCollection |
DELETE/rest/api/3/workflow/{entityId}Delete inactive workflow
Parameters| Name | In | Required | Type |
|---|
entityId | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Returned if the workflow is deleted. | — |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
403 | Returned if the user does not have the required permissions. | — |
404 | Returned if the workflow is not found. | — |
GET/rest/api/3/workflow/{workflowId}/project/{projectId}/issueTypeUsagesGet issue types in a project that are using a given workflow
Parameters| Name | In | Required | Type |
|---|
workflowId | path | yes | string |
projectId | path | yes | integer |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowProjectIssueTypeUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the workflow with the given ID does not exist. | — |
GET/rest/api/3/workflow/{workflowId}/projectUsagesGet projects using a given workflow
Parameters| Name | In | Required | Type |
|---|
workflowId | path | yes | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowProjectUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the workflow with the given ID does not exist. | — |
GET/rest/api/3/workflow/{workflowId}/workflowSchemesGet workflow schemes which are using a given workflow
Parameters| Name | In | Required | Type |
|---|
workflowId | path | yes | string |
nextPageToken | query | no | string |
maxResults | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowSchemeUsageDTO |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if the workflow with the given ID does not exist. | — |
POST/rest/api/3/workflowsBulk get workflows
Request bodyapplication/json — WorkflowReadRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowReadResponse |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/workflows/capabilitiesGet available workflow capabilities
Parameters| Name | In | Required | Type |
|---|
workflowId | query | no | string |
projectId | query | no | string |
issueTypeId | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowCapabilities |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
POST/rest/api/3/workflows/createBulk create workflows
Request bodyapplication/json — WorkflowCreateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowCreateResponse |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
409 | Returned if another workflow configuration update task is ongoing. | — |
POST/rest/api/3/workflows/create/validationValidate create workflows
Request bodyapplication/json — WorkflowCreateValidateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowValidationErrorList |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
GET/rest/api/3/workflows/defaultEditorGet the user's default workflow editor
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | DefaultWorkflowEditorResponse |
POST/rest/api/3/workflows/previewPreview workflow
Request bodyapplication/json — WorkflowPreviewRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowPreviewResponse |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
404 | Returned if one or more previews are not found. | — |
GET/rest/api/3/workflows/searchSearch workflows
Parameters| Name | In | Required | Type |
|---|
startAt | query | no | integer |
maxResults | query | no | integer |
expand | query | no | string |
queryString | query | no | string |
orderBy | query | no | string |
scope | query | no | string |
isActive | query | no | boolean |
projectId | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowSearchResponse |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
POST/rest/api/3/workflows/updateBulk update workflows
Request bodyapplication/json — WorkflowUpdateRequest (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowUpdateResponse |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
409 | Returned if another workflow configuration update task is ongoing. | — |
POST/rest/api/3/workflows/update/validationValidate update workflows
Request bodyapplication/json — WorkflowUpdateValidateRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | WorkflowValidationErrorList |
400 | Returned if the request is not valid. | — |
401 | Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. | — |
rest1
POST/rest/internal/api/latest/worklog/bulkGet worklogs by issue id and worklog id
Request bodyapplication/json — BulkWorklogKeyRequestBean (required)
Responses| Status | Description | Schema |
|---|
200 | Returned if the request is successful. | BulkWorklogKeyResponseBean |
400 | Returned if the request contains more than 1000 worklog pairs, is empty, or has invalid format. | — |
401 | Returned if the authentication credentials are incorrect or missing. | — |
500 | Returned if there is an internal server error. | — |
