Jiraconnector v1.0 | OneTeg Documentation

/rest/api/3/announcementBanner

Returns the current announcement banner configuration.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/announcementBanner

Updates the announcement banner configuration.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Isdismissible`	Flag indicating if the announcement banner can be dismissed by the user.
`Isenabled`	Flag indicating if the announcement banner is enabled or not.
`Message`	The text on the announcement banner.
`Visibility`	Visibility of the announcement banner. Can be public or private.

/rest/api/3/data-policy/project

Returns data policies for the projects specified in the request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	A list of project identifiers. This parameter accepts a comma-separated list.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/data-policy

Returns data policy for the workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/atlassian-connect/1/migration/field

Updates the value of a custom field added by Connect apps on one or more issues.
The values of up to 200 custom fields can be updated.

Permissions required: Only Connect apps can make this request

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Atlassian-transfer-id`	The ID of the transfer.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/atlassian-connect/1/migration/properties/{entityType}

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Atlassian-transfer-id`	The app migration transfer ID.
`Entitytype`	The type indicating the object that contains the entity properties.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Entityid`	The entity property ID.
`Key`	The entity property key.
`Value`	The new value of the entity property.

/rest/atlassian-connect/1/migration/workflow/rule/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Atlassian-transfer-id`	The app migration transfer ID.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Expand`	Use expand to include additional information in the response. This parameter accepts transition which, for each rule, returns information about the transition the rule is assigned to.
`Ruleids`	The list of workflow rule IDs.
`Workflowentityid`	The workflow ID.

/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Deletes an app's property.

Permissions required: Only a Connect app whose key matches addonKey can make this request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Addonkey`	The key of the app, as defined in its descriptor.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/forge/1/app/properties/{propertyKey}

Deletes a Forge app's property.

Permissions required: Only Forge apps can make this request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/atlassian-connect/1/addons/{addonKey}/properties

Gets all the properties of an app.

Permissions required: Only a Connect app whose key matches addonKey can make this request.
Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were migrated from.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Addonkey`	The key of the app, as defined in its descriptor.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

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

Permissions required: Only a Connect app whose key matches addonKey can make this request.
Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were migrated from.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Addonkey`	The key of the app, as defined in its descriptor.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/forge/1/app/properties/{propertyKey}

Sets the value of a Forge app's property.
These values can be retrieved in Jira expressions
through the app context variable.

For other use cases, use the Storage API.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Only Forge apps can make this request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

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

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Only a Connect app whose key matches addonKey can make this request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Addonkey`	The key of the app, as defined in its descriptor.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/api/3/applicationrole

Returns all application roles. In Jira, application roles are managed using the Application access configuration page.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/applicationrole/{key}

Returns an application role.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The key of the application role. Use the Get all application roles operation to get the key for each application role.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/auditing/record

Returns a list of audit records. The list can be filtered to include items:

where each item in filter has at least one match in any of these fields:

summary
category
eventSource
objectItem.name If the object is a user, account ID is available to filter.
objectItem.parentName
objectItem.typeName
changedValues.changedFrom
changedValues.changedTo
remoteAddress

For example, if filter contains man ed, an audit record containing summary": "User added to group" and "category": "group management" is returned.

created on or after a date and time.
created or or before a date and time.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Offset`	The number of records to skip before returning the first result.
`Limit`	The maximum number of results to return.
`Filter`	The strings to match with audit field content, space separated.
`From`	The date and time on or after which returned audit records must have been created. If to is provided from must be before to or no audit records are returned.
`To`	The date and time on or before which returned audit results must have been created. If from is provided to must be after from or no audit records are returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}

Deletes an avatar from a project or issue type.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The avatar type.
`Owningobjectid`	The ID of the item the avatar is associated with.
`Id`	The ID of the avatar.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/universal_avatar/view/type/{type}/avatar/{id}

Returns a project or issue type avatar image by ID.

This operation can be accessed anonymously.

Permissions required:

For system avatars, none.
For custom project avatars, Browse projects project permission for the project the avatar belongs to.
For custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The icon type of the avatar.
`Id`	The ID of the avatar.
`Size`	The size of the avatar image. If not provided the default size is returned.
`Format`	The format to return the avatar image in. If not provided the original content format is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}

Returns the avatar image for a project or issue type.

This operation can be accessed anonymously.

Permissions required:

For system avatars, none.
For custom project avatars, Browse projects project permission for the project the avatar belongs to.
For custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The icon type of the avatar.
`Entityid`	The ID of the project or issue type the avatar belongs to.
`Size`	The size of the avatar image. If not provided the default size is returned.
`Format`	The format to return the avatar image in. If not provided the original content format is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/universal_avatar/view/type/{type}

Returns the default project or issue type avatar image.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The icon type of the avatar.
`Size`	The size of the avatar image. If not provided the default size is returned.
`Format`	The format to return the avatar image in. If not provided the original content format is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/universal_avatar/type/{type}/owner/{entityId}

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

This operation can be accessed anonymously.

Permissions required:

for custom project avatars, Browse projects project permission for the project the avatar belongs to.
for custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.
for system avatars, none.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The avatar type.
`Entityid`	The ID of the item the avatar is associated with.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/avatar/{type}/system

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

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The avatar type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/universal_avatar/type/{type}/owner/{entityId}

Loads a custom avatar for a project or issue type.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:

Bash

curl --request POST 

--user email@example.com:<api_token> 

--header 'X-Atlassian-Token: no-check' 

--header 'Content-Type: image/< image_type>' 

--data-binary "<@/path/to/file/with/your/avatar>" 

--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use:

Update issue type to set it as the issue type's displayed avatar.
Set project avatar to set it as the project's displayed avatar.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	The avatar type.
`Entityid`	The ID of the item the avatar is associated with.
`X`	The X coordinate of the top-left corner of the crop region.
`Y`	The Y coordinate of the top-left corner of the crop region.
`Size`	The length of each side of the crop region.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the avatar image data and metadata (size, cropping, etc.) as a multipart form body.

/rest/api/3/dashboard/{dashboardId}/gadget

Adds a gadget to a dashboard.

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Color`	The color of the gadget. Should be one of blue, red, yellow, green, cyan, purple, gray, or white.
`Ignoreuriandmodulekeyvalidation`	Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.
`Modulekey`	The module key of the gadget type. Can't be provided with uri.
`Title`	The title of the gadget.
`Uri`	The URI of the gadget type. Can't be provided with moduleKey.

/rest/api/3/dashboard/bulk/edit

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

Permissions required: None

The dashboards to be updated must be owned by the user, or the user must be an administrator.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Action`	Allowed action for bulk edit shareable entity
`Entityids`	The id list of shareable entities to be changed.
`Extendadminpermissions`	Whether the actions are executed by users with Administer Jira global permission.

/rest/api/3/dashboard/{id}/copy

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

Permissions required: None

The dashboard to be copied must be owned by or shared with the user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the dashboard to copy. Provide the dashboard numeric ID.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the dashboard.
`Name`	The name of the dashboard.

/rest/api/3/dashboard

Creates a dashboard.

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the dashboard.
`Name`	The name of the dashboard.

/rest/api/3/dashboard/{id}

Deletes a dashboard.

Permissions required: None

The dashboard to be deleted must be owned by the user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the dashboard.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}

Deletes a dashboard item property.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Itemid`	The ID of the dashboard item.
`Propertykey`	The key of the dashboard item property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard

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

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filter`	The filter applied to the list of dashboards. Valid values are: favourite Returns dashboards the user has marked as favorite. my Returns dashboards owned by the user.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/gadgets

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

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{id}

Returns a dashboard.

This operation can be accessed anonymously.

Permissions required: None.

However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the dashboard.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}

Returns the key and value of a dashboard item property.

A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

There is no resource to set or get dashboard items.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira\\u2019s anonymous access is permitted.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Itemid`	The ID of the dashboard item.
`Propertykey`	The key of the dashboard item property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties

Returns the keys of all properties for a dashboard item.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira\\u2019s anonymous access is permitted.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Itemid`	The ID of the dashboard item.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{dashboardId}/gadget

Returns a list of dashboard gadgets on a dashboard.

This operation returns:

Gadgets from a list of IDs, when id is set.
Gadgets with a module key, when moduleKey is set.
Gadgets from a list of URIs, when uri is set.
All gadgets, when no other parameters are set.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Modulekey`	The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: moduleKey=key:one&moduleKey=key:two.
`Uri`	The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: uri=/rest/example/uri/1&uri=/rest/example/uri/2.
`Gadgetid`	The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: gadgetId=10000&gadgetId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}

Removes a dashboard gadget from a dashboard.

When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Gadgetid`	The ID of the gadget.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/search

Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: The following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardname`	String used to perform a case-insensitive partial match with name.
`Accountid`	User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.
`Owner`	This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.
`Groupname`	As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.
`Groupid`	Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
`Projectid`	Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
`Orderby`	Order the results by a field: description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. favourite_count Sorts by dashboard popularity. id Sorts by dashboard ID. is_favourite Sorts by whether the dashboard is marked as a favorite. name Sorts by dashboard name. owner Sorts by dashboard owner name.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Status`	The status to filter by. It may be active, archived or deleted.
`Expand`	Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: description Returns the description of the dashboard. owner Returns the owner of the dashboard. viewUrl Returns the URL that is used to view the dashboard. favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. sharePermissions Returns details of the share permissions defined for the dashboard. editPermissions Returns details of the edit permissions defined for the dashboard. isWritable Returns whether the current user has permission to edit the dashboard.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}

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

A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Itemid`	The ID of the dashboard item.
`Propertykey`	The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an object with all keys and values as strings.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/api/3/dashboard/{id}

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

Permissions required: None

The dashboard to be updated must be owned by the user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the dashboard to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the dashboard.
`Name`	The name of the dashboard.

/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}

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

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dashboardid`	The ID of the dashboard.
`Gadgetid`	The ID of the gadget.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Color`	The color of the gadget. Should be one of blue, red, yellow, green, cyan, purple, gray, or white.
`Title`	The title of the gadget.

/rest/atlassian-connect/1/app/module/dynamic

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/atlassian-connect/1/app/module/dynamic

Registers a list of modules.

Permissions required: Only Connect apps can make this request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Modules`	A Connect module (https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the app descriptor (https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).

/rest/atlassian-connect/1/app/module/dynamic

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

Permissions required: Only Connect apps can make this request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Modulekey`	The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/permission

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

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Accountid`	The user account ID that the filter is shared with. For a request, specify the accountId property for the user.
`Groupid`	The ID of the group, which uniquely identifies the group across all Atlassian products.For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2. Cannot be provided with groupname.
`Groupname`	The name of the group to share the filter with. Set type to group. Please note that the name of a group is mutable, to reliably identify a group use groupId.
`Projectid`	The ID of the project to share the filter with. Set type to project.
`Projectroleid`	The ID of the project role to share the filter with. Set type to projectRole and the projectId for the project that the role is in.
`Rights`	The rights for the share permission.
`Type`	The type of the share permission.Specify the type as follows: user Share with a user. group Share with a group. Specify groupname as well. project Share with a project. Specify projectId as well. projectRole Share with a project role in a project. Specify projectId and projectRoleId as well. global Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set. authenticated Share with all logged-in users. This shows as loggedin in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.

/rest/api/3/filter/{id}/permission/{permissionId}

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Permissionid`	The ID of the share permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/defaultShareScope

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

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/permission/{permissionId}

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

This operation can be accessed anonymously.

Permissions required: None, however, a share permission is only returned for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Permissionid`	The ID of the share permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/permission

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

This operation can be accessed anonymously.

Permissions required: None, however, share permissions are only returned for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/defaultShareScope

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

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name

Description

Scope

The scope of the default sharing for new filters and dashboards:

AUTHENTICATED Shared with all logged-in users.
GLOBAL Shared with all logged-in users. This shows as AUTHENTICATED in the response.

PRIVATE Not shared with any users.

/rest/api/3/filter/{id}/favourite

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/owner

Changes the owner of the filter.

Permissions required: Permission to access Jira. However, the user must own the filter or have the Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Accountid`	The account ID of the new owner.

/rest/api/3/filter

Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
`Overridesharepermissions`	EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Description`	A description of the filter.
`Favourite`	Whether the filter is selected as a favorite.
`Favouritedcount`	The count of how many users have selected this filter as a favorite, including the filter owner.
`Id`	The unique identifier for the filter.
`Jql`	The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
`Name`	The name of the filter. Must be unique.
`Searchurl`	A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.
`Self`	The URL of the filter.
`Viewurl`	A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.

/rest/api/3/filter/{id}

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/columns

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

This operation can be accessed anonymously.

Permissions required: None, however, column details are only returned for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/favourite

Returns the visible favorite filters of the user.

This operation can be accessed anonymously.

Permissions required: A favorite filter is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

Response Type

The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}

Returns a filter.

This operation can be accessed anonymously.

Permissions required: None, however, the filter is only returned where it is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter to return.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
`Overridesharepermissions`	EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/my

Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
`Includefavourites`	Include the user's favorite filters in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/favourite

Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/columns

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

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/search

Returns a paginated list of filters. Use this operation to get:

specific filters, by defining id only.
filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: None, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filtername`	String used to perform a case-insensitive partial match with name.
`Accountid`	User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner.
`Owner`	This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId.
`Groupname`	As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter.
`Groupid`	Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
`Projectid`	Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id.
`Id`	The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Do not exceed 200 filter IDs.
`Orderby`	Order the results by a field: description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. favourite_count Sorts by the count of how many users have this filter as a favorite. is_favourite Sorts by whether the filter is marked as a favorite. id Sorts by filter ID. name Sorts by filter name. owner Sorts by the ID of the filter owner. is_shared Sorts by whether the filter is shared.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: description Returns the description of the filter. favourite Returns an indicator of whether the user has set the filter as a favorite. favouritedCount Returns a count of how many users have set this filter as a favorite. jql Returns the JQL query that the filter uses. owner Returns the owner of the filter. searchUrl Returns a URL to perform the filter's JQL query. sharePermissions Returns the share permissions defined for the filter. editPermissions Returns the edit permissions defined for the filter. isWritable Returns whether the current user has permission to edit the filter. subscriptions Returns the users that are subscribed to the filter. viewUrl Returns a URL to view the filter.
`Overridesharepermissions`	EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/filter/{id}/columns

Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

The parameters for this resource are expressed as HTML form data. For example, in curl:

Bash

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide an array of column names (field IDs) to display in the filter results.

/rest/api/3/filter/{id}

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

Permissions required: Permission to access Jira, however the user must own the filter.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the filter to update.
`Expand`	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
`Overridesharepermissions`	EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Description`	A description of the filter.
`Favourite`	Whether the filter is selected as a favorite.
`Favouritedcount`	The count of how many users have selected this filter as a favorite, including the filter owner.
`Id`	The unique identifier for the filter.
`Jql`	The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
`Name`	The name of the filter. Must be unique.
`Searchurl`	A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.
`Self`	The URL of the filter.
`Viewurl`	A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.

/rest/api/3/groupuserpicker

Returns a list of users and groups matching a string. The string is used:

for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
for groups, to find a case-sensitive match with group name.

For example, if the string tin is used, records with the display name Tina, email address sarah@tinplatetraining.com, and the group accounting would be returned.

Optionally, the search can be refined to:

the projects and issue types associated with a custom field, such as a user picker. The search can then be further refined to return only users and groups that have permission to view specific:

projects.
issue types.

If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.

not return Connect app users and groups.
return groups that have a case-insensitive match with the query.

The primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an html field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically Showing X of Y matching groups.

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	The search string.
`Maxresults`	The maximum number of items to return in each list.
`Showavatar`	Whether the user avatar should be returned. If an invalid value is provided, the default value is used.
`Fieldid`	The custom field ID of the field this request is for.
`Projectid`	The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present.
`Issuetypeid`	The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.
`Avatarsize`	The size of the avatar to return. If an invalid value is provided, the default value is used.
`Caseinsensitive`	Whether the search for groups should be case insensitive.
`Excludeconnectaddons`	Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/group/user

Adds a user to a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupname`	As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.
`Groupid`	The ID of the group. This parameter cannot be used with the groupName parameter.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Name`	This property is no longer available. See the deprecation notice for details.

/rest/api/3/group/bulk

Returns a paginated list of groups.

Permissions required: Browse users and groups global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Groupid`	The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5.
`Groupname`	The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&groupName=jira-software-users.
`Accesstype`	The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
`Applicationkey`	The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/group

Creates a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The name of the group.

/rest/api/3/groups/picker

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

The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matching groups.

The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission. Anonymous calls and calls by users without the required permission return an empty list.

Browse users and groups global permission. Without this permission, calls where query is not an exact match to an existing group will return an empty list.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use Get user groups.
`Query`	The string to find in group names.
`Exclude`	As a group's name can change, use of excludeGroupIds is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&exclude=group2. This parameter cannot be used with the excludeGroupIds parameter.
`Excludeid`	A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter.
`Maxresults`	The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit.
`Caseinsensitive`	Whether the search for groups should be case insensitive.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/group

This operation is deprecated, use group/member.

Returns all users in a group.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupname`	As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.
`Groupid`	The ID of the group. This parameter cannot be used with the groupName parameter.
`Expand`	List of fields to expand.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/group/member

Returns a paginated list of all users in a group.

Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupname`	As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.
`Groupid`	The ID of the group. This parameter cannot be used with the groupName parameter.
`Includeinactiveusers`	Include inactive users.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/group

Deletes a group.

Permissions required: Site administration (that is, member of the site-admin strategic group).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupname`	The name of the group to delete. Provide the exact group name as a query parameter.
`Groupid`	The ID of the group. This parameter cannot be used with the groupname parameter.
`Swapgroup`	As a group's name can change, use of swapGroupId is recommended to identify a group. The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroupId parameter.
`Swapgroupid`	The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroup parameter.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/group/user

Removes a user from a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupname`	As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.
`Groupid`	The ID of the group. This parameter cannot be used with the groupName parameter.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/attachments

Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867).

Note that:

The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers for more information.
The name of the multipart/form-data parameter that contains the attachments must be file.

The following examples upload a file called myfile.txt to the issue TEST-123:

curl

Bash

curl --location --request POST 'https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments'
 -u 'email@example.com:<api_token>'
 -H 'X-Atlassian-Token: no-check'
 --form 'file=@"myfile.txt"'

Node.js

JavaScript

// This code sample uses the 'node-fetch' and 'form-data' libraries:
 // https://www.npmjs.com/package/node-fetch
 // https://www.npmjs.com/package/form-data
 const fetch = require('node-fetch');
 const FormData = require('form-data');
 const fs = require('fs');

 const filePath = 'myfile.txt';
 const form = new FormData();
 const stats = fs.statSync(filePath);
 const fileSizeInBytes = stats.size;
 const fileStream = fs.createReadStream(filePath);

 form.append('file', fileStream, {knownLength: fileSizeInBytes});

 fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments', {
     method: 'POST',
     body: form,
     headers: {
         'Authorization': `Basic ${Buffer.from(
             'email@example.com:'
         ).toString('base64')}`,
         'Accept': 'application/json',
         'X-Atlassian-Token': 'no-check'
     }
 })
     .then(response => {
         console.log(
             `Response: ${response.status} ${response.statusText}`
         );
         return response.text();
     })
     .then(text => console.log(text))
     .catch(err => console.error(err));

Java

// This code sample uses the  'Unirest' library:
 // http://unirest.io/java.html
 HttpResponse response = Unirest.post("https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments")
         .basicAuth("email@example.com", "")
         .header("Accept", "application/json")
         .header("X-Atlassian-Token", "no-check")
         .field("file", new File("myfile.txt"))
         .asJson();

         System.out.println(response.getBody());

Python

# This code sample uses the 'requests' library:
 # http://docs.python-requests.org
 import requests
 from requests.auth import HTTPBasicAuth
 import json

 url = "https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments"

 auth = HTTPBasicAuth("email@example.com", "")

 headers = {
    "Accept": "application/json",
    "X-Atlassian-Token": "no-check"
 }

 response = requests.request(
    "POST",
    url,
    headers = headers,
    auth = auth,
    files = {
         "file": ("myfile.txt", open("myfile.txt","rb"), "application-type")
    }
 )

 print(json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(",", ": ")))

PHP

// This code sample uses the 'Unirest' library:
 // http://unirest.io/php.html
 Unirest\Request::auth('email@example.com', '');

 $headers = array(
   'Accept' => 'application/json',
   'X-Atlassian-Token' => 'no-check'
 );

 $parameters = array(
   'file' => File::add('myfile.txt')
 );

 $response = Unirest\Request::post(
   'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',
   $headers,
   $parameters
 );

 var_dump($response)

Forge

JavaScript

// This sample uses Atlassian Forge and the `form-data` library.
 // https://developer.atlassian.com/platform/forge/
 // https://www.npmjs.com/package/form-data
 import api from "@forge/api";
 import FormData from "form-data";

 const form = new FormData();
 form.append('file', fileStream, {knownLength: fileSizeInBytes});

 const response = await api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', {
     method: 'POST',
     body: form,
     headers: {
         'Accept': 'application/json',
         'X-Atlassian-Token': 'no-check'
     }
 });

 console.log(`Response: ${response.status} ${response.statusText}`);
 console.log(await response.json());

Tip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a MultiPartEntity class for multipart POST operations.

This operation can be accessed anonymously.

Permissions required:

Browse Projects and Create attachments project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue that attachments are added to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Bytes`	Provide the file content as a byte array or base64-encoded string.
`Contenttype`	The MIME type of the file (e.g., "image/png").
`Empty`	Set to true if the attachment is empty (no bytes).
`Inputstream`	Provide an input stream for the file data.
`Name`	The filename to be stored in Jira.
`Originalfilename`	The original filename before any transformation.
`Size`	The file size in bytes.

/rest/api/3/attachment/{id}

Deletes an attachment from an issue.

This operation can be accessed anonymously.

Permissions required: For the project holding the issue containing the attachment:

Delete own attachments project permission to delete an attachment created by the calling user.
Delete all attachments project permission to delete an attachment created by any user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the attachment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/attachment/meta

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

Note that there are also project permissions that restrict whether users can create and delete attachments.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/attachment/{id}/expand/human

Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.

Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use Get contents metadata for an expanded attachment, which only returns the metadata for the attachment's contents.

This operation can be accessed anonymously.

Permissions required: For the issue containing the attachment:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the attachment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/attachment/content/{id}

Returns the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to download. See the HTTP Range header standard for details.

To return a thumbnail of the attachment, use Get attachment thumbnail.

This operation can be accessed anonymously.

Permissions required: For the issue containing the attachment:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the attachment.
`Redirect`	Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/attachment/{id}

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

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the attachment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/attachment/thumbnail/{id}

Returns the thumbnail of an attachment.

To return the attachment contents, use Get attachment content.

This operation can be accessed anonymously.

Permissions required: For the issue containing the attachment:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the attachment.
`Redirect`	Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment.
`Fallbacktodefault`	Whether a default thumbnail is returned when the requested thumbnail is not found.
`Width`	The maximum width to scale the thumbnail to.
`Height`	The maximum height to scale the thumbnail to.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/attachment/{id}/expand/raw

Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.

Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use Get all metadata for an expanded attachment which also returns the metadata for the attachment itself, such as the attachment's ID and name.

This operation can be accessed anonymously.

Permissions required: For the issue containing the attachment:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the attachment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/comment/{commentId}/properties/{propertyKey}

Deletes a comment property.

Permissions required: either of:

Edit All Comments project permission to delete a property from any comment.
Edit Own Comments project permission to delete a property from a comment created by the user.

Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Commentid`	The ID of the comment.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/comment/{commentId}/properties/{propertyKey}

Returns the value of a comment property.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Commentid`	The ID of the comment.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/comment/{commentId}/properties

Returns the keys of all the properties of a comment.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Commentid`	The ID of the comment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/comment/{commentId}/properties/{propertyKey}

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

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: either of:

Edit All Comments project permission to create or update the value of a property on any comment.
Edit Own Comments project permission to create or update the value of a property on a comment created by the user.

Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Commentid`	The ID of the comment.
`Propertykey`	The key of the property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/api/3/issue/{issueIdOrKey}/comment

Adds a comment to an issue.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Add comments project permission for the project that the issue containing the comment is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Expand`	Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Body`	The comment text in Atlassian Document Format.
`Created`	The date and time at which the comment was created.
`Id`	The ID of the comment.
`Jsdauthorcanseerequest`	Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
`Jsdpublic`	Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
`Renderedbody`	The rendered version of the comment.
`Self`	The URL of the comment.
`Updated`	The date and time at which the comment was updated last.

/rest/api/3/issue/{issueIdOrKey}/comment/{id}

Deletes a comment.

Permissions required:

Browse projects project permission for the project that the issue containing the comment is in.
If issue-level security is configured, issue-level security permission to view the issue.
Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Id`	The ID of the comment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/comment/{id}

Returns a comment.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project containing the comment.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Id`	The ID of the comment.
`Expand`	Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/comment

Returns all comments for an issue.

This operation can be accessed anonymously.

Permissions required: Comments are included in the response where the user has:

Browse projects project permission for the project containing the comment.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Orderby`	Order the results by a field. Accepts created to sort comments by their created date.
`Expand`	Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/comment/list

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

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:

has Browse projects project permission for the project containing the comment.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: renderedBody Returns the comment body rendered in HTML. properties Returns the comment's properties.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	The list of comment IDs. A maximum of 1000 IDs can be specified.

/rest/api/3/issue/{issueIdOrKey}/comment/{id}

Updates a comment.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue containing the comment is in.
If issue-level security is configured, issue-level security permission to view the issue.
Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Id`	The ID of the comment.
`Notifyusers`	Whether users are notified when a comment is updated.
`Overrideeditableflag`	Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg).
`Expand`	Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Body`	The comment text in Atlassian Document Format.
`Created`	The date and time at which the comment was created.
`Id`	The ID of the comment.
`Jsdauthorcanseerequest`	Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
`Jsdpublic`	Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
`Renderedbody`	The rendered version of the comment.
`Self`	The URL of the comment.
`Updated`	The date and time at which the comment was updated last.

/rest/api/3/app/field/{fieldIdOrKey}/context/configuration

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

The result can be filtered by one of these criteria:

id.
fieldContextId.
issueId.
projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldidorkey`	The ID or key of the custom field, for example customfield_10000.
`Id`	The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.
`Fieldcontextid`	The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.
`Issueid`	The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.
`Projectkeyorid`	The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
`Issuetypeid`	The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/app/field/{fieldIdOrKey}/context/configuration

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

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field type.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldidorkey`	The ID or key of the custom field, for example customfield_10000.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/{contextId}/issuetype

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

A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types.

If any of the issue types exists in the custom field context, the operation fails and no issue types are added.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issuetypeids`	The list of issue type IDs.

/rest/api/3/field/{fieldId}/context/{contextId}/project

Assigns a custom field context to projects.

If any project in the request is assigned to any context of the custom field, the operation fails.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Projectids`	The IDs of projects.

/rest/api/3/field/{fieldId}/context

Creates a custom field context.

If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Description`	The description of the context.
`Id`	The ID of the context.
`Issuetypeids`	The list of issue types IDs for the context. If the list is empty, the context refers to all issue types.
`Name`	The name of the context.
`Projectids`	The list of project IDs associated with the context. If the list is empty, the context is global.

/rest/api/3/field/{fieldId}/context/{contextId}

Deletes a custom field context.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context

Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:

With no other parameters set, all contexts.
By defining id only, all contexts from the list of IDs.
By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false)
By defining isGlobalContext, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Isanyissuetype`	Whether to return contexts that apply to all issue types.
`Isglobalcontext`	Whether to return contexts that apply to all projects.
`Contextid`	The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&contextId=10001.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/defaultValue

Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
The returned object depends on type of the custom field:

CustomFieldContextDefaultValueDate (type datepicker) for date fields.
CustomFieldContextDefaultValueDateTime (type datetimepicker) for date-time fields.
CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons.
CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes.
CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists.
CustomFieldContextSingleUserPickerDefaults (type single.user.select) for single users.
CustomFieldContextDefaultValueMultiUserPicker (type multi.user.select) for user lists.
CustomFieldContextDefaultValueSingleGroupPicker (type grouppicker.single) for single choice group pickers.
CustomFieldContextDefaultValueMultipleGroupPicker (type grouppicker.multiple) for multiple choice group pickers.
CustomFieldContextDefaultValueURL (type url) for URLs.
CustomFieldContextDefaultValueProject (type project) for project pickers.
CustomFieldContextDefaultValueFloat (type float) for floats (floating-point numbers).
CustomFieldContextDefaultValueLabels (type labels) for labels.
CustomFieldContextDefaultValueTextField (type textfield) for text fields.
CustomFieldContextDefaultValueTextArea (type textarea) for text area fields.
CustomFieldContextDefaultValueReadOnly (type readonly) for read only (text) fields.
CustomFieldContextDefaultValueMultipleVersion (type version.multiple) for single choice version pickers.
CustomFieldContextDefaultValueSingleVersion (type version.single) for multiple choice version pickers.

Forge custom fields types are also supported, returning:

CustomFieldContextDefaultValueForgeStringFieldBean (type forge.string) for Forge string fields.
CustomFieldContextDefaultValueForgeMultiStringFieldBean (type forge.string.list) for Forge string collection fields.
CustomFieldContextDefaultValueForgeObjectFieldBean (type forge.object) for Forge object fields.
CustomFieldContextDefaultValueForgeDateTimeFieldBean (type forge.datetime) for Forge date-time fields.
CustomFieldContextDefaultValueForgeGroupFieldBean (type forge.group) for Forge group fields.
CustomFieldContextDefaultValueForgeMultiGroupFieldBean (type forge.group.list) for Forge group collection fields.
CustomFieldContextDefaultValueForgeNumberFieldBean (type forge.number) for Forge number fields.
CustomFieldContextDefaultValueForgeUserFieldBean (type forge.user) for Forge user fields.
CustomFieldContextDefaultValueForgeMultiUserFieldBean (type forge.user.list) for Forge user collection fields.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field, for example customfield\_10000.
`Contextid`	The IDs of the contexts.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/mapping

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

If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null.

Duplicate project and issue type mappings cannot be provided in the request.

The order of the returned values is the same as provided in the request.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/issuetypemapping

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, contextId=10001&contextId=10002.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/projectmapping

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field, for example customfield\_10000.
`Contextid`	The list of context IDs. To include multiple context, separate IDs with ampersand: contextId=10000&contextId=10001.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/{contextId}/project/remove

Removes a custom field context from projects.

A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects.

If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Projectids`	The IDs of projects.

/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove

Removes issue types from a custom field context.

A custom field context without any issue types applies to all issue types.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issuetypeids`	The list of issue type IDs.

/rest/api/3/field/{fieldId}/context/defaultValue

Sets default for contexts of a custom field. Default are defined using these objects:

CustomFieldContextDefaultValueDate (type datepicker) for date fields.
CustomFieldContextDefaultValueDateTime (type datetimepicker) for date-time fields.
CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons.
CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes.
CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists.
CustomFieldContextSingleUserPickerDefaults (type single.user.select) for single users.
CustomFieldContextDefaultValueMultiUserPicker (type multi.user.select) for user lists.
CustomFieldContextDefaultValueSingleGroupPicker (type grouppicker.single) for single choice group pickers.
CustomFieldContextDefaultValueMultipleGroupPicker (type grouppicker.multiple) for multiple choice group pickers.
CustomFieldContextDefaultValueURL (type url) for URLs.
CustomFieldContextDefaultValueProject (type project) for project pickers.
CustomFieldContextDefaultValueFloat (type float) for floats (floating-point numbers).
CustomFieldContextDefaultValueLabels (type labels) for labels.
CustomFieldContextDefaultValueTextField (type textfield) for text fields.
CustomFieldContextDefaultValueTextArea (type textarea) for text area fields.
CustomFieldContextDefaultValueReadOnly (type readonly) for read only (text) fields.
CustomFieldContextDefaultValueMultipleVersion (type version.multiple) for single choice version pickers.
CustomFieldContextDefaultValueSingleVersion (type version.single) for multiple choice version pickers.

Forge custom fields types are also supported, returning:

CustomFieldContextDefaultValueForgeStringFieldBean (type forge.string) for Forge string fields.
CustomFieldContextDefaultValueForgeMultiStringFieldBean (type forge.string.list) for Forge string collection fields.
CustomFieldContextDefaultValueForgeObjectFieldBean (type forge.object) for Forge object fields.
CustomFieldContextDefaultValueForgeDateTimeFieldBean (type forge.datetime) for Forge date-time fields.
CustomFieldContextDefaultValueForgeGroupFieldBean (type forge.group) for Forge group fields.
CustomFieldContextDefaultValueForgeMultiGroupFieldBean (type forge.group.list) for Forge group collection fields.
CustomFieldContextDefaultValueForgeNumberFieldBean (type forge.number) for Forge number fields.
CustomFieldContextDefaultValueForgeUserFieldBean (type forge.user) for Forge user fields.
CustomFieldContextDefaultValueForgeMultiUserFieldBean (type forge.user.list) for Forge user collection fields.

Only one type of default object can be included in a request. To remove a default for a context, set the default parameter to null.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Defaultvalues`	Provide an array of default value objects, each specifying a context and value.

/rest/api/3/field/{fieldId}/context/{contextId}

Updates a custom field context.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the custom field context. The maximum length is 255 characters.
`Name`	The name of the custom field context. The name must be unique. The maximum length is 255 characters.

/rest/api/3/field/{fieldKey}/option

Creates an option for a select list issue field.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Value`	The option's name, which is displayed in Jira.

/rest/api/3/field/{fieldKey}/option/{optionId}

Deletes an option from a select list issue field.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Optionid`	The ID of the option to be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldKey}/option

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

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldKey}/option/{optionId}

Returns an option from a select list issue field.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Optionid`	The ID of the option to be returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldKey}/option/suggestions/edit

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

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Projectid`	Filters the results to options that are only available in the specified project.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldKey}/option/suggestions/search

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

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Projectid`	Filters the results to options that are only available in the specified project.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldKey}/option/{optionId}/issue

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

Connect and Forge app users with Administer Jira global permission can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.

This is an asynchronous operation. The response object contains a link to the long-running task.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Replacewith`	The ID of the option that will replace the currently selected option.
`Jql`	A JQL query that specifies the issues to be updated. For example, project=10000.
`Overridescreensecurity`	Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.
`Overrideeditableflag`	Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Optionid`	The ID of the option to be deselected.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldKey}/option/{optionId}

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

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldkey`	The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the fieldKey value, do one of the following: open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
`Optionid`	The ID of the option to be updated.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	The unique identifier for the option. This is only unique within the select field's set of options.
`Value`	The option's name, which is displayed in Jira.

/rest/api/3/field/{fieldId}/context/{contextId}/option

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

The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.

This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}

Deletes a custom field option.

Options with cascading options cannot be deleted without deleting the cascading options first.

This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context from which an option should be deleted.
`Optionid`	The ID of the option to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/customFieldOption/{id}

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

Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps.

This operation can be accessed anonymously.

Permissions required: The custom field option is returned as follows:

if the user has the Administer Jira global permission.
if the user has the Browse projects project permission for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the custom field option.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/{contextId}/option

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

This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Optionid`	The ID of the option.
`Onlyoptions`	Whether only options are returned.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/context/{contextId}/option/move

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

This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`After`	The ID of the custom field option or cascading option to place the moved options after. Required if position isn't provided.
`Customfieldoptionids`	A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both.
`Position`	The position the custom field options should be moved to. Required if after isn't provided.

/rest/api/3/field/{fieldId}/context/{contextId}/option

Updates the options of a custom field.

If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response.

Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Contextid`	The ID of the context.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/app/field/{fieldIdOrKey}/value

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

Apps can only perform this operation on custom fields and custom field types declared in their own manifests.

Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldidorkey`	The ID or key of the custom field. For example, customfield_10010.
`Generatechangelog`	Whether to generate a changelog for this update.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/app/field/value

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

Apps can only perform this operation on custom fields and custom field types declared in their own manifests.

Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Generatechangelog`	Whether to generate a changelog for this update.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme/project

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

Field configuration schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Fieldconfigurationschemeid`	The ID of the field configuration scheme. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.
`Projectid`	The ID of the project.

/rest/api/3/fieldconfigurationscheme/{id}/mapping

Assigns issue types to field configurations on field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfiguration

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

This operation can only create configurations for use in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the field configuration.
`Name`	The name of the field configuration. Must be unique.

/rest/api/3/fieldconfigurationscheme

Creates a field configuration scheme.

This operation can only create field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the field configuration scheme.
`Name`	The name of the field configuration scheme. The name must be unique.

/rest/api/3/fieldconfiguration/{id}

Deletes a field configuration.

This operation can only delete configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme/{id}

Deletes a field configuration scheme.

This operation can only delete field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme

Returns a paginated list of field configuration schemes.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfiguration

Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:

a list of field configuration item IDs.
whether the field configuration is a default.
whether the field configuration name or description contains a query string.

Only field configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
`Isdefault`	If true returns default field configurations only.
`Query`	The query string used to match against field configuration names and descriptions.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme/mapping

Returns a paginated list of field configuration issue type items.

Only items used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Fieldconfigurationschemeid`	The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfiguration/{id}/fields

Returns a paginated list of all fields for a configuration.

Only the fields from configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme/project

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

The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Projectid`	The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete

Removes issue types from the field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issuetypeids`	The list of issue type IDs. Must contain unique values not longer than 255 characters and not be empty. Maximum of 100 IDs.

/rest/api/3/fieldconfiguration/{id}

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

This operation can only update configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the field configuration.
`Name`	The name of the field configuration. Must be unique.

/rest/api/3/fieldconfiguration/{id}/fields

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

This operation can only update field configurations used in company-managed (classic) projects.

The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/fieldconfigurationscheme/{id}

Updates a field configuration scheme.

This operation can only update field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the field configuration scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the field configuration scheme.
`Name`	The name of the field configuration scheme. The name must be unique.

/rest/api/3/field

Creates a custom field.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description of the custom field, which is displayed in Jira.
`Name`	The name of the custom field, which is displayed in Jira. This is not the unique identifier.
`Searcherkey`	The searcher defines the way the field is searched in Jira. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher. The search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown): cascadingselect: cascadingselectsearcher datepicker: daterange datetime: datetimerange float: exactnumber or numberrange grouppicker: grouppickersearcher importid: exactnumber or numberrange labels: labelsearcher multicheckboxes: multiselectsearcher multigrouppicker: multiselectsearcher multiselect: multiselectsearcher multiuserpicker: userpickergroupsearcher multiversion: versionsearcher project: projectsearcher radiobuttons: multiselectsearcher readonlyfield: textsearcher select: multiselectsearcher textarea: textsearcher textfield: textsearcher url: exacttextsearcher userpicker: userpickergroupsearcher version: versionsearcher If no searcher is provided, the field isn't searchable. However, Forge custom fields have a searcher set automatically, so are always searchable.
`Type`	The type of the custom field. These built-in custom field types are available: cascadingselect: Enables values to be selected from two levels of select lists (value: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect) datepicker: Stores a date using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:datepicker) datetime: Stores a date with a time component (value: com.atlassian.jira.plugin.system.customfieldtypes:datetime) float: Stores and validates a numeric (floating point) input (value: com.atlassian.jira.plugin.system.customfieldtypes:float) grouppicker: Stores a user group using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:grouppicker) importid: A read-only field that stores the ID the issue had in the system it was imported from (value: com.atlassian.jira.plugin.system.customfieldtypes:importid) labels: Stores labels (value: com.atlassian.jira.plugin.system.customfieldtypes:labels) multicheckboxes: Stores multiple values using checkboxes (value: `) multigrouppicker: Stores multiple user groups using a picker control (value: ) multiselect: Stores multiple values using a select list (value: com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes) multiuserpicker: Stores multiple users using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker) multiversion: Stores multiple versions from the versions available in a project using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multiversion) project: Stores a project from a list of projects that the user is permitted to view (value: com.atlassian.jira.plugin.system.customfieldtypes:project) radiobuttons: Stores a value using radio buttons (value: com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons) readonlyfield: Stores a read-only text value, which can only be populated via the API (value: com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield) select: Stores a value from a configurable list of options (value: com.atlassian.jira.plugin.system.customfieldtypes:select) textarea: Stores a long text string using a multiline text area (value: com.atlassian.jira.plugin.system.customfieldtypes:textarea) textfield: Stores a text string using a single-line text box (value: com.atlassian.jira.plugin.system.customfieldtypes:textfield) url: Stores a URL (value: com.atlassian.jira.plugin.system.customfieldtypes:url) userpicker: Stores a user using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:userpicker) version: Stores a version using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:version) To create a field based on a Forge custom field type, use the ID of the Forge custom field type as the value. For example, ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key`.

/rest/api/3/field/{id}

Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of a custom field.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/contexts

Returns a paginated list of the contexts a field is used in. Deprecated, use Get custom field contexts.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the field to return contexts for.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field

Returns system and custom issue fields according to the following rules:

Fields that cannot be added to the issue navigator are always returned.
Fields that cannot be placed on an issue screen are always returned.
Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/search/trashed

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

Only custom fields can be queried, type must be set to custom.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	Filter by field IDs. Provide one or more field IDs as query parameters.
`Query`	String used to perform a case-insensitive partial match with field names or descriptions.
`Expand`	Expand additional information in the response, such as the field's searcher or schema.
`Orderby`	Order the results by a field: name sorts by the field name trashDate sorts by the date the field was moved to the trash plannedDeletionDate sorts by the planned deletion date
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/search

Returns a paginated list of fields for Classic Jira projects. The list can include:

all fields
specific fields, by defining id
fields that contain a string in the field name or description, by defining query
specific fields that contain a string in the field name or description, by defining id and query

Only custom fields can be queried, type must be set to custom.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Type`	The type of fields to search.
`Id`	The IDs of the custom fields to return or, where query is specified, filter.
`Query`	String used to perform a case-insensitive partial match with field names or descriptions.
`Orderby`	Order the results by a field: contextsCount sorts by the number of contexts related to a field lastUsed sorts by the date when the value of the field last changed name sorts by the field name screensCount sorts by the number of screens related to a field
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: key returns the key for each field lastUsed returns the date when the value of the field last changed screensCount returns the number of screens related to a field contextsCount returns the number of contexts related to a field isLocked returns information about whether the field is locked searcherKey returns the searcher key for each custom field
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{id}/trash

Moves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of a custom field.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{id}/restore

Restores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of a custom field.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}

Updates a custom field.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the custom field.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name

Description

Description

The description of the custom field. The maximum length is 40000 characters.

Name

The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.

Searcherkey

The searcher that defines the way the field is searched in Jira. It can be set to null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):

cascadingselect: cascadingselectsearcher
datepicker: daterange
datetime: datetimerange
float: exactnumber or numberrange
grouppicker: grouppickersearcher
importid: exactnumber or numberrange
labels: labelsearcher
multicheckboxes: multiselectsearcher
multigrouppicker: multiselectsearcher
multiselect: multiselectsearcher
multiuserpicker: userpickergroupsearcher
multiversion: versionsearcher
project: projectsearcher
radiobuttons: multiselectsearcher
readonlyfield: textsearcher
select: multiselectsearcher
textarea: textsearcher
textfield: textsearcher
url: exacttextsearcher
userpicker: userpickergroupsearcher

version: versionsearcher

/rest/api/3/issueLinkType

Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Id`	The ID of the issue link type and is used as follows: In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only. In the issueLinkType resource it is read only.
`Inward`	The description of the issue link type inward link and is used as follows: In the issueLink resource it is read only. In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
`Name`	The name of the issue link type and is used as follows: In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only. In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
`Outward`	The description of the issue link type outward link and is used as follows: In the issueLink resource it is read only. In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
`Self`	The URL of the issue link type. Read only.

/rest/api/3/issueLinkType/{issueLinkTypeId}

Deletes an issue link type.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuelinktypeid`	The ID of the issue link type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issueLinkType/{issueLinkTypeId}

Returns an issue link type.

To use this operation, the site must have issue linking enabled.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for a project in the site.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuelinktypeid`	The ID of the issue link type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issueLinkType

Returns a list of all issue link types.

To use this operation, the site must have issue linking enabled.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for a project in the site.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issueLinkType/{issueLinkTypeId}

Updates an issue link type.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuelinktypeid`	The ID of the issue link type.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Id`	The ID of the issue link type and is used as follows: In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only. In the issueLinkType resource it is read only.
`Inward`	The description of the issue link type inward link and is used as follows: In the issueLink resource it is read only. In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
`Name`	The name of the issue link type and is used as follows: In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only. In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
`Outward`	The description of the issue link type outward link and is used as follows: In the issueLink resource it is read only. In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
`Self`	The URL of the issue link type. Read only.

/rest/api/3/issueLink

Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.

This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks.

If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.

This operation can be accessed anonymously.

Permissions required:

Browse project project permission for all the projects containing the issues to be linked,
Link issues project permission on the project containing the from (outward) issue,
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issueLink/{linkId}

Deletes an issue link.

This operation can be accessed anonymously.

Permissions required:

Browse project project permission for all the projects containing the issues in the link.
Link issues project permission for at least one of the projects containing issues in the link.
If issue-level security is configured, permission to view both of the issues.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Linkid`	The ID of the issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issueLink/{linkId}

Returns an issue link.

This operation can be accessed anonymously.

Permissions required:

Browse project project permission for all the projects containing the linked issues.
If issue-level security is configured, permission to view both of the issues.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Linkid`	The ID of the issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/settings/columns

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/settings/columns

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

Bash

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Columns`	Provide an array of column names (field IDs) to set as the default navigator columns.

/rest/api/3/notificationscheme/{id}/notification

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

Deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the changelog for more details.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/notificationscheme

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the notification scheme.
`Name`	The name of the notification scheme. Must be unique (case-insensitive).

/rest/api/3/notificationscheme/{notificationSchemeId}

Deletes a notification scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Notificationschemeid`	The ID of the notification scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/notificationscheme/{id}

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

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: all Returns all expandable information field Returns information about any custom fields assigned to receive an event group Returns information about any groups assigned to receive an event notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information projectRole Returns information about any project roles assigned to receive an event user Returns information about any users assigned to receive an event
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/notificationscheme

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

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of notification schemes IDs to be filtered by
`Projectid`	The list of projects IDs to be filtered by
`Onlydefault`	When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: all Returns all expandable information field Returns information about any custom fields assigned to receive an event group Returns information about any groups assigned to receive an event notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information projectRole Returns information about any project roles assigned to receive an event user Returns information about any users assigned to receive an event
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/notificationscheme/project

Returns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Notificationschemeid`	The list of notifications scheme IDs to be filtered out
`Projectid`	The list of project IDs to be filtered out
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}

Removes a notification from a notification scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Notificationschemeid`	The ID of the notification scheme.
`Notificationid`	The ID of the notification.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/notificationscheme/{id}

Updates a notification scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the notification scheme.
`Name`	The name of the notification scheme. Must be unique.

/rest/api/3/priority

Creates an issue priority.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description of the priority.
`Iconurl`	The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used.
`Name`	The name of the priority. Must be unique.
`Statuscolor`	The status color of the priority in 3-digit or 6-digit hexadecimal format.

/rest/api/3/priority/{id}

Deprecated: please refer to the changelog for more details.

Deletes an issue priority.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue priority.
`Replacewith`	The ID of the issue priority that will replace the currently selected resolution.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/priority

Returns the list of all issue priorities.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/priority/{id}

Returns an issue priority.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue priority.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/priority/move

Changes the order of issue priorities.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`After`	The ID of the priority. Required if position isn't provided.
`Ids`	The list of issue IDs to be reordered. Cannot contain duplicates nor after ID.
`Position`	The position for issue priorities to be moved to. Required if after isn't provided.

/rest/api/3/priority/search

Returns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:

a list of priority IDs. Any invalid priority IDs are ignored.
a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.
whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3.
`Projectid`	The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&projectId=10111.
`Priorityname`	The name of priority to search for.
`Onlydefault`	Whether only the default priority is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/priority/default

Sets default issue priority.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Id`	The ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting.

/rest/api/3/priority/{id}

Updates an issue priority.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue priority.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description of the priority.
`Iconurl`	The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used.
`Name`	The name of the priority. Must be unique.
`Statuscolor`	The status color of the priority in 3-digit or 6-digit hexadecimal format.

/rest/api/3/issue/properties/{propertyKey}

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

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT\_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If issue-level security is configured, issue-level security permission to view the issue.
Edit issues project permission for each issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Currentvalue`	The value of properties to perform the bulk operation on.
`Entityids`	List of issues to perform the bulk delete operation on.

/rest/api/3/issue/properties/multi

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

The value of the request body must be a valid, non-empty JSON.

This operation is:

asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.
non-transactional. Updating some entities may fail. Such information will available in the task result.

Permissions required:

Browse projects and Edit issues project permissions for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/properties/{propertyKey}

Sets a property value on multiple issues.

The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictions that apply to all Jira expressions.

The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:

If true, only issues with the property are eligible.
If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

If an invalid combination of criteria is provided, an error is returned. For example, specifying a currentValue and hasProperty as false would not match any issues (because without the property the property cannot have a value).

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT\_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If issue-level security is configured, issue-level security permission to view the issue.
Edit issues project permission for each issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Propertykey`	The key of the property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Expression`	EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables available to the expression are issue and user. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored.
`Value`	The value of the property. The value must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

/rest/api/3/issue/properties

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

The value of the request body must be a valid, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously.

This operation is:

transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects and Edit issues project permissions for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Entitiesids`	A list of entity property IDs.

/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}

Deletes an issue's property.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Edit issues project permissions for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The key or ID of the issue.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}

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

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The key or ID of the issue.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/properties

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

This operation can be accessed anonymously.

Permissions required: Property details are only returned where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The key or ID of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}

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

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Edit issues project permissions for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Propertykey`	The key of the issue property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/api/3/issue/{issueIdOrKey}/remotelink

Creates or updates a remote issue link for an issue.

If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Link issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name

Description

Globalid

An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.

Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.

The maximum length is 255 characters.

Relationship

Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}

Deletes a remote issue link from an issue.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects, Edit issues, and Link issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Linkid`	The ID of a remote issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/remotelink

Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Link issues project permission for the project that the issue is in.
If issue-level security is implemented, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Globalid`	The global ID of a remote issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}

Returns a remote issue link for an issue.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Linkid`	The ID of the remote issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/remotelink

Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Globalid`	The global ID of the remote issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}

Updates a remote issue link for an issue.

Note: Fields without values in the request are set to null.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Link issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Linkid`	The ID of the remote issue link.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name

Description

Globalid

An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.

Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.

The maximum length is 255 characters.

Relationship

Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

/rest/api/3/resolution

Creates an issue resolution.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the resolution.
`Name`	The name of the resolution. Must be unique (case-insensitive).

/rest/api/3/resolution/{id}

Deletes an issue resolution.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue resolution.
`Replacewith`	The ID of the issue resolution that will replace the currently selected resolution.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/resolution/{id}

Returns an issue resolution value.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue resolution value.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/resolution

Returns a list of all issue resolution values.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/resolution/move

Changes the order of issue resolutions.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`After`	The ID of the resolution. Required if position isn't provided.
`Ids`	The list of resolution IDs to be reordered. Cannot contain duplicates nor after ID.
`Position`	The position for issue resolutions to be moved to. Required if after isn't provided.

/rest/api/3/resolution/search

Returns a paginated list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:

a list of resolutions IDs.
whether the field configuration is a default. This returns resolutions from company-managed (classic) projects only, as there is no concept of default resolutions in team-managed projects.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of resolutions IDs to be filtered out
`Onlydefault`	When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/resolution/default

Sets default issue resolution.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Id`	The ID of the new default issue resolution. Must be an existing ID or null. Setting this to null erases the default resolution setting.

/rest/api/3/resolution/{id}

Updates an issue resolution.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue resolution.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the resolution.
`Name`	The name of the resolution. Must be unique.

/rest/api/3/jql/match

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

Permissions required: None, however, issues are only matched against JQL queries where the user has:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Issueids`	A list of issue IDs.
`Jqls`	A list of JQL queries.

/rest/api/3/issue/picker

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

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A string to match against text fields in the issue such as title, description, or comments.
`Currentjql`	A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
`Currentissuekey`	The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
`Currentprojectid`	The ID of a project that suggested issues must belong to.
`Showsubtasks`	Indicate whether to include subtasks in the suggestions list.
`Showsubtaskparent`	When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/search

Searches for issues using JQL.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Jql`	The JQL that defines the search. Note: If no JQL expression is provided, all issues are returned. username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead. If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.
`Validatequery`	Determines how to validate the JQL query and treat the validation results. Supported values are: strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). warn Returns all errors as warnings. none No validation is performed. true Deprecated A legacy synonym for strict. false Deprecated* A legacy synonym for warn. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.
`Fields`	A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: all Returns all fields. navigable Returns navigable fields. Any issue field, prefixed with a minus to exclude. Examples: summary,comment Returns only the summary and comments fields. -description Returns all navigable (default) fields except description. *all,-comment Returns all fields except comments. This parameter may be specified multiple times. For example, fields=field1,field2&fields=field3. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.
`Expand`	Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include: renderedFields Returns field values rendered in HTML format. names Returns the display name of each field. schema Returns the schema describing a field type. transitions Returns all possible transitions for the issue. operations Returns all possible operations for the issue. editmeta Returns information about how each field can be edited. changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
`Properties`	A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&properties=prop3. A maximum of 5 issue property keys can be specified.
`Fieldsbykeys`	Reference fields by their key (rather than ID).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/search

Searches for issues using JQL.

There is a GET version of this resource that can be used for smaller JQL query expressions.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Expand`	Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a list of values. The expand options are: renderedFields Returns field values rendered in HTML format. names Returns the display name of each field. schema Returns the schema describing a field type. transitions Returns all possible transitions for the issue. operations Returns all possible operations for the issue. editmeta Returns information about how each field can be edited. changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
`Fields`	A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: all Returns all fields. navigable Returns navigable fields. Any issue field, prefixed with a minus to exclude. The default is navigable. Examples: summary,comment Returns the summary and comments fields only. -description Returns all navigable (default) fields except description. all,-comment Returns all fields except comments. Multiple fields parameters can be included in a request. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.
`Fieldsbykeys`	Reference fields by their key (rather than ID). The default is false.
`Jql`	A JQL expression.
`Maxresults`	The maximum number of items to return per page.
`Properties`	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
`Startat`	The index of the first item to return in the page of results (page offset). The base index is 0.
`Validatequery`	Determines how to validate the JQL query and treat the validation results. Supported values: strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). warn Returns all errors as warnings. none No validation is performed. true Deprecated A legacy synonym for strict. false Deprecated* A legacy synonym for warn. The default is strict. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

/rest/api/3/securitylevel/{id}

Returns details of an issue security level.

Use Get issue security scheme to obtain the IDs of issue security levels associated with the issue security scheme.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue security level.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members

Returns issue security level members.

Only issue security level members in context of classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuesecurityschemeid`	The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Issuesecuritylevelid`	The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: issueSecurityLevelId=10000&issueSecurityLevelId=10001.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the issue security scheme.
`Levelid`	The ID of the issue security level.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{schemeId}/level

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the issue security scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/project

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

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Projectid`	The ID of the project.
`Schemeid`	The ID of the issue security scheme. Providing null will clear the association with the issue security scheme.

/rest/api/3/issuesecurityschemes

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the issue security scheme.
`Name`	The name of the issue security scheme. Must be unique (case-insensitive).

/rest/api/3/issuesecurityschemes/{schemeId}

Deletes an issue security scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the issue security scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/level/member

Returns a paginated list of issue security level members.

Only issue security level members in the context of classic projects are returned.

Filtering using parameters is inclusive: if you specify both security scheme IDs and level IDs, the result will include all issue security level members from the specified schemes and levels.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: id=10000&id=10001.
`Schemeid`	The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: schemeId=10000&schemeId=10001.
`Levelid`	The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: levelId=10000&levelId=10001.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: all Returns all expandable information field Returns information about the custom field granted the permission group Returns information about the group that is granted the permission projectRole Returns information about the project role granted the permission user Returns information about the user who is granted the permission
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/level

Returns a paginated list of issue security levels.

Only issue security levels in the context of classic projects are returned.

Filtering using IDs is inclusive: if you specify both security scheme IDs and level IDs, the result will include both specified issue security levels and all issue security levels from the specified schemes.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand: id=10000&id=10001.
`Schemeid`	The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand: schemeId=10000&schemeId=10001.
`Onlydefault`	When set to true, returns multiple default levels for each security scheme containing a default. If you provide scheme and level IDs not associated with the default, returns an empty page. The default value is false.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{id}

Returns an issue security scheme along with its security levels.

Permissions required:

Administer Jira global permission.
Administer Projects project permission for a project that uses the requested issue security scheme.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes

Returns all issue security schemes.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/project

Returns a paginated mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Only issue security schemes in the context of classic projects are supported. Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Issuesecurityschemeid`	The list of security scheme IDs to be filtered out.
`Projectid`	The list of project IDs to be filtered out.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}

Deletes an issue security level.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the issue security scheme.
`Levelid`	The ID of the issue security level to remove.
`Replacewith`	The ID of the issue security level that will replace the currently selected level.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the issue security scheme.
`Levelid`	The ID of the issue security level.
`Memberid`	The ID of the issue security level member to be removed.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/search

Returns a paginated list of issue security schemes.
If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you filter by. Use \{@link IssueSecuritySchemeResource\#searchProjectsUsingSecuritySchemes(String, String, Set, Set)\} to obtain all projects related to scheme.

Only issue security schemes in the context of classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand: id=10000&id=10001.
`Projectid`	The list of project IDs. To include multiple project IDs, separate IDs with an ampersand: projectId=10000&projectId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/level/default

Sets default issue security levels for schemes.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}

Updates the issue security level.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the issue security scheme level belongs to.
`Levelid`	The ID of the issue security level to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the issue security scheme level.
`Name`	The name of the issue security scheme level. Must be unique.

/rest/api/3/issuesecurityschemes/{id}

Updates the issue security scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue security scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the security scheme scheme.
`Name`	The name of the security scheme scheme. Must be unique.

/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}

Deletes the issue type property.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeid`	The ID of the issue type.
`Propertykey`	The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}

Returns the key and value of the issue type property.

This operation can be accessed anonymously.

Permissions required:

Administer Jira global permission to get the details of any issue type.
Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeid`	The ID of the issue type.
`Propertykey`	The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/{issueTypeId}/properties

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

This operation can be accessed anonymously.

Permissions required:

Administer Jira global permission to get the property keys of any issue type.
Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeid`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}

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

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeid`	The ID of the issue type.
`Propertykey`	The key of the issue type property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype

Adds issue types to an issue type scheme.

The added issue types are appended to the issue types list.

If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeschemeid`	The ID of the issue type scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issuetypeids`	The list of issue type IDs.

/rest/api/3/issuetypescheme/project

Assigns an issue type scheme to a project.

If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.

Issue type schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Issuetypeschemeid`	The ID of the issue type scheme.
`Projectid`	The ID of the project.

/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move

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

The request body parameters must meet the following requirements:

all of the issue types must belong to the issue type scheme.
either after or position must be provided.
the issue type in after must not be in the issue type list.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeschemeid`	The ID of the issue type scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`After`	The ID of the issue type to place the moved issue types after. Required if position isn't provided.
`Issuetypeids`	A list of the issue type IDs to move. The order of the issue type IDs in the list is the order they are given after the move.
`Position`	The position the issue types should be moved to. Required if after isn't provided.

/rest/api/3/issuetypescheme

Creates an issue type scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Defaultissuetypeid`	The ID of the default issue type of the issue type scheme. This ID must be included in issueTypeIds.
`Description`	The description of the issue type scheme. The maximum length is 4000 characters.
`Issuetypeids`	The list of issue types IDs of the issue type scheme. At least one standard issue type ID is required.
`Name`	The name of the issue type scheme. The name must be unique. The maximum length is 255 characters.

/rest/api/3/issuetypescheme/{issueTypeSchemeId}

Deletes an issue type scheme.

Only issue type schemes used in classic projects can be deleted.

Any projects assigned to the scheme are reassigned to the default issue type scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeschemeid`	The ID of the issue type scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescheme

Returns a paginated list of issue type schemes.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
`Orderby`	Order the results by a field: name Sorts by issue type scheme name. id Sorts by issue type scheme ID.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: projects For each issue type schemes, returns information about the projects the issue type scheme is assigned to. issueTypes For each issue type schemes, returns information about the issueTypes the issue type scheme have.
`Querystring`	String used to perform a case-insensitive partial match with issue type scheme name.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescheme/mapping

Returns a paginated list of issue type scheme items.

Only issue type scheme items used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Issuetypeschemeid`	The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, issueTypeSchemeId=10000&issueTypeSchemeId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescheme/project

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

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Projectid`	The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, projectId=10000&projectId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}

Removes an issue type from an issue type scheme.

This operation cannot remove:

any issue type used by issues.
any issue types from the default issue type scheme.
the last standard issue type from an issue type scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeschemeid`	The ID of the issue type scheme.
`Issuetypeid`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescheme/{issueTypeSchemeId}

Updates an issue type scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypeschemeid`	The ID of the issue type scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Defaultissuetypeid`	The ID of the default issue type of the issue type scheme.
`Description`	The description of the issue type scheme. The maximum length is 4000 characters.
`Name`	The name of the issue type scheme. The name must be unique. The maximum length is 255 characters.

/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescreenscheme/project

Assigns an issue type screen scheme to a project.

Issue type screen schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Projectid`	The ID of the project.

/rest/api/3/issuetypescreenscheme

Creates an issue type screen scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the issue type screen scheme. The maximum length is 255 characters.
`Name`	The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.

/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}

Deletes an issue type screen scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescreenscheme/mapping

Returns a paginated list of issue type screen scheme items.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Issuetypescreenschemeid`	The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project

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

Only company-managed projects associated with an issue type screen scheme are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Query`	Filter projects by name or key. Provide a search string to narrow results.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescreenscheme

Returns a paginated list of issue type screen schemes.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
`Querystring`	String used to perform a case-insensitive partial match with issue type screen scheme name.
`Orderby`	Order the results by a field: name Sorts by issue type screen scheme name. id Sorts by issue type screen scheme ID.
`Expand`	Use expand to include additional information in the response. This parameter accepts projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescreenscheme/project

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

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Projectid`	The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issuetypeids`	The list of issue type IDs.

/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}

Updates an issue type screen scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the issue type screen scheme. The maximum length is 255 characters.
`Name`	The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.

/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issuetypescreenschemeid`	The ID of the issue type screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Screenschemeid`	The ID of the screen scheme.

/rest/api/3/issuetype

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description of the issue type.
`Hierarchylevel`	The hierarchy level of the issue type. Use: -1 for Subtask. 0 for Base. Defaults to 0.
`Name`	The unique name for the issue type. The maximum length is 60 characters.
`Type`	Deprecated. Use hierarchyLevel instead. See the deprecation notice for details. Whether the issue type is subtype or standard. Defaults to standard.

/rest/api/3/issuetype/{id}

Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue type.
`Alternativeissuetypeid`	The ID of the replacement issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype

Returns all issue types.

This operation can be accessed anonymously.

Permissions required: Issue types are only returned as follows:

if the user has the Administer Jira global permission, all issue types are returned.
if the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/{id}/alternatives

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

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/{id}

Returns an issue type.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/project

Returns issue types for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in the relevant project or Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectid`	The ID of the project.
`Level`	The level of the issue type to filter by. Use: -1 for Subtask. 0 for Base. 1 for Epic.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issuetype/{id}/avatar2

Loads an avatar for the issue type.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:

Bash

curl --request POST \ --user email@example.com:<api_token> \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue type.
`X`	The X coordinate of the top-left corner of the crop region.
`Y`	The Y coordinate of the top-left corner of the crop region.
`Size`	The length of each side of the crop region.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the avatar image data and metadata as a multipart form body.

/rest/api/3/issuetype/{id}

Updates the issue type.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Avatarid`	The ID of an issue type avatar.
`Description`	The description of the issue type.
`Name`	The unique name for the issue type. The maximum length is 60 characters.

/rest/api/3/issue/{issueIdOrKey}/votes

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

This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/votes

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

This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/votes

Returns details about the votes on an issue.

This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is ini
If issue-level security is configured, issue-level security permission to view the issue.

Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the voters field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/watchers

Adds a user as a watcher of an issue by passing the account ID of the user. For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the account ID of the user to add as a watcher in the request body.

/rest/api/3/issue/{issueIdOrKey}/watchers

Deletes a user as a watcher of an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
To remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/watching

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

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:

Browse projects project permission for the project that the issue is in
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issueids`	The list of issue IDs.

/rest/api/3/issue/{issueIdOrKey}/watchers

Returns the watchers for an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is ini
If issue-level security is configured, issue-level security permission to view the issue.
To see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}

Deletes a worklog property.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Worklogid`	The ID of the worklog.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}

Returns the value of a worklog property.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Worklogid`	The ID of the worklog.
`Propertykey`	The key of the property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties

Returns the keys of all properties for a worklog.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Worklogid`	The ID of the worklog.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}

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

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Worklogid`	The ID of the worklog.
`Propertykey`	The key of the issue property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the property value as a JSON object or string in the request body.

/rest/api/3/issue/{issueIdOrKey}/worklog

Adds a worklog to an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Work on issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key the issue.
`Notifyusers`	Whether users watching the issue are notified by email.
`Adjustestimate`	Defines how to update the issue's time estimate, the options are: new Sets the estimate to a specific value, defined in newEstimate. leave Leaves the estimate unchanged. manual Reduces the estimate by amount specified in reduceBy. auto Reduces the estimate by the value of timeSpent in the worklog.
`Newestimate`	The value to set as the issue's remaining time estimate, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, 2d. Required when adjustEstimate is new.
`Reduceby`	The amount to reduce the issue's remaining estimate by, as days (\#d), hours (\#h), or minutes (\#m). For example, 2d. Required when adjustEstimate is manual.
`Expand`	Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.
`Overrideeditableflag`	Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Comment`	A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
`Created`	The datetime on which the worklog was created.
`Id`	The ID of the worklog record.
`Issueid`	The ID of the issue this worklog is for.
`Self`	The URL of the worklog item.
`Started`	The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
`Timespent`	The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m or \#). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
`Timespentseconds`	The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
`Updated`	The datetime on which the worklog was last updated.

/rest/api/3/issue/{issueIdOrKey}/worklog/{id}

Deletes a worklog from an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
Delete all worklogs project permission to delete any worklog or Delete own worklogs to delete worklogs created by the user,
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Id`	The ID of the worklog.
`Notifyusers`	Whether users watching the issue are notified by email.
`Adjustestimate`	Defines how to update the issue's time estimate, the options are: new Sets the estimate to a specific value, defined in newEstimate. leave Leaves the estimate unchanged. manual Increases the estimate by amount specified in increaseBy. auto Reduces the estimate by the value of timeSpent in the worklog.
`Newestimate`	The value to set as the issue's remaining time estimate, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, 2d. Required when adjustEstimate is new.
`Increaseby`	The amount to increase the issue's remaining estimate by, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, 2d. Required when adjustEstimate is manual.
`Overrideeditableflag`	Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/worklog/deleted

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

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs deleted during the minute preceding the request.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Since`	The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/worklog/updated

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

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs updated during the minute preceding the request.

Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

the worklog is set as Viewable by All Users.
the user is a member of a project role or group with permission to view the worklog.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Since`	The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned.
`Expand`	Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/worklog

Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required: Workloads are only returned where the user has:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Startedafter`	The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
`Startedbefore`	The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.
`Expand`	Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/worklog/{id}

Returns a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Id`	The ID of the worklog.
`Expand`	Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/worklog/list

Returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

the worklog is set as Viewable by All Users.
the user is a member of a project role or group with permission to view the worklog.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	A list of worklog IDs.

/rest/api/3/issue/{issueIdOrKey}/worklog/{id}

Updates a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key the issue.
`Id`	The ID of the worklog.
`Notifyusers`	Whether users watching the issue are notified by email.
`Adjustestimate`	Defines how to update the issue's time estimate, the options are: new Sets the estimate to a specific value, defined in newEstimate. leave Leaves the estimate unchanged. auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.
`Newestimate`	The value to set as the issue's remaining time estimate, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, 2d. Required when adjustEstimate is new.
`Expand`	Use expand to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties.
`Overrideeditableflag`	Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Comment`	A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
`Created`	The datetime on which the worklog was created.
`Id`	The ID of the worklog record.
`Issueid`	The ID of the issue this worklog is for.
`Self`	The URL of the worklog item.
`Started`	The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
`Timespent`	The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m or \#). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
`Timespentseconds`	The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
`Updated`	The datetime on which the worklog was last updated.

/rest/api/3/issue/archive

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

You can use the get task and cancel task APIs to manage the request.

Note that:

you can't archive subtasks directly, only through their parent issues
you can only archive issues from software, service management, and business projects

Permissions required: Jira admin or site admin: global permission

License required: Premium or Enterprise

Signed-in users only: This API can't be accessed anonymously.

Rate limiting: Only a single request per jira instance can be active at any given time.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Jql`	Provide a JQL query string to select the issues to archive.

/rest/api/3/issue/archive

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

Note that:

you can't archive subtasks directly, only through their parent issues
you can only archive issues from software, service management, and business projects

Permissions required: Jira admin or site admin: global permission

License required: Premium or Enterprise

Signed-in users only: This API can't be accessed anonymously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issueidsorkeys`	Provide an array of issue IDs or keys to archive.

/rest/api/3/issue/{issueIdOrKey}/assignee

Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in.

If name or accountId is set to:

"-1", the issue is assigned to the default assignee for the project.
null, the issue is set to unassigned.

This operation can be accessed anonymously.

Permissions required:

Browse Projects and Assign Issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue to be assigned.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
`Accounttype`	The user account type. Can take the following values: atlassian regular Atlassian user account app system account used for Connect applications and OAuth to represent external systems customer Jira Service Desk account representing an external service desk
`Active`	Whether the user is active.
`Displayname`	The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
`Emailaddress`	The email address of the user. Depending on the user’s privacy setting, this may be returned as null.
`Expand`	Expand options that include additional user details in the response.
`Key`	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Locale`	The locale of the user. Depending on the user’s privacy setting, this may be returned as null.
`Name`	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Self`	The URL of the user.
`Timezone`	The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

/rest/api/3/issue/bulk

Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.

The content of each issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issues' create screens. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.

Creating a subtask differs from creating an issue as follows:

issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).
parent the must contain the ID or key of the parent issue.

Permissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue

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

The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issue's create screen. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.

Creating a subtask differs from creating an issue as follows:

issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).
parent must contain the ID or key of the parent issue.

In a next-gen project any issue may be made a child providing that the parent and child are members of the same project.

Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Updatehistory`	Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}

Deletes an issue.

An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks. This causes the issue's subtasks to be deleted with the issue.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Delete issues project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Deletesubtasks`	Whether the issue's subtasks are deleted when the issue is deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}

Edits an issue. A transition may be applied and issue properties updated as part of the edit.

The edits to the issue's fields are defined using update and fields. The fields that can be edited are determined using Get edit issue metadata.

The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting update.parent.set.none to true. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.

Connect apps having an app user with Administer Jira global permission, and Forge apps acting on behalf of users with Administer Jira global permission, can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Edit issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Notifyusers`	Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
`Overridescreensecurity`	Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg).
`Overrideeditableflag`	Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg).
`Returnissue`	Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the Get issue API.
`Expand`	The Get issue API expand parameter to use in the response if the returnIssue parameter is true.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issues/archive/export

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

Note that this API only exports the values of system fields and archival-specific fields (ArchivedBy and ArchivedDate). Custom fields aren't supported.

Permissions required: Jira admin or site admin: global permission

License required: Premium or Enterprise

Signed-in users only: This API can't be accessed anonymously.

Rate limiting: Only a single request can be active at any given time.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Archivedby`	List archived issues archived by a specified account ID.
`Issuetypes`	List archived issues with a specified issue type ID.
`Projects`	List archived issues with a specified project key.
`Reporters`	List archived issues where the reporter is a specified account ID.

/rest/api/3/issue/{issueIdOrKey}/changelog

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

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/changelog/list

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

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Changelogids`	The list of changelog IDs.

/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}

Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the requests in Create issue and Create issues.

This operation can be accessed anonymously.

Permissions required: Create issues project permission in the requested projects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or key of the project.
`Issuetypeid`	The issuetype ID.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/createmeta

Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.

The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.

This operation can be accessed anonymously.

Permissions required: Create issues project permission in the requested projects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectids`	List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided with projectKeys.
`Projectkeys`	List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided with projectIds.
`Issuetypeids`	List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames.
`Issuetypenames`	List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided with issuetypeIds.
`Expand`	Use expand to include additional information about issue metadata in the response. This parameter accepts projects.issuetypes.fields, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the fields and update fields in Create issue and Create issues.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes

Returns a page of issue type metadata for a specified project. Use the information to populate the requests in Create issue and Create issues.

This operation can be accessed anonymously.

Permissions required: Create issues project permission in the requested projects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or key of the project.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/editmeta

Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue.

This endpoint will check for these conditions:

1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. overrideScreenSecurity=true skips this condition.
2. Field is visible in the field configuration. overrideScreenSecurity=true skips this condition.
3. Field is shown on the issue: each field has different conditions here. For example: Attachment field only shows if attachments are enabled. Assignee only shows if user has permissions to assign the issue.
4. If a field is custom then it must have valid custom field context, applicable for its project and issue type. All system fields are assumed to have context in all projects and all issue types.
5. Issue has a project, issue type, and status defined.
6. Issue is assigned to a valid workflow, and the current status has assigned a workflow step. overrideEditableFlag=true skips this condition.
7. The current workflow step is editable. This is true by default, but can be disabled by setting the jira.issue.editable property to false. overrideEditableFlag=true skips this condition.
8. User has Edit issues permission.
9. Workflow permissions allow editing a field. This is true by default but can be modified using jira.permission.* workflow properties.

Fields hidden using Issue layout settings page remain editable.

Connect apps having an app user with Administer Jira global permission, and Forge apps acting on behalf of users with Administer Jira global permission, can return additional details using:

overrideScreenSecurity When this flag is true, then this endpoint skips checking if fields are available through screens, and field configuration (conditions 1. and 2. from the list above).
overrideEditableFlag When this flag is true, then this endpoint skips checking if workflow is present and if the current step is editable (conditions 6. and 7. from the list above).

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Note: For any fields to be editable the user must have the Edit issues project permission for the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Overridescreensecurity`	Whether hidden fields are returned. Available to Connect app users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg).
`Overrideeditableflag`	Whether non-editable fields are returned. Available to Connect app users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/events

Returns all issue events.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}

Returns the details for an issue.

The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Fields`	A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: all Returns all fields. navigable Returns navigable fields. Any issue field, prefixed with a minus to exclude. Examples: summary,comment Returns only the summary and comments fields. -description Returns all (default) fields except description. *navigable,-comment Returns all navigable fields except comment. This parameter may be specified multiple times. For example, fields=field1,field2& fields=field3. Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields.
`Fieldsbykeys`	Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.
`Expand`	Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: renderedFields Returns field values rendered in HTML format. names Returns the display name of each field. schema Returns the schema describing a field type. transitions Returns all possible transitions for the issue. editmeta Returns information about how each field can be edited. changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.
`Properties`	A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: all Returns all issue properties. Any issue property key, prefixed with a minus to exclude. Examples: all Returns all properties. all,-prop1 Returns all properties except prop1. prop1,prop2 Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3.
`Updatehistory`	Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed field.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/transitions

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

Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.

This operation can be accessed anonymously.

Permissions required: A list or transition is returned only when the user has:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

However, if the user does not have the Transition issues project permission the response will not list any transitions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Expand`	Use expand to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in Transition issue.
`Transitionid`	The ID of the transition.
`Skipremoteonlycondition`	Whether transitions with the condition Hide From User Condition are included in the response.
`Includeunavailabletransitions`	Whether details of transitions that fail a condition are included in the response
`Sortbyopsbarandstatus`	Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/{issueIdOrKey}/notify

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

Permissions required:

Browse Projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	ID or key of the issue that the notification is sent for.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Htmlbody`	The HTML body of the email notification for the issue.
`Subject`	The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.
`Textbody`	The plain text body of the email notification for the issue.

/rest/api/3/issue/{issueIdOrKey}/transitions

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

sortByCategory To update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using Get transitions with the transitions.fields expand.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Transition issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Issueidorkey`	The ID or key of the issue.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/issue/unarchive

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

Note that:

you can't unarchive subtasks directly, only through their parent issues
you can only unarchive issues from software, service management, and business projects

Permissions required: Jira admin or site admin: global permission

License required: Premium or Enterprise

Signed-in users only: This API can't be accessed anonymously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Issueidsorkeys`	Provide an array of issue IDs or keys to unarchive.

/rest/api/3/jql/function/computation

Returns the list of a function's precomputations along with information about when they were created, updated, and last used. Each precomputation has a value \- the JQL fragment to replace the custom function clause with.

Permissions required: This API is only accessible to apps and apps can only inspect their own functions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Functionkey`	The function key in format: Forge: ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest] Connect: [App key]__[Module key]
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Orderby`	Order the results by a field: functionKey Sorts by the functionKey. used Sorts by the used timestamp. created Sorts by the created timestamp. updated Sorts by the updated timestamp.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/jql/function/computation

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

Permissions required: An API for apps to update their own precomputations.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/jql/pdcleaner

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

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Querystrings`	A list of queries with user identifiers. Maximum of 100 queries.

/rest/api/3/jql/autocompletedata/suggestions

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldname`	The name of the field.
`Fieldvalue`	The partial field item name entered by the user.
`Predicatename`	The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
`Predicatevalue`	The partial predicate item name entered by the user.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/jql/autocompletedata

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

To filter visible field details by project or collapse non-unique fields by field type then Get field reference data (POST) can be used.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/jql/autocompletedata

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

This operation can filter the custom fields returned by project. Invalid project IDs in projectIds are ignored. System fields are always returned.

It can also return the collapsed field for custom fields. Collapsed fields enable searches to be performed across all fields with the same name and of the same field type. For example, the collapsed field Component - Component[Dropdown] enables dropdown fields Component - cf[10061] and Component - cf[10062] to be searched simultaneously.

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Includecollapsedfields`	Include collapsed fields for fields that have non-unique names.
`Projectids`	List of project IDs used to filter the visible field details returned.

/rest/api/3/jql/parse

Parses and validates JQL queries.

Validation is performed in context of the current user.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Validation`	How to validate the JQL query and treat the validation results. Validation options include: strict Returns all errors. If validation fails, the query structure is not returned. warn Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned. none No validation is performed. If JQL query is correctly formed, the query structure is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Queries`	A list of queries to parse.

/rest/api/3/jql/sanitize

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

For example, if the query contains the clause project = 'Secret project', and a user does not have browse permission for the project "Secret project", the sanitized query replaces the clause with project = 12345" (where 12345 is the ID of the project). If a user has the required permission, the clause is not sanitized. If the account ID is null, sanitizing is performed for an anonymous user.

Note that sanitization doesn't make the queries GDPR-compliant, because it doesn't remove user identifiers (username or user key). If you need to make queries GDPR-compliant, use Convert user identifiers to account IDs in JQL queries.

Before sanitization each JQL query is parsed. The queries are returned in the same order that they were passed.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/expression/analyse

Analyses and validates Jira expressions.

As an experimental feature, this operation can also attempt to type-check the expressions.

Learn more about Jira expressions in the documentation.

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Check`	The check to perform: syntax Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length. type EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check. complexity EXPERIMENTAL. Determines the formulae for how many expensive operations each expression may execute.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Expressions`	The list of Jira expressions to analyse.

/rest/api/3/expression/eval

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
issues (List of Issues): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.
serviceDesk (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.
customerRequest (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.

Also, custom context variables can be passed in the request with their types. Those variables can be accessed by key in the Jira expression. These variable types are available for use in a custom context:

user: A user specified as an Atlassian account ID.
issue: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression.
json: A JSON object containing custom content.
list: A JSON list of user, issue, or json variable types.

This operation can be accessed anonymously.

Permissions required: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
Permission to access Jira Software is required to access Jira Software context variables (board and sprint) or fields (for example, issue.sprint).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts meta.complexity that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Expression`	The Jira expression to evaluate.

/rest/api/3/application-properties/advanced-settings

Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/application-properties

Returns all application properties or an application property.

If you specify a value for the key parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See Set application property for descriptions of editable properties.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The key of the application property.
`Permissionlevel`	The permission level of all items being returned in the list.
`Keyfilter`	When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf. will return all application properties with keys that start with jira.lf.*.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/configuration

Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/application-properties/{id}

Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

Advanced settings

The advanced settings below are also accessible in Jira.

| Key | Description | Default value |
| -- | -- | -- |
| jira.clone.prefix | The string of text prefixed to the title of a cloned issue. | CLONE - |
| jira.date.picker.java.format | The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting. | d/MMM/yy |
| jira.date.picker.javascript.format | The date format for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting. | %e/%b/%y |
| jira.date.time.picker.java.format | The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting. | dd/MMM/yy h:mm a |
| jira.date.time.picker.javascript.format | The date format for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting. | %e/%b/%y %I:%M %p |
| jira.issue.actions.order | The default order of actions (such as Comments or Change history) displayed on the issue view. | asc |
| jira.view.issue.links.sort.order | The sort order of the list of issue links on the issue view. | type, status, priority |
| jira.comment.collapsing.minimum.hidden | The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing. | 4 |
| jira.newsletter.tip.delay.days | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this feature. | 7 |

Look and feel

The settings listed below adjust the look and feel.

Other settings

| Key | Description | Default value |
| -- | -- | -- |
| jira.issuenav.criteria.autoupdate | Whether instant updates to search criteria is active. | true |

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The key of the application property to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	The ID of the application property.
`Value`	The new value.

/rest/api/3/label

Returns a paginated list of labels.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/license/approximateLicenseCount/product/{applicationKey}

Returns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Applicationkey`	The ID of the application, represents a specific version of Jira.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/license/approximateLicenseCount

Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/instance/license

Returns licensing information about the Jira instance.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/mypreferences/locale

Deprecated, use Update a user profile from the user management REST API instead.

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/mypreferences

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

Note that these keys are deprecated:

jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

Use Update a user profile from the user management REST API to manage timezone and locale instead.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The key of the preference.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/myself

Returns details for the current user.

Permissions required: Permission to access Jira.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Expand

Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include:

groups Returns all groups, including nested groups, the user belongs to.
applicationRoles Returns the application roles the user is assigned to.

Response Type

The response format expected from the API (e.g. application/json).

/rest/api/3/mypreferences/locale

Returns the locale for the user.

If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/mypreferences

Returns the value of a preference of the current user.

Note that these keys are deprecated:

jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance.
jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance.

These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not have any impact on Notification behaviour.

user.notifiy.own.changes Whether the user gets notified of their own changes.
user.notifications.watcher Whether the user gets notified when they are watcher.
user.notifications.assignee Whether the user gets notified when they are assignee.
user.notifications.reporter Whether the user gets notified when they are reporter.
user.notifications.mentions Whether the user gets notified when they are mentions.

Use Update a user profile from the user management REST API to manage timezone and locale instead.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The key of the preference.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/mypreferences/locale

Deprecated, use Update a user profile from the user management REST API instead.

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Locale`	The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en\_US represents a locale of English (United States). Required on create.

/rest/api/3/mypreferences

Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.default.share.private Whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Note that these keys are deprecated:

jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

These system preferences keys will be deprecated by 15/07/2024. You can still use these keys to create arbitrary preferences, but it will not have any impact on Notification behaviour.

user.notifiy.own.changes Whether the user gets notified of their own changes.
user.notifications.watcher Whether the user gets notified when they are watcher.
user.notifications.assignee Whether the user gets notified when they are assignee.
user.notifications.reporter Whether the user gets notified when they are reporter.
user.notifications.mentions Whether the user gets notified when they are mentions.

Use Update a user profile from the user management REST API to manage timezone and locale instead.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The key of the preference. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the preference key and value as a JSON object or string in the request body.

/rest/api/3/permissionscheme/{schemeId}/permission

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme in which to create a new permission grant.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: permissions Returns all permission grants for each permission scheme. user Returns information about the user who is granted the permission. group Returns information about the group that is granted the permission. projectRole Returns information about the project role granted the permission. field Returns information about the custom field granted the permission. all Returns all expandable information.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The ID of the permission granted details.
`Permission`	The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See Built-in permissions (../api-group-permission-schemes/#built-in-permissions) in Get all permission schemes for more information about the built-in permissions. See the project permission (https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and global permission (https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions.
`Self`	The URL of the permission granted details.

/rest/api/3/permissionscheme

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. permissions Returns all permission grants for each permission scheme. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Description`	A description for the permission scheme.
`Expand`	The expand options available for the permission scheme.
`Id`	The ID of the permission scheme.
`Name`	The name of the permission scheme. Must be unique.
`Self`	The URL of the permission scheme.

/rest/api/3/permissionscheme/{schemeId}

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme being deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}

Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme to delete the permission grant from.
`Permissionid`	The ID of the permission grant to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissionscheme

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder object

The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is "type": "group", and the parameter is the group name, "parameter": "Teams in space administrators" and the value is group ID, "value": "ca85fac0-d974-40ca-a615-7af99c48d24f".

The holder object is defined by the following properties:

type Identifies the user or group (see the list of types below).
parameter As a group's name can change, use of value is recommended. The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.
value The value of this property depends on the type. If the type is a group, then you need to specify the group ID. For other type it has the same value as parameter

The following types are available. The expected values for parameter and value are given in parentheses (some types may not have a parameter or value):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name, application name). See Update product access settings for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (parameter : group name, value : group ID).
groupCustomField Grant for a user in the group selected in the specified custom field (parameter : custom field ID, value : custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (parameter :project role ID, value : project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (parameter : user ID - historically this was the userkey but that is deprecated and the account ID should be used, value : user ID).
userCustomField Grant for a user selected in the specified custom field (parameter : custom field ID, value : custom field ID).

Built-in permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Response Type

The response format expected from the API (e.g. application/json).

/rest/api/3/permissionscheme/{schemeId}

Returns a permission scheme.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme to return.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. permissions Returns all permission grants for each permission scheme. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}

Returns a permission grant.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme.
`Permissionid`	The ID of the permission grant.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. permissions Returns all permission grants for each permission scheme. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissionscheme/{schemeId}/permission

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: permissions Returns all permission grants for each permission scheme. user Returns information about the user who is granted the permission. group Returns information about the group that is granted the permission. projectRole Returns information about the project role granted the permission. field Returns information about the custom field granted the permission. all Returns all expandable information.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissionscheme/{schemeId}

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Schemeid`	The ID of the permission scheme to update.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. permissions Returns all permission grants for each permission scheme. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Description`	A description for the permission scheme.
`Expand`	The expand options available for the permission scheme.
`Id`	The ID of the permission scheme.
`Name`	The name of the permission scheme. Must be unique.
`Self`	The URL of the permission scheme.

/rest/api/3/permissions

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissions/check

Returns:

for a list of global permissions, the global permissions granted to a user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate.

If no account ID is provided, the operation returns details for the logged in user.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.
Null values in globalPermissions, projectPermissions, projectPermissions.projects, and projectPermissions.issues are ignored.
Empty strings in projectPermissions.permissions are ignored.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.

Classic: read:jira-work
Granular: read:permission:jira

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission to check the permissions for other users, otherwise none. However, Connect apps can make a call from the app server to the product to obtain permission details for any user, without admin permission. This Connect app ability doesn't apply to calls made using AP.request() in a browser.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Accountid`	The account ID of a user.
`Globalpermissions`	Global permissions to look up.

/rest/api/3/mypermissions

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

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.
for a comment, where the user has both the permission to browse the comment and the project permission for the comment's parent issue. Only the BROWSE\_PROJECTS permission is supported. If a commentId is provided whose permissions does not equal BROWSE\_PROJECTS, a 400 error will be returned.

This means that users may be shown as having an issue permission (such as EDIT\_ISSUES) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT\_ISSUES permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT\_ISSUES permission for that issue.

Global permissions are unaffected by context.

Deprecation notice: The required OAuth 2.0 scopes will be updated on February 15, 2024.

Classic: read:jira-work
Granular: read:permission:jira

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectkey`	The key of project. Ignored if projectId is provided.
`Projectid`	The ID of project.
`Issuekey`	The key of the issue. Ignored if issueId is provided.
`Issueid`	The ID of the issue.
`Permissions`	A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions.
`Projectuuid`	The UUID of the project to filter permissions for.
`Projectconfigurationuuid`	The UUID of the project configuration to filter permissions for.
`Commentid`	The ID of the comment.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/permissions/project

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

Deprecation notice: The required OAuth 2.0 scopes will be updated on February 15, 2024.

Classic: read:jira-work
Granular: read:permission:jira, read:project:jira

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Permissions`	A list of permission keys.

/rest/api/3/project/{projectIdOrKey}/avatar/{id}

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

Permissions required: Administer projects project permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or (case-sensitive) key.
`Id`	The ID of the avatar.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/avatars

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

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or (case-sensitive) key of the project.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/avatar2

Loads an avatar for a project.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:

Bash

curl --request POST 

--user email@example.com:<api_token> 

--header 'X-Atlassian-Token: no-check' 

--header 'Content-Type: image/< image_type>' 

--data-binary "<@/path/to/file/with/your/avatar>" 

--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use Set project avatar to set it as the project's displayed avatar.

Permissions required: Administer projects project permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or (case-sensitive) key of the project.
`X`	The X coordinate of the top-left corner of the crop region.
`Y`	The Y coordinate of the top-left corner of the crop region.
`Size`	The length of each side of the crop region.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the preference key and value as a JSON object or string in the request body.

/rest/api/3/project/{projectIdOrKey}/avatar

Sets the avatar displayed for a project.

Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.

Permissions required: Administer projects project permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or (case-sensitive) key of the project.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Filename`	The file name of the avatar icon. Returned for system avatars.
`Id`	The ID of the avatar.
`Isdeletable`	Whether the avatar can be deleted.
`Isselected`	Whether the avatar is used in Jira. For example, shown as a project's avatar.
`Issystemavatar`	Whether the avatar is a system avatar.
`Owner`	The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.

/rest/api/3/projectCategory

Creates a project category.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description of the project category.
`Id`	The ID of the project category.
`Name`	The name of the project category. Required on create, optional on update.
`Self`	The URL of the project category.

/rest/api/3/projectCategory/{id}

Deletes a project category.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the project category to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/projectCategory

Returns all project categories.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/projectCategory/{id}

Returns a project category.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project category.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/projectCategory/{id}

Updates a project category.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project category to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description of the project category.
`Id`	The ID of the project category.
`Name`	The name of the project category. Required on create, optional on update.
`Self`	The URL of the project category.

/rest/api/3/component

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

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Ari`	Compass component's ID. Can't be updated. Not required for creating a Project Component.
`Assigneetype`	The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in. COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component. UNASSIGNED an assignee is not set for issues created with this component. PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: PROJECT_DEFAULT. Optional when creating or updating a component.
`Description`	The description for the component. Optional when creating or updating a component.
`Id`	The unique identifier for the component.
`Isassigneetypevalid`	Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.
`Leadaccountid`	The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Leadusername`	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Name`	The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
`Project`	The key of the project the component is assigned to. Required when creating a component. Can't be updated.
`Projectid`	The ID of the project the component is assigned to.
`Realassigneetype`	The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values: PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in. COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in. UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues. PROJECT_DEFAULT when none of the preceding cases are true.
`Self`	The URL of the component.

/rest/api/3/component/{id}

Deletes a component.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the component.
`Moveissuesto`	The ID of the component to replace the deleted component. If this value is null no replacement is made.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/component/{id}

Returns a component.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for project containing the component.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the component.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/component/{id}/relatedIssueCounts

Returns the counts of issues assigned to the component.

This operation can be accessed anonymously.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.

Classic: read:jira-work
Granular: read:field:jira, read:project.component:jira

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the component.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/components

Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.

If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Componentsource`	The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/component

Returns a paginated list of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Orderby`	Order the results by a field: description Sorts by the component description. issueCount Sorts by the count of issues associated with the component. lead Sorts by the user key of the component's project lead. name Sorts by component name.
`Componentsource`	The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.
`Query`	Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/component/{id}

Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the component.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Ari`	Compass component's ID. Can't be updated. Not required for creating a Project Component.
`Assigneetype`	The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in. COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component. UNASSIGNED an assignee is not set for issues created with this component. PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: PROJECT_DEFAULT. Optional when creating or updating a component.
`Description`	The description for the component. Optional when creating or updating a component.
`Id`	The unique identifier for the component.
`Isassigneetypevalid`	Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.
`Leadaccountid`	The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Leadusername`	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Name`	The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
`Project`	The key of the project the component is assigned to. Required when creating a component. Can't be updated.
`Projectid`	The ID of the project the component is assigned to.
`Realassigneetype`	The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values: PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in. COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in. UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues. PROJECT_DEFAULT when none of the preceding cases are true.
`Self`	The URL of the component.

/rest/api/3/project/{projectId}/email

Returns the project's sender email address.

Permissions required: Browse projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectid`	The project ID.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectId}/email

Sets the project's sender email address.

If emailAddress is an empty string, the default email address is restored.

Permissions required: Administer Jira global permission or Administer Projects project permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectid`	The project ID.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Emailaddress`	The email address.
`Emailaddressstatus`	When using a custom domain, the status of the email address.

/rest/api/3/project/{projectIdOrKey}/features

Returns the list of features for a project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or (case-sensitive) key of the project.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/features/{featureKey}

Sets the state of a project feature.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The ID or (case-sensitive) key of the project.
`Featurekey`	The key of the feature.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`State`	The feature state.

/rest/api/3/projectvalidate/validProjectKey

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

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The project key.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/projectvalidate/validProjectName

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

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	The project name.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/projectvalidate/key

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

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The project key.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectKeyOrId}/permissionscheme

Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

Permissions required: Administer Jira global permission

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectkeyorid`	The project ID or project key (case sensitive).
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. permissions Returns all permission grants for each permission scheme. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Id`	The ID of the permission scheme to associate with the project. Use the Get all permission schemes resource to get a list of permission scheme IDs.

/rest/api/3/project/{projectKeyOrId}/permissionscheme

Gets the permission scheme associated with the project.

Permissions required: Administer Jira global permission or Administer projects project permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectkeyorid`	The project ID or project key (case sensitive).
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: all Returns all expandable information. field Returns information about the custom field granted the permission. group Returns information about the group that is granted the permission. permissions Returns all permission grants for each permission scheme. projectRole Returns information about the project role granted the permission. user Returns information about the user who is granted the permission.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectKeyOrId}/securitylevel

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

This operation can be accessed anonymously.

Permissions required: Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectkeyorid`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme

Returns the issue security scheme associated with the project.

Permissions required: Administer Jira global permission or the Administer Projects project permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectkeyorid`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}

Deletes the property from a project.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Propertykey`	The project property key. Use Get project property keys to get a list of all project property keys.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}

Returns the value of a project property.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project containing the property.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Propertykey`	The project property key. Use Get project property keys to get a list of all project property keys.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/properties

Returns all project property keys for the project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}

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

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Propertykey`	The key of the project property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the preference key and value as a JSON object or string in the request body.

/rest/api/3/project/{projectIdOrKey}/role/{id}

Adds actors to a project role for the project.

To replace all actors for the project, use Set actors for project role.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Group`	The name of the group to add. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended.
`Groupid`	The ID of the group to add. This parameter cannot be used with the group parameter.
`User`	The user account ID of the user to add.

/rest/api/3/role/{id}/actors

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

Changing a project role's default actors does not affect project role members for projects already created.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Group`	The name of the group to add as a default actor. This parameter cannot be used with the groupId parameter. As a group's name can change,use of groupId is recommended. This parameter accepts a comma-separated list. For example, "group":["project-admin", "jira-developers"].
`Groupid`	The ID of the group to add as a default actor. This parameter cannot be used with the group parameter This parameter accepts a comma-separated list. For example, "groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8", "0c011f85-69ed-49c4-a801-3b18d0f771bc"].
`User`	The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example, "user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"].

/rest/api/3/project/{projectIdOrKey}/role/{id}

Deletes actors from a project role for the project.

To remove default actors from the project role, use Delete default actors from project role.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`User`	The user account ID of the user to remove from the project role.
`Group`	The name of the group to remove from the project role. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended.
`Groupid`	The ID of the group to remove from the project role. This parameter cannot be used with the group parameter.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/role/{id}/actors

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

Changing a project role's default actors does not affect project role members for projects already created.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`User`	The user account ID of the user to remove as a default actor.
`Groupid`	The group ID of the group to be removed as a default actor. This parameter cannot be used with the group parameter.
`Group`	The group name of the group to be removed as a default actor.This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/role/{id}/actors

Returns the default actors for the project role.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/role/{id}

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

To add actors to the project without overwriting the existing list, use Add actors to project role.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.

/rest/api/3/role

Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.

Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.<

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
`Name`	The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

/rest/api/3/role/{id}

Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.
`Swap`	The ID of the project role that will replace the one being deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/role/{id}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
`Name`	The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

/rest/api/3/role

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

About project roles

Project roles are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).

Project roles are used in permission schemes, email notification schemes, issue security levels, comment visibility, and workflow conditions.

Members and actors

In the Jira REST API, a member of a project role is called an actor. An actor is a group or user associated with a project role.

Actors may be set as default members of the project role or set at the project level:

Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.
Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/role/{id}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/roledetails

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

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Currentmember`	Whether the roles should be filtered to include only those the user is assigned to.
`Excludeconnectaddons`	If set to true, exclude roles from Connect add-ons.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/role/{id}

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

To check whether a user belongs to a role based on their group memberships, use Get user with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Excludeinactiveusers`	Exclude inactive users.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/role

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

Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles for more information.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for any project on the site or Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/role/{id}

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

You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
`Name`	The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

/rest/api/3/project/type/{projectTypeKey}/accessible

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

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projecttypekey`	The key of the project type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/type

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

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/type/accessible

Returns all project types with a valid license.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/type/{projectTypeKey}

Returns a project type.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projecttypekey`	The key of the project type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}/relatedwork

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

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the dashboard to copy. Provide the dashboard numeric ID.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Category`	The category of the related work
`Issueid`	The title of the related work
`Relatedworkid`	The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.
`Title`	The title of the related work
`Url`	The URL of the related work

/rest/api/3/version

Creates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (16)

Option Name	Description
`Archived`	Indicates that the version is archived. Optional when creating or updating a version.
`Description`	The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
`Driver`	If the expand option driver is used, returns the Atlassian account ID of the driver.
`Expand`	Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: operations Returns the list of operations available for this version. issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done. driver Returns the Atlassian account ID of the version driver. approvers Returns a list containing approvers for this version. Optional for create and update.
`Id`	The ID of the version.
`Moveunfixedissuesto`	The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.
`Name`	The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
`Overdue`	Indicates that the version is overdue.
`Project`	Deprecated. Use projectId.
`Projectid`	The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
`Releasedate`	The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
`Released`	Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.
`Self`	The URL of the version.
`Startdate`	The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
`Userreleasedate`	The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.
`Userstartdate`	The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

/rest/api/3/version/{id}/removeAndSwap

Deletes a project version.

Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Moveaffectedissuesto`	The ID of the version to update affectedVersion to when the field contains the deleted version.
`Movefixissuesto`	The ID of the version to update fixVersion to when the field contains the deleted version.

/rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}

Deletes the given related work for the given version.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Versionid`	The ID of the version that the target related work belongs to.
`Relatedworkid`	The ID of the related work to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}

Deletes a project version.

Deprecated, use Delete and replace version that supports swapping version values in custom fields, in addition to the swapping for fixVersion and affectedVersion provided in this resource.

Alternative versions can be provided to update issues that use the deleted version in fixVersion or affectedVersion. If alternatives are not provided, occurrences of fixVersion and affectedVersion that contain the deleted version are cleared.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Movefixissuesto`	The ID of the version to update fixVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
`Moveaffectedissuesto`	The ID of the version to update affectedVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/versions

Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Expand`	Use expand to include additional information in the response. This parameter accepts operations, which returns actions that can be performed on the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/version

Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Orderby`	Order the results by a field: description Sorts by version description. name Sorts by version name. releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. sequence Sorts by the order of appearance in the user interface. startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.
`Query`	Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).
`Status`	A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: issuesstatus Returns the number of issues in each status category for each version. operations Returns actions that can be performed on the specified version. driver Returns the Atlassian account ID of the version driver. approvers Returns a list containing the approvers for this version.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}/relatedwork

Returns related work items for the given version id.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}

Returns a project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Expand`	Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: operations Returns the list of operations available for this version. issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done. driver Returns the Atlassian account ID of the version driver. approvers Returns a list containing the Atlassian account IDs of approvers for this version.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}/relatedIssueCounts

Returns the following counts for a version:

Number of issues where the fixVersion is set to the version.
Number of issues where the affectedVersion is set to the version.
Number of issues where a version custom field is set to the version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}/unresolvedIssueCount

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

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}/mergeto/{moveIssuesTo}

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

Consider using Delete and replace version instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version to delete.
`Moveissuesto`	The ID of the version to merge into.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/version/{id}/move

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

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version to be moved.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`After`	The URL (self link) of the version after which to place the moved version. Cannot be used with position.
`Position`	An absolute position in which to place the moved version. Cannot be used with after.

/rest/api/3/version/{id}/relatedwork

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

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version to update the related work on. For the related work id, pass it to the input JSON.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Category`	The category of the related work
`Issueid`	The title of the related work
`Relatedworkid`	The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.
`Title`	The title of the related work
`Url`	The URL of the related work

/rest/api/3/version/{id}

Updates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (16)

Option Name	Description
`Archived`	Indicates that the version is archived. Optional when creating or updating a version.
`Description`	The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
`Driver`	If the expand option driver is used, returns the Atlassian account ID of the driver.
`Expand`	Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: operations Returns the list of operations available for this version. issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done. driver Returns the Atlassian account ID of the version driver. approvers Returns a list containing approvers for this version. Optional for create and update.
`Id`	The ID of the version.
`Moveunfixedissuesto`	The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.
`Name`	The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
`Overdue`	Indicates that the version is overdue.
`Project`	Deprecated. Use projectId.
`Projectid`	The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
`Releasedate`	The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
`Released`	Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.
`Self`	The URL of the version.
`Startdate`	The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
`Userreleasedate`	The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.
`Userstartdate`	The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

/rest/api/3/project/{projectIdOrKey}/archive

Archives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project

Creates a project based on a project type template, as shown in the following table:

| Project Type Key | Project Template Key |
|--|--|
| business | com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking |
| service_desk | com.atlassian.servicedesk:simplified-it-service-management, com.atlassian.servicedesk:simplified-general-service-desk-it, com.atlassian.servicedesk:simplified-general-service-desk-business, com.atlassian.servicedesk:simplified-external-service-desk, com.atlassian.servicedesk:simplified-hr-service-desk, com.atlassian.servicedesk:simplified-facilities-service-desk, com.atlassian.servicedesk:simplified-legal-service-desk, com.atlassian.servicedesk:simplified-analytics-service-desk, com.atlassian.servicedesk:simplified-marketing-service-desk, com.atlassian.servicedesk:simplified-design-service-desk, com.atlassian.servicedesk:simplified-sales-service-desk, com.atlassian.servicedesk:simplified-blank-project-business, com.atlassian.servicedesk:simplified-blank-project-it, com.atlassian.servicedesk:simplified-finance-service-desk, com.atlassian.servicedesk:next-gen-it-service-desk, com.atlassian.servicedesk:next-gen-hr-service-desk, com.atlassian.servicedesk:next-gen-legal-service-desk, com.atlassian.servicedesk:next-gen-marketing-service-desk, com.atlassian.servicedesk:next-gen-facilities-service-desk, com.atlassian.servicedesk:next-gen-general-it-service-desk, com.atlassian.servicedesk:next-gen-general-business-service-desk, com.atlassian.servicedesk:next-gen-analytics-service-desk, com.atlassian.servicedesk:next-gen-finance-service-desk, com.atlassian.servicedesk:next-gen-design-service-desk, com.atlassian.servicedesk:next-gen-sales-service-desk |
| software | com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic |
The project types are available according to the installed Jira features as follows:

Jira Core, the default, enables business projects.
Jira Service Management enables service_desk projects.
Jira Software enables software projects.

To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (18)

Option Name	Description
`Assigneetype`	The default assignee when creating issues for this project.
`Avatarid`	An integer value for the project's avatar.
`Categoryid`	The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
`Description`	A brief description of the project.
`Fieldconfigurationscheme`	The ID of the field configuration scheme for the project. Use the Get all field configuration schemes operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.
`Issuesecurityscheme`	The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.
`Issuetypescheme`	The ID of the issue type scheme for the project. Use the Get all issue type schemes operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key.
`Issuetypescreenscheme`	The ID of the issue type screen scheme for the project. Use the Get all issue type screen schemes operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key.
`Key`	Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.
`Lead`	This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with leadAccountId.
`Leadaccountid`	The account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead.
`Name`	The name of the project.
`Notificationscheme`	The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
`Permissionscheme`	The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.
`Projecttemplatekey`	A predefined configuration for a project. The type of the projectTemplateKey must match with the type of the projectTypeKey.
`Projecttypekey`	The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.
`Url`	A link to information about this project, such as project documentation
`Workflowscheme`	The ID of the workflow scheme for the project. Use the Get all workflow schemes operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key.

/rest/api/3/project/{projectIdOrKey}

Deletes a project.

You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Enableundo`	Whether this project is placed in the Jira recycle bin where it will be available for restoration.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/delete

Deletes a project asynchronously.

This operation is:

transactional, that is, if part of the delete fails the project is not deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project

Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: description Returns the project description. issueTypes Returns all issue types associated with the project. lead Returns information about the project lead. projectKeys Returns all project keys associated with the project.
`Recent`	Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session.
`Properties`	A list of project properties to return for the project. This parameter accepts a comma-separated list.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/statuses

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

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}

Returns the project details for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: description The project description. issueTypes The issue types associated with the project. lead The project lead. projectKeys All project keys associated with the project. issueTypeHierarchy The project issue type hierarchy.
`Properties`	A list of project properties to return for the project. This parameter accepts a comma-separated list.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectId}/hierarchy

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

The issue type hierarchy for a project consists of:

Epic at level 1 (optional).
One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic.
Subtask at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue.

Permissions required: Browse projects project permission for the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectid`	The ID of the project.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectKeyOrId}/notificationscheme

Gets a notification scheme associated with the project.

Permissions required: Administer Jira global permission or Administer Projects project permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectkeyorid`	The project ID or project key (case sensitive).
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: all Returns all expandable information field Returns information about any custom fields assigned to receive an event group Returns information about any groups assigned to receive an event notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information projectRole Returns information about any project roles assigned to receive an event user Returns information about any users assigned to receive an event
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/search

Returns a paginated list of projects visible to the user.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has one of:

Browse Projects project permission for the project.
Administer Projects project permission for the project.
Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Orderby`	Order the results by a field. category Sorts by project category. A complete list of category IDs is found using Get all project categories. issueCount Sorts by the total number of issues in each project. key Sorts by project key. lastIssueUpdatedTime Sorts by the last issue update time. name Sorts by project name. owner Sorts by project lead. archivedDate EXPERIMENTAL. Sorts by project archived date. deletedDate EXPERIMENTAL. Sorts by project deleted date.
`Id`	The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Up to 50 project IDs can be provided.
`Keys`	The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&keys=PB. Up to 50 project keys can be provided.
`Query`	Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).
`Typekey`	Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.
`Categoryid`	The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
`Action`	Filter results by projects for which the user can: view the project, meaning that they have one of the following permissions: Browse projects project permission (https://confluence.atlassian.com/x/yodKLg) for the project. Administer projects project permission (https://confluence.atlassian.com/x/yodKLg) for the project. Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg). browse the project, meaning that they have the Browse projects project permission (https://confluence.atlassian.com/x/yodKLg) for the project. edit the project, meaning that they have one of the following permissions: Administer projects project permission (https://confluence.atlassian.com/x/yodKLg) for the project. Administer Jira global permission (https://confluence.atlassian.com/x/x4dKLg). create the project, meaning that they have the Create issues* project permission (https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: description Returns the project description. projectKeys Returns all project keys associated with a project. lead Returns information about the project lead. issueTypes Returns all issue types associated with the project. url Returns the URL associated with the project. insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
`Status`	EXPERIMENTAL. Filter results by project status: live Search live projects. archived Search archived projects. deleted Search deleted projects, those in the recycle bin.
`Properties`	EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.
`Propertyquery`	EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/recent

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

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has one of:

Browse Projects project permission for the project.
Administer Projects project permission for the project.
Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: description Returns the project description. projectKeys Returns all project keys associated with a project. lead Returns information about the project lead. issueTypes Returns all issue types associated with the project. url Returns the URL associated with the project. permissions Returns the permissions associated with the project. insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. Returns the project with all available expand options.
`Properties`	EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}/restore

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

Permissions required:

Administer Jira global permissionfor Company managed projects.
Administer Jira global permission or Administer projects project permission for the project for Team managed projects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/project/{projectIdOrKey}

Updates the project details of a project.

All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged.

Permissions required: Administer Jira global permission. is only needed when changing the schemes or project key. Otherwise you will only need Administer Projects project permission

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectidorkey`	The project ID or project key (case sensitive).
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: description The project description. issueTypes The issue types associated with the project. lead The project lead. projectKeys All project keys associated with the project.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Assigneetype`	The default assignee when creating issues for this project.
`Avatarid`	An integer value for the project's avatar.
`Categoryid`	The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. To remove the project category from the project, set the value to -1.
`Description`	A brief description of the project.
`Issuesecurityscheme`	The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.
`Key`	Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.
`Lead`	This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Cannot be provided with leadAccountId.
`Leadaccountid`	The account ID of the project lead. Cannot be provided with lead.
`Name`	The name of the project.
`Notificationscheme`	The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
`Permissionscheme`	The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.
`Url`	A link to information about this project, such as project documentation

/rest/api/3/screenscheme

Creates a screen scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the screen scheme. The maximum length is 255 characters.
`Name`	The name of the screen scheme. The name must be unique. The maximum length is 255 characters.

/rest/api/3/screenscheme/{screenSchemeId}

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

Only screens schemes used in classic projects can be deleted.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenschemeid`	The ID of the screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screenscheme

Returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
`Expand`	Use expand include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to.
`Querystring`	String used to perform a case-insensitive partial match with screen scheme name.
`Orderby`	Order the results by a field: id Sorts by screen scheme ID. name Sorts by screen scheme name.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screenscheme/{screenSchemeId}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenschemeid`	The ID of the screen scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the screen scheme. The maximum length is 255 characters.
`Name`	The name of the screen scheme. The name must be unique. The maximum length is 255 characters.

/rest/api/3/screens/{screenId}/tabs/{tabId}/fields

Adds a field to a screen tab.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Fieldid`	The ID of the field to add.

/rest/api/3/screens/{screenId}/tabs/{tabId}/fields

Returns all fields for a screen tab.

Permissions required:

Administer Jira global permission.
Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Projectkey`	The key of the project.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move

Moves a screen tab field.

If after and position are provided in the request, position is ignored.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Id`	The ID of the field.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`After`	The ID of the screen tab field after which to place the moved screen tab field. Required if position isn't provided.
`Position`	The named position to which the screen tab field should be moved. Required if after isn't provided.

/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}

Removes a field from a screen tab.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Id`	The ID of the field.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}/tabs

Creates a tab for a screen.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	The ID of the screen tab.
`Name`	The name of the screen tab. The maximum length is 255 characters.

/rest/api/3/screens/{screenId}/tabs/{tabId}

Deletes a screen tab.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}/tabs

Returns the list of tabs for a screen.

Permissions required:

Administer Jira global permission.
Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Projectkey`	The key of the project.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/tabs

Returns the list of tabs for a bulk of screens.

Permissions required:

Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example, screenId=10000&screenId=10001.
`Tabid`	The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example, tabId=10000&tabId=10001.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresult`	The maximum number of items to return per page. The maximum number is 100,
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}

Moves a screen tab.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Pos`	The position of tab. The base index is 0.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}/tabs/{tabId}

Updates the name of a screen tab.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Tabid`	The ID of the screen tab.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	The ID of the screen tab.
`Name`	The name of the screen tab. The maximum length is 255 characters.

/rest/api/3/screens/addToDefault/{fieldId}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the field.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens

Creates a screen with a default field tab.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the screen. The maximum length is 255 characters.
`Name`	The name of the screen. The name must be unique. The maximum length is 255 characters.

/rest/api/3/screens/{screenId}

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

Only screens used in classic projects can be deleted.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}/availableFields

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Id`	The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
`Querystring`	String used to perform a case-insensitive partial match with screen name.
`Scope`	The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT.
`Orderby`	Order the results by a field: id Sorts by screen ID. name Sorts by screen name.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/field/{fieldId}/screens

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldid`	The ID of the field to return screens for.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Expand`	Use expand to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/screens/{screenId}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Screenid`	The ID of the screen.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the screen. The maximum length is 255 characters.
`Name`	The name of the screen. The name must be unique. The maximum length is 255 characters.

/rest/api/3/serverInfo

Returns information about the Jira instance.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/atlassian-connect/1/service-registry

Retrieve the attributes of given service registries.

Permissions required: Only Connect apps can make this request and the servicesIds belong to the tenant you are requesting

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Serviceids`	The ID of the services (the strings starting with "b:" need to be decoded in Base64).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/statuses

Creates statuses for a global or project scope.

Permissions required:

Administer projects project permission.
Administer Jira project permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/statuses

Deletes statuses by ID.

Permissions required:

Administer projects project permission.
Administer Jira project permission.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Id

The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

Min items 1, Max items 50

Response Type

The response format expected from the API (e.g. application/json).

/rest/api/3/statuses

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

Permissions required:

Administer projects project permission.
Administer Jira project permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: usages Returns the project and issue types that use the status in their workflow. workflowUsages Returns the workflows that use the status.
`Id`	The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items 1, Max items 50
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/statuses

Updates statuses by ID.

Permissions required:

Administer projects project permission.
Administer Jira project permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/statuses/search

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

Permissions required:

Administer projects project permission.
Administer Jira project permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: usages Returns the project and issue types that use the status in their workflow. workflowUsages Returns the workflows that use the status.
`Projectid`	The project the status is part of or null for global statuses.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Searchstring`	Term to match status names against or null to search for all statuses in the search scope.
`Statuscategory`	Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/task/{taskId}/cancel

Cancels a task.

Permissions required: either of:

Administer Jira global permission.
Creator of the task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Taskid`	The ID of the task.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/task/{taskId}

Returns the status of a long-running asynchronous task.

When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.

read:jira-work

Permissions required: either of:

Administer Jira global permission.
Creator of the task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Taskid`	The ID of the task.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/configuration/timetracking/list

Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/configuration/timetracking

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/configuration/timetracking/options

Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/configuration/timetracking

Selects a time tracking provider.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Key`	The key for the time tracking provider. For example, JIRA.
`Name`	The name of the time tracking provider. For example, JIRA provided time tracking.
`Url`	The URL of the configuration page for the time tracking provider app. For example, /example/config/url. This property is only returned if the adminPageKey property is set in the module descriptor of the time tracking provider app.

/rest/api/3/configuration/timetracking/options

Sets the time tracking settings.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Defaultunit`	The default unit of time applied to logged time.
`Timeformat`	The format that will appear on an issue's Time Spent field.
`Workingdaysperweek`	The number of days in a working week.
`Workinghoursperday`	The number of hours in a working day.

/rest/api/3/uiModifications

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

Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.

Permissions required:

None if the UI modification is created without contexts.
Browse projects project permission for one or more projects, if the UI modification is created with contexts.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Data`	The data of the UI modification. The maximum size of the data is 50000 characters.
`Description`	The description of the UI modification. The maximum length is 255 characters.
`Name`	The name of the UI modification. The maximum length is 255 characters.

/rest/api/3/uiModifications/{uiModificationId}

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

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Uimodificationid`	The ID of the UI modification.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/uiModifications

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

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: data Returns UI modification data. contexts Returns UI modification contexts.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/uiModifications/{uiModificationId}

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

Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.

Permissions required:

None if the UI modification is created without contexts.
Browse projects project permission for one or more projects, if the UI modification is created with contexts.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Uimodificationid`	The ID of the UI modification.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Data`	The data of the UI modification. The maximum size of the data is 50000 characters.
`Description`	The description of the UI modification. The maximum length is 255 characters.
`Name`	The name of the UI modification. The maximum length is 255 characters.

/rest/api/3/user/properties/{propertyKey}

Deletes a property from a user.

Note: This operation does not access the user properties created and maintained in Jira.

Permissions required:

Administer Jira global permission, to delete a property from any user.
Access to Jira, to delete a property from the calling user's record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Userkey`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Username`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Propertykey`	The key of the user's property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/properties/{propertyKey}

Returns the value of a user's property. If no property key is provided Get user property keys is called.

Note: This operation does not access the user properties created and maintained in Jira.

Permissions required:

Administer Jira global permission, to get a property from any user.
Access to Jira, to get a property from the calling user's record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Userkey`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Username`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Propertykey`	The key of the user's property.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/properties

Returns the keys of all properties for a user.

Note: This operation does not access the user properties created and maintained in Jira.

Permissions required:

Administer Jira global permission, to access the property keys on any user.
Access to Jira, to access the calling user's property keys.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Userkey`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Username`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/properties/{propertyKey}

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

Note: This operation does not access the user properties created and maintained in Jira.

Permissions required:

Administer Jira global permission, to set a property on any user.
Access to Jira, to set a property on the calling user's record.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Userkey`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Username`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Propertykey`	The key of the user's property. The maximum length is 255 characters.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Provide the preference key and value as a JSON object or string in the request body.

/rest/api/3/user/search/query/key

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

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.

Permissions required: Browse users and groups global permission.

The query statements are:

is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
[propertyKey].entity.property.path is "property value" Returns users with the entity property value.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	The search query.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresult`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/search

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

This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users and filter the records in your code.

This operation can be accessed anonymously.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property is specified.
`Username`	A string to search for in usernames.
`Accountid`	A query string that is matched exactly against a user accountId. Required, unless query or property is specified.
`Startat`	The index of the first item to return in a page of filtered results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Property`	A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/assignable/search

Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:

a new issue, by providing the projectKeyOrId.
an updated issue, by providing the issueKey.
to an issue during a transition (workflow action), by providing the issueKey and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of Get issue.

In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned the issue, use Get all users and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission or Assign issues project permission

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless username or accountId is specified.
`Sessionid`	The sessionId of this request. SessionId is the same until the assignee is set.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Accountid`	A query string that is matched exactly against user accountId. Required, unless query is specified.
`Project`	The project ID or project key (case sensitive). Required, unless issueKey is specified.
`Issuekey`	The key of the issue. Required, unless project is specified.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.
`Actiondescriptorid`	The ID of the transition.
`Recommend`	If set to true, return recommended users based on past assignments.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/assignable/multiProjectSearch

Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, use Get all users and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Accountid`	A query string that is matched exactly against user accountId. Required, unless query is specified.
`Projectkeys`	A list of project keys (case sensitive). This parameter accepts a comma-separated list.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/search/query

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

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.

Permissions required: Browse users and groups global permission.

The query statements are:

is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
[propertyKey].entity.property.path is "property value" Returns users with the entity property value.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	The search query.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/picker

Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.

This operation takes the users in the range defined by maxResults, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the query term, use Get all users and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com.
`Maxresults`	The maximum number of items to return. The total number of matched users is returned in total.
`Showavatar`	Include the URI to the user's avatar.
`Exclude`	This parameter is no longer available. See the deprecation notice for details.
`Excludeaccountids`	A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.
`Avatarsize`	The size of the user avatar to return, e.g., "xsmall" or "48x48".
`Excludeconnectusers`	If set to true, exclude users from Connect add-ons.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/viewissue/search

Returns a list of users who fulfill these criteria:

their user attributes match a search string.
they have permission to browse issues.

Use this resource to find users who can browse:

an issue, by providing the issueKey.
any issue in a project, by providing the projectKey.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission to browse issues, use Get all users and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Accountid`	A query string that is matched exactly against user accountId. Required, unless query is specified.
`Issuekey`	The issue key for the issue. Required, unless projectKey is specified.
`Projectkey`	The project key for the project (case sensitive). Required, unless issueKey is specified.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/permission/search

Returns a list of users who fulfill these criteria:

their user attributes match a search string.
they have a set of permissions for a project or issue.

If no search string is provided, a list of all users with the permissions is returned.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission for the project or issue, use Get all users and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

This operation can be accessed anonymously.

Permissions required:

Administer Jira global permission, to get users for any project.
Administer Projects project permission for a project, to get users for that project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Accountid`	A query string that is matched exactly against user accountId. Required, unless query is specified.
`Permissions`	A comma separated list of permissions. Permissions can be specified as any: permission returned by Get all permissions. custom project permission added by Connect apps. (deprecated) one of the following: ASSIGNABLE\_USER ASSIGN\_ISSUE ATTACHMENT\_DELETE\_ALL ATTACHMENT\_DELETE\_OWN BROWSE CLOSE\_ISSUE COMMENT\_DELETE\_ALL COMMENT\_DELETE\_OWN COMMENT\_EDIT\_ALL COMMENT\_EDIT\_OWN COMMENT\_ISSUE CREATE\_ATTACHMENT CREATE\_ISSUE DELETE\_ISSUE EDIT\_ISSUE LINK\_ISSUE MANAGE\_WATCHER\_LIST MODIFY\_REPORTER MOVE\_ISSUE PROJECT\_ADMIN RESOLVE\_ISSUE SCHEDULE\_ISSUE SET\_ISSUE\_SECURITY TRANSITION\_ISSUE VIEW\_VERSION\_CONTROL VIEW\_VOTERS\_AND\_WATCHERS VIEW\_WORKFLOW\_READONLY WORKLOG\_DELETE\_ALL WORKLOG\_DELETE\_OWN WORKLOG\_EDIT\_ALL WORKLOG\_EDIT\_OWN WORK\_ISSUE
`Issuekey`	The issue key for the issue.
`Projectkey`	The project key for the project (case sensitive).
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/bulk

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

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Username`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Key`	This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`Accountid`	The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user

Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.

If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Applicationkeys`	Deprecated, do not use.
`Displayname`	This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.
`Emailaddress`	The email address for the user.
`Key`	This property is no longer available. See the migration guide for details.
`Name`	This property is no longer available. See the migration guide for details.
`Password`	This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.
`Products`	Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. If left empty, the user will get default product access. To create a user without product access, set this field to be an empty array.
`Self`	The URL of the user.

/rest/api/3/user

Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.

Permissions required: Site administration (that is, membership of the site-admin group).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Key`	This parameter is no longer available. See the deprecation notice for details.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/bulk/migration

Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Username`	Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, username=fred&username=barney. Required if key isn't provided. Cannot be provided if key is present.
`Key`	Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, key=fred&key=barney. Required if username isn't provided. Cannot be provided if username is present.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/users/search

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

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return.
`Maxresults`	The maximum number of items to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/users

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

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return.
`Maxresults`	The maximum number of items to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user

Returns a user.

Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Key`	This parameter is no longer available. See the deprecation notice for details.
`Expand`	Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: groups includes all groups and nested groups to which the user belongs. applicationRoles includes details of all the applications to which the user has access.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/columns

Returns the default issue table columns for the user. If accountId is not passed in the request, the calling user's details are returned.

Permissions required:

Administer Jira global permission, to get the column details for any user.
Permission to access Jira, to get the calling user's column details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Username`	This parameter is no longer available See the deprecation notice for details.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/email

Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/email/bulk

Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/groups

Returns the groups to which a user belongs.

Permissions required: Browse users and groups global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Key`	This parameter is no longer available. See the deprecation notice for details.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/columns

Resets the default issue table columns for the user to the system default. If accountId is not passed, the calling user's default columns are reset.

Permissions required:

Administer Jira global permission, to set the columns on any user.
Permission to access Jira, to set the calling user's columns.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Username`	This parameter is no longer available. See the deprecation notice for details.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/user/columns

Sets the default issue table columns for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.

The parameters for this resource are expressed as HTML form data. For example, in curl:

Bash

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'

Permissions required:

Administer Jira global permission, to set the columns on any user.
Permission to access Jira, to set the calling user's columns.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accountid`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Columns`	Provide an array of column names (field IDs) to set as the default navigator columns.

/rest/api/3/webhook

Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Webhookids`	A list of webhook IDs.

/rest/api/3/webhook/refresh

Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive.

Unrecognized webhook IDs (those that are not found or belong to other apps) are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Webhookids`	A list of webhook IDs.

/rest/api/3/webhook

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

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/webhook/failed

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

After 72 hours the failure may no longer be returned by this operation.

The oldest failure is returned first.

This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next.

Permissions required: Only Connect apps can use this operation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Maxresults`	The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page.
`After`	The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/webhook

Registers webhooks.

NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Url`	The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered.

/rest/api/3/workflowscheme/{id}/createdraft

Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the active workflow scheme that the draft is created from.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/default

Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft

Deletes a draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the active workflow scheme that the draft was created from.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/workflow

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Workflowname`	The name of the workflow.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Issuetype`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/default

Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft

Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
Note that:

Only active workflow schemes can have draft workflow schemes.
An active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the active workflow scheme that the draft was created from.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/workflow

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Workflowname`	The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Issuetype`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/publish

Publishes a draft workflow scheme.

Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain updates.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Validateonly`	Whether the request only performs a validation.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/draft/workflow

Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Workflowname`	The name of the workflow.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Defaultmapping`	Whether the workflow is the default workflow for the workflow scheme.
`Issuetypes`	The list of issue type IDs.
`Updatedraftifneeded`	Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false.
`Workflow`	The name of the workflow. Optional if updating the workflow-issue types mapping.

/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Issuetype`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Issuetype`	The ID of the issue type. Not required if updating the issue type-workflow mapping.
`Updatedraftifneeded`	Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. Only applicable when updating the workflow-issue types mapping.
`Workflow`	The name of the workflow.

/rest/api/3/workflowscheme/{id}/draft/default

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme that the draft belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Updatedraftifneeded`	Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false.
`Workflow`	The name of the workflow to set as the default workflow.

/rest/api/3/workflowscheme/{id}/draft

Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the active workflow scheme that the draft was created from.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Defaultworkflow`	The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).
`Description`	The description of the workflow scheme.
`Draft`	Whether the workflow scheme is a draft or not.
`Id`	The ID of the workflow scheme.
`Lastmodified`	The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.
`Name`	The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
`Originaldefaultworkflow`	For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.
`Self`	The self URL of the draft workflow scheme (used for internal linking).
`Updatedraftifneeded`	Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated. Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false.

/rest/api/3/workflowscheme/project

Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.

Workflow schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Projectid`	The ID of the project.
`Workflowschemeid`	The ID of the workflow scheme. If the workflow scheme ID is null, the operation assigns the default workflow scheme.

/rest/api/3/workflowscheme/project

Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.

If the project is associated with the Default Workflow Scheme no ID is returned. This is because the way the Default Workflow Scheme is stored means it has no ID.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Projectid`	The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, projectId=10000&projectId=10001.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/read

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

Permissions required:

Administer Jira global permission to access all, including project-scoped, workflow schemes
Administer projects project permissions to access project-scoped workflow schemes

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: workflows.usages Returns the project and issue types that each workflow in the workflow scheme is associated with.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Projectids`	The list of project IDs to query.
`Workflowschemeids`	The list of workflow scheme IDs to query.

/rest/api/3/workflowscheme/{id}

Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Defaultworkflow`	The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).
`Description`	The description of the workflow scheme.
`Draft`	Whether the workflow scheme is a draft or not.
`Id`	The ID of the workflow scheme.
`Lastmodified`	The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.
`Name`	The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
`Originaldefaultworkflow`	For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.
`Self`	The self URL of the workflow scheme (used for internal linking).
`Updatedraftifneeded`	Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated. Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false.

/rest/api/3/workflowscheme

Creates a workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Defaultworkflow`	The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).
`Description`	The description of the workflow scheme.
`Draft`	Whether the workflow scheme is a draft or not.
`Id`	The ID of the workflow scheme.
`Lastmodified`	The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.
`Name`	The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
`Originaldefaultworkflow`	For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.
`Self`	The self URL of the workflow scheme (used for internal linking).
`Updatedraftifneeded`	Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated. Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false.

/rest/api/3/workflowscheme/{id}/default

Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Updatedraftifneeded`	Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/workflow

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

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Workflowname`	The name of the workflow.
`Updatedraftifneeded`	Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/issuetype/{issueType}

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

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Issuetype`	The ID of the issue type.
`Updatedraftifneeded`	Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}

Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/default

Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Returndraftifexists`	Set to true to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/workflow

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Workflowname`	The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
`Returndraftifexists`	Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/update/mappings

Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both.

Permissions required:

Administer Jira permission to update all, including global-scoped, workflow schemes.
Administer projects project permission to update project-scoped workflow schemes.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Defaultworkflowid`	The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to Jira Workflow (jira).
`Id`	The ID of the workflow scheme.

/rest/api/3/workflowscheme/{id}/issuetype/{issueType}

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

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Issuetype`	The ID of the issue type.
`Returndraftifexists`	Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}

Returns a workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
`Returndraftifexists`	Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflowscheme/{id}/workflow

Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Workflowname`	The name of the workflow.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Defaultmapping`	Whether the workflow is the default workflow for the workflow scheme.
`Issuetypes`	The list of issue type IDs.
`Updatedraftifneeded`	Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false.
`Workflow`	The name of the workflow. Optional if updating the workflow-issue types mapping.

/rest/api/3/workflowscheme/{id}/issuetype/{issueType}

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

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Issuetype`	The ID of the issue type.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Issuetype`	The ID of the issue type. Not required if updating the issue type-workflow mapping.
`Updatedraftifneeded`	Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. Only applicable when updating the workflow-issue types mapping.
`Workflow`	The name of the workflow.

/rest/api/3/workflowscheme/{id}/default

Sets the default workflow for a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the workflow scheme.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Updatedraftifneeded`	Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false.
`Workflow`	The name of the workflow to set as the default workflow.

/rest/api/3/workflowscheme/update

Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an asynchronous task migrates the issues as defined in the provided mappings.

Permissions required:

Administer Jira project permission to update all, including global-scoped, workflow schemes.
Administer projects project permission to update project-scoped workflow schemes.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Defaultworkflowid`	The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the defaultWorkflowId isn't specified, this is set to Jira Workflow (jira).
`Description`	The new description for this workflow scheme.
`Id`	The ID of this workflow scheme.
`Name`	The new name for this workflow scheme.

/rest/api/3/statuscategory

Returns a list of all status categories.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/statuscategory/{idOrKey}

Returns a status category. Status categories provided a mechanism for categorizing statuses.

Permissions required: Permission to access Jira.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idorkey`	The ID or key of the status category.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/status

Returns a list of all statuses associated with active workflows.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/status/{idOrName}

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

If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idorname`	The ID or name of the status.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow/transitions/{transitionId}/properties

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Transitionid`	The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
`Key`	The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body.
`Workflowname`	The name of the workflow that the transition belongs to.
`Workflowmode`	The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The ID of the transition property.
`Key`	The key of the transition property. Also known as the name of the transition property.
`Value`	The value of the transition property.

/rest/api/3/workflow/transitions/{transitionId}/properties

Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Transitionid`	The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
`Key`	The name of the transition property to delete, also known as the name of the property.
`Workflowname`	The name of the workflow that the transition belongs to.
`Workflowmode`	The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow/transitions/{transitionId}/properties

Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Transitionid`	The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
`Includereservedkeys`	Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.
`Key`	The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
`Workflowname`	The name of the workflow that the transition belongs to.
`Workflowmode`	The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow/transitions/{transitionId}/properties

Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Transitionid`	The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
`Key`	The key of the property being updated, also known as the name of the property. Set this to the same value as the key defined in the request body.
`Workflowname`	The name of the workflow that the transition belongs to.
`Workflowmode`	The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The ID of the transition property.
`Key`	The key of the transition property. Also known as the name of the transition property.
`Value`	The value of the transition property.

/rest/api/3/workflow/rule/config/delete

Deletes workflow transition rules from one or more workflows. These rule types are supported:

post functions
conditions
validators

Only rules created by the calling Connect app can be deleted.

Permissions required: Only Connect apps can use this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow/rule/config

Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

of one or more transition rule types, such as workflow post functions.
matching one or more transition rule keys.

Only workflows containing transition rules created by the calling Connect or Forge app are returned.

Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

Permissions required: Only Connect or Forge apps can use this operation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Types`	The types of the transition rules to return.
`Keys`	The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.
`Workflownames`	The list of workflow names to filter by.
`Withtags`	The list of tags to filter by.
`Draft`	Whether draft or published workflows are returned. If not provided, both workflow types are returned.
`Expand`	Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow/rule/config

Updates configuration of workflow transition rules. The following rule types are supported:

post functions
conditions
validators

Only rules created by the calling Connect or Forge app can be updated.

To assist with app migration, this operation can be used to:

Disable a rule.
Add a tag. Use this to filter rules in the Get workflow transition rule configurations.

Rules are enabled if the disabled parameter is not provided.

Permissions required: Only Connect or Forge apps can use this operation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflows/create

Create workflows and related statuses.

Permissions required:

Administer Jira project permission to create all, including global-scoped, workflows
Administer projects project permissions to create project-scoped workflows

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflows

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

Permissions required:

Administer Jira global permission to access all, including project-scoped, workflows
At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: workflows.usages Returns the project and issue types that each workflow is associated with. statuses.usages Returns the project and issue types that each status is associated with.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Workflowids`	The list of workflow IDs to query.
`Workflownames`	The list of workflow names to query.

/rest/api/3/workflows/update

Update workflows and related statuses.

Permissions required:

Administer Jira project permission to create all, including global-scoped, workflows
Administer projects project permissions to create project-scoped workflows

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: workflows.usages Returns the project and issue types that each workflow is associated with. statuses.usages Returns the project and issue types that each status is associated with.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow

Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use bulk create workflows to create both team and company-managed scoped workflows.

Conditions

Conditions enable workflow rules that govern whether a transition can execute.

Always false condition

A condition that always fails.

JSON

{
   "type": "AlwaysFalseCondition"
 }

Block transition until approval

A condition that blocks issue transition if there is a pending approval.

JSON

{
   "type": "BlockInProgressApprovalCondition"
 }

Compare number custom field condition

A condition that allows transition if a comparison between a number custom field and a value is true.

JSON

{
   "type": "CompareNumberCFCondition",
   "configuration": {
     "comparator": "=",
     "fieldId": "customfield_10029",
     "fieldValue": 2
   }
 }

comparator One of the supported comparator: =, >, and <.
fieldId The custom numeric field ID. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:float
com.pyxis.greenhopper.jira:jsw-story-points
fieldValue The value for comparison.

Hide from user condition

A condition that hides a transition from users. The transition can only be triggered from a workflow function or REST API operation.

JSON

{
   "type": "RemoteOnlyCondition"
 }

Only assignee condition

A condition that allows only the assignee to execute a transition.

JSON

{
   "type": "AllowOnlyAssignee"
 }

Only Bamboo notifications workflow condition (deprecated)

A condition that makes the transition available only to Bamboo build notifications.

JSON

{
   "type": "OnlyBambooNotificationsCondition"
 }

Only reporter condition

A condition that allows only the reporter to execute a transition.

JSON

{
   "type": "AllowOnlyReporter"
 }

Permission condition

A condition that allows only users with a permission to execute a transition.

JSON

{
   "type": "PermissionCondition",
   "configuration": {
       "permissionKey": "BROWSE_PROJECTS"
   }
 }

permissionKey The permission required to perform the transition. Allowed values: built-in or app defined permissions.

Previous status condition

A condition that allows a transition based on whether an issue has or has not transitioned through a status.

JSON

{
   "type": "PreviousStatusCondition",
   "configuration": {
     "ignoreLoopTransitions": true,
     "includeCurrentStatus": true,
     "mostRecentStatusOnly": true,
     "reverseCondition": true,
     "previousStatus": {
       "id": "5"
     }
   }
 }

By default this condition allows the transition if the status, as defined by its ID in the previousStatus object, matches any previous issue status, unless:

ignoreLoopTransitions is true, then loop transitions (from and to the same status) are ignored.
includeCurrentStatus is true, then the current issue status is also checked.
mostRecentStatusOnly is true, then only the issue's preceding status (the one immediately before the current status) is checked.
reverseCondition is true, then the status must not be present.

Separation of duties condition

A condition that prevents a user to perform the transition, if the user has already performed a transition on the issue.

JSON

{
   "type": "SeparationOfDutiesCondition",
   "configuration": {
     "fromStatus": {
       "id": "5"
     },
     "toStatus": {
       "id": "6"
     }
   }
 }

fromStatus OPTIONAL. An object containing the ID of the source status of the transition that is blocked. If omitted any transition to toStatus is blocked.
toStatus An object containing the ID of the target status of the transition that is blocked.

Subtask blocking condition

A condition that blocks transition on a parent issue if any of its subtasks are in any of one or more statuses.

JSON

{
   "type": "SubTaskBlockingCondition",
   "configuration": {
     "statuses": [
       {
         "id": "1"
       },
       {
         "id": "3"
       }
     ]
   }
 }

statuses A list of objects containing status IDs.

User is in any group condition

A condition that allows users belonging to any group from a list of groups to execute a transition.

JSON

{
   "type": "UserInAnyGroupCondition",
   "configuration": {
     "groups": [
       "administrators",
       "atlassian-addons-admin"
     ]
   }
 }

groups A list of group names.

User is in any project role condition

A condition that allows only users with at least one project roles from a list of project roles to execute a transition.

JSON

{
   "type": "InAnyProjectRoleCondition",
   "configuration": {
     "projectRoles": [
       {
         "id": "10002"
       },
       {
         "id": "10003"
       },
       {
         "id": "10012"
       },
       {
         "id": "10013"
       }
     ]
   }
 }

projectRoles A list of objects containing project role IDs.

User is in custom field condition

A condition that allows only users listed in a given custom field to execute the transition.

JSON

{
   "type": "UserIsInCustomFieldCondition",
   "configuration": {
     "allowUserInField": false,
     "fieldId": "customfield_10010"
   }
 }

allowUserInField If true only a user who is listed in fieldId can perform the transition, otherwise, only a user who is not listed in fieldId can perform the transition.
fieldId The ID of the field containing the list of users.

User is in group condition

A condition that allows users belonging to a group to execute a transition.

JSON

{
   "type": "UserInGroupCondition",
   "configuration": {
     "group": "administrators"
   }
 }

group The name of the group.

User is in group custom field condition

A condition that allows users belonging to a group specified in a custom field to execute a transition.

JSON

{
   "type": "InGroupCFCondition",
   "configuration": {
     "fieldId": "customfield_10012"
   }
 }

fieldId The ID of the field. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker
com.atlassian.jira.plugin.system.customfieldtypes:grouppicker
com.atlassian.jira.plugin.system.customfieldtypes:select
com.atlassian.jira.plugin.system.customfieldtypes:multiselect
com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons
com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes
com.pyxis.greenhopper.jira:gh-epic-status

User is in project role condition

A condition that allows users with a project role to execute a transition.

JSON

{
   "type": "InProjectRoleCondition",
   "configuration": {
     "projectRole": {
       "id": "10002"
     }
   }
 }

projectRole An object containing the ID of a project role.

Value field condition

A conditions that allows a transition to execute if the value of a field is equal to a constant value or simply set.

JSON

{
   "type": "ValueFieldCondition",
   "configuration": {
     "fieldId": "assignee",
     "fieldValue": "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",
     "comparisonType": "NUMBER",
     "comparator": "="
   }
 }

fieldId The ID of a field used in the comparison.
fieldValue The expected value of the field.
comparisonType The type of the comparison. Allowed values: STRING, NUMBER, DATE, DATE_WITHOUT_TIME, or OPTIONID.
comparator One of the supported comparator: >, >=, =, <=, <, !=.

Notes:

If you choose the comparison type STRING, only = and != are valid options.
You may leave fieldValue empty when comparison type is != to indicate that a value is required in the field.
For date fields without time format values as yyyy-MM-dd, and for those with time as yyyy-MM-dd HH:mm. For example, for July 16 2021 use 2021-07-16, for 8:05 AM use 2021-07-16 08:05, and for 4 PM: 2021-07-16 16:00.

Validators

Validators check that any input made to the transition is valid before the transition is performed.

Date field validator

A validator that compares two dates.

JSON

{
   "type": "DateFieldValidator",
   "configuration": {
       "comparator": ">",
       "date1": "updated",
       "date2": "created",
       "expression": "1d",
       "includeTime": true
     }
 }

comparator One of the supported comparator: >, >=, =, <=, <, or !=.
date1 The date field to validate. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:datepicker
com.atlassian.jira.plugin.system.customfieldtypes:datetime
com.atlassian.jpo:jpo-custom-field-baseline-end
com.atlassian.jpo:jpo-custom-field-baseline-start
duedate
created
updated
resolutiondate
date2 The second date field. Required, if expression is not passed. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:datepicker
com.atlassian.jira.plugin.system.customfieldtypes:datetime
com.atlassian.jpo:jpo-custom-field-baseline-end
com.atlassian.jpo:jpo-custom-field-baseline-start
duedate
created
updated
resolutiondate
expression An expression specifying an offset. Required, if date2 is not passed. Offsets are built with a number, with - as prefix for the past, and one of these time units: d for day, w for week, m for month, or y for year. For example, -2d means two days into the past and 1w means one week into the future. The now keyword enables a comparison with the current date.
includeTime If true, then the time part of the data is included for the comparison. If the field doesn't have a time part, 00:00:00 is used.

Windows date validator

A validator that checks that a date falls on or after a reference date and before or on the reference date plus a number of days.

JSON

{
   "type": "WindowsDateValidator",
   "configuration": {
       "date1": "customfield_10009",
       "date2": "created",
       "windowsDays": 5
     }
 }

date1 The date field to validate. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:datepicker
com.atlassian.jira.plugin.system.customfieldtypes:datetime
com.atlassian.jpo:jpo-custom-field-baseline-end
com.atlassian.jpo:jpo-custom-field-baseline-start
duedate
created
updated
resolutiondate
date2 The reference date. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:datepicker
com.atlassian.jira.plugin.system.customfieldtypes:datetime
com.atlassian.jpo:jpo-custom-field-baseline-end
com.atlassian.jpo:jpo-custom-field-baseline-start
duedate
created
updated
resolutiondate
windowsDays A positive integer indicating a number of days.

Field required validator

A validator that checks fields are not empty. By default, if a field is not included in the current context it's ignored and not validated.

JSON

{
     "type": "FieldRequiredValidator",
     "configuration": {
         "ignoreContext": true,
         "errorMessage": "Hey",
         "fieldIds": [
             "versions",
             "customfield_10037",
             "customfield_10003"
         ]
     }
 }

ignoreContext If true, then the context is ignored and all the fields are validated.
errorMessage OPTIONAL. The error message displayed when one or more fields are empty. A default error message is shown if an error message is not provided.
fieldIds The list of fields to validate.

Field changed validator

A validator that checks that a field value is changed. However, this validation can be ignored for users from a list of groups.

JSON

{
     "type": "FieldChangedValidator",
     "configuration": {
         "fieldId": "comment",
         "errorMessage": "Hey",
         "exemptedGroups": [
             "administrators",
             "atlassian-addons-admin"
         ]
     }
 }

fieldId The ID of a field.
errorMessage OPTIONAL. The error message displayed if the field is not changed. A default error message is shown if the error message is not provided.
exemptedGroups OPTIONAL. The list of groups.

Field has single value validator

A validator that checks that a multi-select field has only one value. Optionally, the validation can ignore values copied from subtasks.

JSON

{
     "type": "FieldHasSingleValueValidator",
     "configuration": {
         "fieldId": "attachment,
         "excludeSubtasks": true
     }
 }

fieldId The ID of a field.
excludeSubtasks If true, then values copied from subtasks are ignored.

Parent status validator

A validator that checks the status of the parent issue of a subtask. Ìf the issue is not a subtask, no validation is performed.

JSON

{
     "type": "ParentStatusValidator",
     "configuration": {
         "parentStatuses": [
             {
               "id":"1"
             },
             {
               "id":"2"
             }
         ]
     }
 }

parentStatus The list of required parent issue statuses.

Permission validator

A validator that checks the user has a permission.

JSON

{
   "type": "PermissionValidator",
   "configuration": {
       "permissionKey": "ADMINISTER_PROJECTS"
   }
 }

permissionKey The permission required to perform the transition. Allowed values: built-in or app defined permissions.

Previous status validator

A validator that checks if the issue has held a status.

JSON

{
   "type": "PreviousStatusValidator",
   "configuration": {
       "mostRecentStatusOnly": false,
       "previousStatus": {
           "id": "15"
       }
   }
 }

mostRecentStatusOnly If true, then only the issue's preceding status (the one immediately before the current status) is checked.
previousStatus An object containing the ID of an issue status.

Regular expression validator

A validator that checks the content of a field against a regular expression.

JSON

{
   "type": "RegexpFieldValidator",
   "configuration": {
       "regExp": "[0-9]",
       "fieldId": "customfield_10029"
   }
 }

regExpA regular expression.
fieldId The ID of a field. Allowed field types:

com.atlassian.jira.plugin.system.customfieldtypes:select
com.atlassian.jira.plugin.system.customfieldtypes:multiselect
com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons
com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes
com.atlassian.jira.plugin.system.customfieldtypes:textarea
com.atlassian.jira.plugin.system.customfieldtypes:textfield
com.atlassian.jira.plugin.system.customfieldtypes:url
com.atlassian.jira.plugin.system.customfieldtypes:float
com.pyxis.greenhopper.jira:jsw-story-points
com.pyxis.greenhopper.jira:gh-epic-status
description
summary

User permission validator

A validator that checks if a user has a permission. Obsolete. You may encounter this validator when getting transition rules and can pass it when updating or creating rules, for example, when you want to duplicate the rules from a workflow on a new workflow.

JSON

{
     "type": "UserPermissionValidator",
     "configuration": {
         "permissionKey": "BROWSE_PROJECTS",
         "nullAllowed": false,
         "username": "TestUser"
     }
 }

permissionKey The permission to be validated. Allowed values: built-in or app defined permissions.
nullAllowed If true, allows the transition when username is empty.
username The username to validate against the permissionKey.

Post functions

Post functions carry out any additional processing required after a Jira workflow transition is executed.

Fire issue event function

A post function that fires an event that is processed by the listeners.

JSON

{
   "type": "FireIssueEventFunction",
   "configuration": {
     "event": {
       "id":"1"
     }
   }
 }

Note: If provided, this post function overrides the default FireIssueEventFunction. Can be included once in a transition.

event An object containing the ID of the issue event.

Update issue status

A post function that sets issue status to the linked status of the destination workflow status.

JSON

{
   "type": "UpdateIssueStatusFunction"
 }

Note: This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.

Create comment

A post function that adds a comment entered during the transition to an issue.

JSON

{
   "type": "CreateCommentFunction"
 }

Note: This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.

Store issue

A post function that stores updates to an issue.

JSON

{
   "type": "IssueStoreFunction"
 }

Note: This post function can only be added to the initial transition and can only be added once.

Assign to current user function

A post function that assigns the issue to the current user if the current user has the ASSIGNABLE_USER permission.

JSON

{
     "type": "AssignToCurrentUserFunction"
 }

Note: This post function can be included once in a transition.

Assign to lead function

A post function that assigns the issue to the project or component lead developer.

JSON

{
     "type": "AssignToLeadFunction"
 }

Note: This post function can be included once in a transition.

Assign to reporter function

A post function that assigns the issue to the reporter.

JSON

{
     "type": "AssignToReporterFunction"
 }

Note: This post function can be included once in a transition.

Clear field value function

A post function that clears the value from a field.

JSON

{
   "type": "ClearFieldValuePostFunction",
   "configuration": {
     "fieldId": "assignee"
   }
 }

fieldId The ID of the field.

Copy value from other field function

A post function that copies the value of one field to another, either within an issue or from parent to subtask.

JSON

{
   "type": "CopyValueFromOtherFieldPostFunction",
   "configuration": {
     "sourceFieldId": "assignee",
     "destinationFieldId": "creator",
     "copyType": "same"
   }
 }

sourceFieldId The ID of the source field.
destinationFieldId The ID of the destination field.
copyType Use same to copy the value from a field inside the issue, or parent to copy the value from the parent issue.

Create Crucible review workflow function (deprecated)

A post function that creates a Crucible review for all unreviewed code for the issue.

JSON

{
     "type": "CreateCrucibleReviewWorkflowFunction"
 }

Note: This post function can be included once in a transition.

Set issue security level based on user's project role function

A post function that sets the issue's security level if the current user has a project role.

JSON

{
   "type": "SetIssueSecurityFromRoleFunction",
   "configuration": {
     "projectRole": {
         "id":"10002"
     },
     "issueSecurityLevel": {
         "id":"10000"
     }
   }
 }

projectRole An object containing the ID of the project role.
issueSecurityLevel OPTIONAL. The object containing the ID of the security level. If not passed, then the security level is set to none.

Trigger a webhook function

A post function that triggers a webhook.

JSON

{
   "type": "TriggerWebhookFunction",
   "configuration": {
     "webhook": {
       "id": "1"
     }
   }
 }

webhook An object containing the ID of the webhook listener to trigger.

Update issue custom field function

A post function that updates the content of an issue custom field.

JSON

{
   "type": "UpdateIssueCustomFieldPostFunction",
   "configuration": {
     "mode": "append",
     "fieldId": "customfield_10003",
     "fieldValue": "yikes"
   }
 }

mode Use replace to override the field content with fieldValue or append to add fieldValue to the end of the field content.
fieldId The ID of the field.
fieldValue The update content.

Update issue field function

A post function that updates a simple issue field.

JSON

{
   "type": "UpdateIssueFieldFunction",
   "configuration": {
     "fieldId": "assignee",
     "fieldValue": "5f0c277e70b8a90025a00776"
   }
 }

fieldId The ID of the field. Allowed field types:

assignee
description
environment
priority
resolution
summary
timeoriginalestimate
timeestimate
timespent
fieldValue The update value.
If the fieldId is assignee, the fieldValue should be one of these values:

an account ID.
automatic.
a blank string, which sets the value to unassigned.

Connect rules

Connect rules are conditions, validators, and post functions of a transition that are registered by Connect apps. To create a rule registered by the app, the app must be enabled and the rule's module must exist.

JSON

{
   "type": "appKey__moduleKey",
   "configuration": {
     "value":"{\"isValid\":\"true\"}"
   }
 }

type A Connect rule key in a form of appKey__moduleKey.
value The stringified JSON configuration of a Connect rule.

Forge rules

Forge transition rules are not yet supported.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	The description of the workflow. The maximum length is 1000 characters.
`Name`	The name of the workflow. The name must be unique. The maximum length is 255 characters. Characters can be separated by a whitespace but the name cannot start or end with a whitespace.

/rest/api/3/workflow/{entityId}

Deletes a workflow.

The workflow cannot be deleted if it is:

an active workflow.
a system workflow.
associated with any workflow scheme.
associated with any draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The entity ID of the workflow.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow

Returns all workflows in Jira or a workflow. Deprecated, use Get workflows paginated.

If the workflowName parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workflowname`	The name of the workflow to be returned. Only one workflow can be specified.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflows/capabilities

Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).

Permissions required:

Administer Jira project permission to access all, including global-scoped, workflows
Administer projects project permissions to access project-scoped workflows

The current list of Atlassian-provided rules:

Validators

A validator rule that checks if a user has the required permissions to execute the transition in the workflow.

Permission validator

A validator rule that checks if a user has the required permissions to execute the transition in the workflow.

JSON

{
   "ruleKey": "system:check-permission-validator",
   "parameters": {
     "permissionKey": "ADMINISTER_PROJECTS"
   }
 }

Parameters:

permissionKey The permission required to perform the transition. Allowed values: built-in Jira permissions.

Parent or child blocking validator

A validator to block the child issue\\u2019s transition depending on the parent issue\\u2019s status.

JSON

{
   "ruleKey" : "system:parent-or-child-blocking-validator"
   "parameters" : {
     "blocker" : "PARENT"
     "statusIds" : "1,2,3"
   }
 }

Parameters:

blocker currently only supports PARENT.
statusIds a comma-separated list of status IDs.

Previous status validator

A validator that checks if an issue has transitioned through specified previous status(es) before allowing the current transition to occur.

JSON

{
   "ruleKey": "system:previous-status-validator",
   "parameters": {
     "previousStatusIds": "10014",
     "mostRecentStatusOnly": "true"
   }
 }

Parameters:

previousStatusIds a comma-separated list of status IDs, currently only support one ID.
mostRecentStatusOnly when true only considers the most recent status for the condition evaluation. Allowed values: true, false.

Validate a field value

A validation that ensures a specific field's value meets the defined criteria before allowing an issue to transition in the workflow.

Depending on the rule type, the result will vary:

Field required

JSON

{
   "ruleKey": "system:validate-field-value",
   "parameters": {
     "ruleType": "fieldRequired",
     "fieldsRequired": "assignee",
     "ignoreContext": "true",
     "errorMessage": "An assignee must be set!"
   }
 }

Parameters:

fieldsRequired the ID of the field that is required. For a custom field, it would look like customfield_123.
ignoreContext controls the impact of context settings on field validation. When set to true, the validator doesn't check a required field if its context isn't configured for the current issue. When set to false, the validator requires a field even if its context is invalid. Allowed values: true, false.
errorMessage is the error message to display if the user does not provide a value during the transition. A default error message will be shown if you don't provide one (Optional).

Field changed

C

{
   "ruleKey": "system:validate-field-value",
   "parameters": {
     "ruleType": "fieldChanged",
     "groupsExemptFromValidation": "6862ac20-8672-4f68-896d-4854f5efb79e",
     "fieldKey": "versions",
     "errorMessage": "Affect versions must be modified before transition"
   }
 }

Parameters:

groupsExemptFromValidation a comma-separated list of group IDs to be exempt from the validation.
fieldKey the ID of the field that has changed. For a custom field, it would look like customfield_123.
errorMessage the error message to display if the user does not provide a value during the transition. A default error message will be shown if you don't provide one (Optional).

Field has a single value

JSON

{
   "ruleKey": "system:validate-field-value",
   "parameters": {
     "ruleType": "fieldHasSingleValue",
     "fieldKey": "created",
     "excludeSubtasks": "true"
   }
 }

Parameters:

fieldKey the ID of the field to validate. For a custom field, it would look like customfield_123.
excludeSubtasks Option to exclude values copied from sub-tasks. Allowed values: true, false.

Field matches regular expression

C

{
   "ruleKey": "system:validate-field-value",
   "parameters": {
     "ruleType": "fieldMatchesRegularExpression",
     "regexp": "[0-9]{4}",
     "fieldKey": "description"
   }
 }

Parameters:

regexp the regular expression used to validate the field\\u2019s content.
fieldKey the ID of the field to validate. For a custom field, it would look like customfield_123.

Date field comparison

C

{
   "ruleKey": "system:validate-field-value",
   "parameters": {
     "ruleType": "dateFieldComparison",
     "date1FieldKey": "duedate",
     "date2FieldKey": "customfield_10054",
     "includeTime": "true",
     "conditionSelected": ">="
   }
 }

Parameters:

date1FieldKey the ID of the first field to compare. For a custom field, it would look like customfield_123.
date2FieldKey the ID of the second field to compare. For a custom field, it would look like customfield_123.
includeTime if true, compares both date and time. Allowed values: true, false.
conditionSelected the condition to compare with. Allowed values: >, >=, =, <=, <, !=.

Date range comparison

C

{
   "ruleKey": "system:validate-field-value",
   "parameters": {
     "ruleType": "windowDateComparison",
     "date1FieldKey": "customfield_10009",
     "date2FieldKey": "customfield_10054",
     "numberOfDays": "3"
   }
 }

Parameters:

date1FieldKey the ID of the first field to compare. For a custom field, it would look like customfield_123.
date2FieldKey the ID of the second field to compare. For a custom field, it would look like customfield_123.
numberOfDays maximum number of days past the reference date (date2FieldKey) to pass validation.

This rule is composed by aggregating the following legacy rules:

FieldRequiredValidator
FieldChangedValidator
FieldHasSingleValueValidator
RegexpFieldValidator
DateFieldValidator
WindowsDateValidator

Proforma: Forms attached validator

Validates that one or more forms are attached to the issue.

JSON

{
   "ruleKey" : "system:proforma-forms-attached"
   "parameters" : {}
 }

Proforma: Forms submitted validator

Validates that all forms attached to the issue have been submitted.

JSON

{
   "ruleKey" : "system:proforma-forms-submitted"
   "parameters" : {}
 }

Conditions

Conditions enable workflow rules that govern whether a transition can execute.

Check field value

A condition rule evaluates as true if a specific field's value meets the defined criteria. This rule ensures that an issue can only transition to the next step in the workflow if the field's value matches the desired condition.

JSON

{
   "ruleKey": "system:check-field-value",
   "parameters": {
     "fieldId": "description",
     "fieldValue": "[\"Done\"]",
     "comparator": "=",
     "comparisonType": "STRING"
   }
 }

Parameters:

fieldId The ID of the field to check the value of. For non-system fields, it will look like customfield_123. Note: fieldId is used interchangeably with the idea of fieldKey here, they refer to the same field.
fieldValue the list of values to check against the field\\u2019s value.
comparator The comparison logic. Allowed values: >, >=, =, <=, <, !=.
comparisonType The type of data being compared. Allowed values: STRING, NUMBER, DATE, DATE_WITHOUT_TIME, OPTIONID.

Restrict issue transition

This rule ensures that issue transitions are restricted based on user accounts, roles, group memberships, and permissions, maintaining control over who can transition an issue. This condition evaluates as true if any of the following criteria is met.

JSON

{
   "ruleKey": "system:restrict-issue-transition",
   "parameters": {
     "accountIds": "allow-reporter,5e68ac137d64450d01a77fa0",
     "roleIds": "10002,10004",
     "groupIds": "703ff44a-7dc8-4f4b-9aa6-a65bf3574fa4",
     "permissionKeys": "ADMINISTER_PROJECTS",
     "groupCustomFields": "customfield_10028",
     "allowUserCustomFields": "customfield_10072,customfield_10144,customfield_10007",
     "denyUserCustomFields": "customfield_10107"
   }
 }

Parameters:

accountIds a comma-separated list of the user account IDs. It also allows generic values like: allow-assignee, allow-reporter, and accountIds Note: This is only supported in team-managed projects
roleIds a comma-separated list of role IDs.
groupIds a comma-separated list of group IDs.
permissionKeys a comma-separated list of permission keys. Allowed values: built-in Jira permissions.
groupCustomFields a comma-separated list of group custom field IDs.
allowUserCustomFields a comma-separated list of user custom field IDs to allow for issue transition.
denyUserCustomFields a comma-separated list of user custom field IDs to deny for issue transition.

This rule is composed by aggregating the following legacy rules:

AllowOnlyAssignee
AllowOnlyReporter
InAnyProjectRoleCondition
InProjectRoleCondition
UserInAnyGroupCondition
UserInGroupCondition
PermissionCondtion
InGroupCFCondition
UserIsInCustomFieldCondition

Previous status condition

A condition that evaluates based on an issue's previous status(es) and specific criteria.

JSON

{
   "ruleKey" : "system:previous-status-condition"
   "parameters" : {
     "previousStatusIds" : "10004",
     "not": "true",
     "mostRecentStatusOnly" : "true",
     "includeCurrentStatus": "true",
     "ignoreLoopTransitions": "true"
   }
 }

Parameters:

previousStatusIds a comma-separated list of status IDs, current only support one ID.
not indicates if the condition should be reversed. When true it checks that the issue has not been in the selected statuses. Allowed values: true, false.
mostRecentStatusOnly when true only considers the most recent status for the condition evaluation. Allowed values: true, false.
includeCurrentStatus includes the current status when evaluating if the issue has been through the selected statuses. Allowed values: true, false.
ignoreLoopTransitions ignore loop transitions. Allowed values: true, false.

Parent or child blocking condition

A condition to block the parent\\u2019s issue transition depending on the child\\u2019s issue status.

JSON

{
   "ruleKey" : "system:parent-or-child-blocking-condition"
   "parameters" : {
     "blocker" : "CHILD",
     "statusIds" : "1,2,3"
   }
 }

Parameters:

blocker currently only supports CHILD.
statusIds a comma-separated list of status IDs.

Separation of duties

A condition preventing the user from performing, if the user has already performed a transition on the issue.

JSON

{
   "ruleKey": "system:separation-of-duties",
   "parameters": {
     "fromStatusId": "10161",
     "toStatusId": "10160"
   }
 }

Parameters:

fromStatusId represents the status ID from which the issue is transitioning. It ensures that the user performing the current transition has not performed any actions when the issue was in the specified status.
toStatusId represents the status ID to which the issue is transitioning. It ensures that the user performing the current transition is not the same user who has previously transitioned the issue.

Restrict transitions

A condition preventing all users from transitioning the issue can also optionally include APIs as well.

JSON

{
   "ruleKey": "system:restrict-from-all-users",
   "parameters": {
     "restrictMode": "users"
   }
 }

Parameters:

restrictMode restricts the issue transition including/excluding APIs. Allowed values: "users", "usersAndAPI".

Jira Service Management block until approved

Block an issue transition until approval. Note: This is only supported in team-managed projects.

JSON

{
   "ruleKey": "system:jsd-approvals-block-until-approved",
   "parameters": {
     "approvalConfigurationJson": "{"statusExternalUuid...}"
   }
 }

Parameters:

approvalConfigurationJson a stringified JSON holding the Jira Service Management approval configuration.

Jira Service Management block until rejected

Block an issue transition until rejected. Note: This is only supported in team-managed projects.

JSON

{
   "ruleKey": "system:jsd-approvals-block-until-rejected",
   "parameters": {
     "approvalConfigurationJson": "{"statusExternalUuid...}"
   }
 }

Parameters:

approvalConfigurationJson a stringified JSON holding the Jira Service Management approval configuration.

Block in progress approval

Condition to block issue transition if there is pending approval. Note: This is only supported in company-managed projects.

JSON

{
   "ruleKey": "system:block-in-progress-approval",
   "parameters": {}
 }

Post functions

Post functions carry out any additional processing required after a workflow transition is executed.

Change assignee

A post function rule that changes the assignee of an issue after a transition.

JSON

{
   "ruleKey": "system:change-assignee",
   "parameters": {
     "type": "to-selected-user",
     "accountId": "example-account-id"
   }
 }

Parameters:

type the parameter used to determine the new assignee. Allowed values: to-selected-user, to-unassigned, to-current-user, to-current-user, to-default-user, to-default-user
accountId the account ID of the user to assign the issue to. This parameter is required only when the type is "to-selected-user".

Copy field value

A post function that automates the process of copying values between fields during a specific transition, ensuring data consistency and reducing manual effort.

JSON

{
   "ruleKey": "system:copy-value-from-other-field",
   "parameters": {
     "sourceFieldKey": "description",
     "targetFieldKey": "components",
     "issueSource": "SAME"
   }
 }

Parameters:

sourceFieldKey the field key to copy from. For a custom field, it would look like customfield_123
targetFieldKey the field key to copy to. For a custom field, it would look like customfield_123
issueSource SAME or PARENT. Defaults to SAME if no value is provided.

Update field

A post function that updates or appends a specific field with the given value.

JSON

{
   "ruleKey": "system:update-field",
   "parameters": {
     "field": "customfield_10056",
     "value": "asdf",
     "mode": "append"
   }
 }

Parameters:

field the ID of the field to update. For a custom field, it would look like customfield_123
value the value to update the field with.
mode append or replace. Determines if a value will be appended to the current value, or if the current value will be replaced.

Trigger webhook

A post function that automatically triggers a predefined webhook when a transition occurs in the workflow.

JSON

{
   "ruleKey": "system:trigger-webhook",
   "parameters": {
     "webhookId": "1"
   }
 }

Parameters:

webhookId the ID of the webhook.

Screen

Remind people to update fields

A screen rule that prompts users to update a specific field when they interact with an issue screen during a transition. This rule is useful for ensuring that users provide or modify necessary information before moving an issue to the next step in the workflow.

JSON

{
   "ruleKey": "system:remind-people-to-update-fields",
   "params": {
     "remindingFieldIds": "assignee,customfield_10025",
     "remindingMessage": "The message",
     "remindingAlwaysAsk": "true"
   }
 }

Parameters:

remindingFieldIds a comma-separated list of field IDs. Note: fieldId is used interchangeably with the idea of fieldKey here, they refer to the same field.
remindingMessage the message to display when prompting the users to update the fields.
remindingAlwaysAsk always remind to update fields. Allowed values: true, false.

Shared transition screen

A common screen that is shared between transitions in a workflow.

JSON

{
   "ruleKey": "system:transition-screen",
   "params": {
     "screenId": "3"
   }
 }

Parameters:

screenId the ID of the screen.

Connect & Forge

Connect rules

Validator/Condition/Post function for Connect app.

JSON

{
   "ruleKey": "connect:expression-validator",
   "parameters": {
     "appKey": "com.atlassian.app",
     "config": "",
     "id": "90ce590f-e90c-4cd3-8281-165ce41f2ac3",
     "disabled": "false",
     "tag": ""
   }
 }

Parameters:

ruleKey Validator: connect:expression-validator, Condition: connect:expression-condition, and Post function: connect:remote-workflow-function
appKey the reference to the Connect app
config a JSON payload string describing the configuration
id the ID of the rule
disabled determine if the Connect app is disabled. Allowed values: true, false.
tag additional tags for the Connect app

Forge rules

Validator/Condition/Post function for Forge app.

JSON

{
   "ruleKey": "forge:expression-validator",
   "parameters": {
     "key": "ari:cloud:ecosystem::extension/{appId}/{environmentId}/static/{moduleKey}",
     "config": "{"searchString":"workflow validator"}",
     "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2"
   }
 }

Parameters:

ruleKey Validator: forge:expression-validator, Condition: forge:expression-condition, and Post function: forge:workflow-post-function
key the identifier for the Forge app
config the persistent stringified JSON configuration for the Forge rule
id the ID of the Forge rule

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workflowid`	The ID of the workflow to get capabilities for.
`Projectid`	The ID of the project to filter capabilities by.
`Issuetypeid`	The ID of the issue type to filter capabilities by.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflow/search

Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

Permissions required: Administer Jira global permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startat`	The index of the first item to return in a page of results (page offset).
`Maxresults`	The maximum number of items to return per page.
`Workflowname`	The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&workflowName=name2.
`Expand`	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: transitions For each workflow, returns information about the transitions inside the workflow. transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. statuses For each workflow, returns information about the statuses inside the workflow. statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. default For each workflow, returns information about whether this is the default workflow. schemes For each workflow, returns information about the workflow schemes the workflow is assigned to. projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version. operations For each workflow, returns information about the actions that can be undertaken on the workflow.
`Querystring`	String used to perform a case-insensitive partial match with workflow name.
`Orderby`	Order the results by a field: name Sorts by workflow name. created Sorts by create time. updated Sorts by update time.
`Isactive`	Filters active and inactive workflows.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflows/create/validation

Validate the payload for bulk create workflows.

Permissions required:

Administer Jira project permission to create all, including global-scoped, workflows
Administer projects project permissions to create project-scoped workflows

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rest/api/3/workflows/update/validation

Validate the payload for bulk update workflows.

Permissions required:

Administer Jira project permission to create all, including global-scoped, workflows
Administer projects project permissions to create project-scoped workflows

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Announcement banner (2)

App data policies (EAP) (2)

App migration (3)

App properties (6)

Application roles (2)

Audit records

Avatars (7)

Dashboards (17)

Dynamic modules (3)

Filter sharing (6)

Filters (13)

Group and user picker

Groups (8)

Issue attachments (8)

curl

Node.js

Java

Python

PHP

Forge

Issue comment properties (4)

Issue comments (6)

Issue custom field configuration (apps) (2)

Issue custom field contexts (13)

Issue custom field options (apps) (8)

Issue custom field options (6)

Issue custom field values (apps) (2)

Issue field configurations (15)

Issue fields (9)

Issue link types (5)

Issue links (3)

Issue navigator settings (2)

Issue notification schemes (8)

Issue priorities (8)

Issue properties (8)

Issue remote links (6)

Issue resolutions (8)

Issue search (4)

Issue security level (2)

Issue security schemes (16)

Issue type properties (4)

Issue type schemes (10)

Issue type screen schemes (11)

Issue types (8)

Issue votes (3)

Issue watchers (4)

Issue worklog properties (4)

Issue worklogs (8)

Issues (20)

JQL functions (apps) (2)

JQL (6)

Jira expressions (2)

Context variables

Jira settings (4)

Advanced settings

Look and feel

Other settings

Labels

License metrics (3)

Myself (7)

Permission schemes (9)

About permission schemes and grants

Holder object

Built-in permissions

Permissions (4)

Project avatars (4)

Project categories (5)

Project components (7)

Project email (2)

Project features (2)

Project key and name validation (3)

Project permission schemes (4)

Project properties (4)

Project role actors (6)

Project roles (9)

About project roles

Members and actors

Project types (4)

Project versions (15)

Projects (13)