The Jira Cloud platform REST API provides HTTP endpoints for retrieving and updating a wide range of Jira Cloud resources—including announcement banners, custom fields, attachments, comments and their properties, dashboards and gadgets, components, configuration and application settings, issue links, avatars, and audit records—enabling programmatic management of these entities.
fieldIdOrKey(path, required) — The ID or key of the custom field, for example `customfield_10000`.
id(query) — 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(query) — 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(query) — 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(query) — The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with `issueId`.
issueTypeId(query) — The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with `issueId`.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
fieldIdOrKey(path, required) — The ID or key of the custom field, for example `customfield_10000`.
PUT
/rest/api/3/app/field/{fieldIdOrKey}/value
Update custom field value
fieldIdOrKey(path, required) — The ID or key of the custom field. For example, `customfield_10010`.
generateChangelog(query) — Whether to generate a changelog for this update.
GET
/rest/api/3/application-properties
Get application property
key(query) — The key of the application property.
permissionLevel(query) — The permission level of all items being returned in the list.
keyFilter(query) — 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.*.
id(path, required) — The key of the application property to update.
GET
/rest/api/3/applicationrole
Get all application roles
GET
/rest/api/3/applicationrole/{key}
Get application role
key(path, required) — The key of the application role. Use the [Get all application roles](#api-rest-api-3-applicationrole-get) operation to get the key for each application role.
GET
/rest/api/3/attachment/content/{id}
Get attachment content
id(path, required) — The ID of the attachment.
redirect(query) — 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.
GET
/rest/api/3/attachment/thumbnail/{id}
Get attachment thumbnail
id(path, required) — The ID of the attachment.
redirect(query) — 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(query) — Whether a default thumbnail is returned when the requested thumbnail is not found.
width(query) — The maximum width to scale the thumbnail to.
height(query) — The maximum height to scale the thumbnail to.
DELETE
/rest/api/3/attachment/{id}
Delete attachment
id(path, required) — The ID of the attachment.
GET
/rest/api/3/attachment/{id}
Get attachment metadata
id(path, required) — The ID of the attachment.
GET
/rest/api/3/attachment/{id}/expand/human
Get all metadata for an expanded attachment
id(path, required) — The ID of the attachment.
GET
/rest/api/3/attachment/{id}/expand/raw
Get contents metadata for an expanded attachment
id(path, required) — The ID of the attachment.
GET
/rest/api/3/auditing/record
Get audit records
offset(query, offset) — The number of records to skip before returning the first result.
limit(query, limit) — The maximum number of results to return.
filter(query) — The strings to match with audit field content, space separated.
from(query) — 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(query) — 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.
GET
/rest/api/3/avatar/{type}/system
Get system avatars by type
type(path, required) — The avatar type.
POST
/rest/api/3/comment/list
Get comments by IDs
expand(query) — Use [expand](#expansion) 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.
POST
/rest/api/3/component
Create component
DELETE
/rest/api/3/component/{id}
Delete component
id(path, required) — The ID of the component.
moveIssuesTo(query) — The ID of the component to replace the deleted component. If this value is null no replacement is made.
GET
/rest/api/3/component/{id}
Get component
id(path, required) — The ID of the component.
PUT
/rest/api/3/component/{id}
Update component
id(path, required) — The ID of the component.
GET
/rest/api/3/component/{id}/relatedIssueCounts
Get component issues count
id(path, required) — The ID of the component.
GET
/rest/api/3/configuration
Get global settings
GET
/rest/api/3/configuration/timetracking
Get selected time tracking provider
PUT
/rest/api/3/configuration/timetracking
Select time tracking provider
GET
/rest/api/3/configuration/timetracking/list
Get all time tracking providers
GET
/rest/api/3/configuration/timetracking/options
Get time tracking settings
PUT
/rest/api/3/configuration/timetracking/options
Set time tracking settings
GET
/rest/api/3/customFieldOption/{id}
Get custom field option
id(path, required) — The ID of the custom field option.
GET
/rest/api/3/dashboard
Get all dashboards
filter(query) — 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(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
POST
/rest/api/3/dashboard
Create dashboard
GET
/rest/api/3/dashboard/search
Search for dashboards
dashboardName(query) — String used to perform a case-insensitive partial match with `name`.
accountId(query) — User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.
owner(query) — This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-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(query) — 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(query) — 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(query) — Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.
orderBy(query) — [Order](#ordering) 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(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
status(query) — The status to filter by. It may be active, archived or deleted.
expand(query) — Use [expand](#expansion) 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.
GET
/rest/api/3/dashboard/{dashboardId}/gadget
Get gadgets
dashboardId(path, required) — The ID of the dashboard.
moduleKey(query) — The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.
uri(query) — The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.
gadgetId(query) — The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.
POST
/rest/api/3/dashboard/{dashboardId}/gadget
Add gadget to dashboard
dashboardId(path, required) — The ID of the dashboard.
dashboardId(path, required) — The ID of the dashboard.
itemId(path, required) — The ID of the dashboard item.
propertyKey(path, required) — 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.
DELETE
/rest/api/3/dashboard/{id}
Delete dashboard
id(path, required) — The ID of the dashboard.
GET
/rest/api/3/dashboard/{id}
Get dashboard
id(path, required) — The ID of the dashboard.
PUT
/rest/api/3/dashboard/{id}
Update dashboard
id(path, required) — The ID of the dashboard to update.
POST
/rest/api/3/dashboard/{id}/copy
Copy dashboard
id(path, required)
GET
/rest/api/3/events
Get events
POST
/rest/api/3/expression/analyse
Analyse Jira expression
check(query) — 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](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each expression may execute.
POST
/rest/api/3/expression/eval
Evaluate Jira expression
expand(query) — Use [expand](#expansion) 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](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing and debugging your expressions.
GET
/rest/api/3/field
Get fields
POST
/rest/api/3/field
Create custom field
PUT
/rest/api/3/field/{fieldId}/context/defaultValue
Set custom field contexts default values
fieldId(path, required) — The ID of the custom field.
GET
/rest/api/3/field/search
Get fields paginated
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
type(query) — The type of fields to search.
id(query) — The IDs of the custom fields to return or, where `query` is specified, filter.
query(query) — String used to perform a case-insensitive partial match with field names or descriptions.
orderBy(query) — [Order](#ordering) 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(query) — Use [expand](#expansion) 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](https://confluence.atlassian.com/x/ZSN7Og) * `searcherKey` returns the searcher key for each custom field
GET
/rest/api/3/field/search/trashed
Get fields in trash paginated
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query)
query(query) — String used to perform a case-insensitive partial match with field names or descriptions.
expand(query)
orderBy(query) — [Order](#ordering) 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
PUT
/rest/api/3/field/{fieldId}
Update custom field
fieldId(path, required) — The ID of the custom field.
GET
/rest/api/3/field/{fieldId}/context
Get custom field contexts
fieldId(path, required) — The ID of the custom field.
isAnyIssueType(query) — Whether to return contexts that apply to all issue types.
isGlobalContext(query) — Whether to return contexts that apply to all projects.
contextId(query) — The list of context IDs. To include multiple contexts, separate IDs with ampersand: `contextId=10000&contextId=10001`.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
POST
/rest/api/3/field/{fieldId}/context
Create custom field context
fieldId(path, required) — The ID of the custom field.
GET
/rest/api/3/field/{fieldId}/context/defaultValue
Get custom field contexts default values
fieldId(path, required) — The ID of the custom field, for example `customfield\_10000`.
contextId(query) — The IDs of the contexts.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
fieldId(path, required) — The ID of the custom field.
contextId(query) — The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, `contextId=10001&contextId=10002`.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
POST
/rest/api/3/field/{fieldId}/context/mapping
Get custom field contexts for projects and issue types
fieldId(path, required) — The ID of the custom field.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
fieldId(path, required) — The ID of the custom field.
contextId(path, required) — The ID of the context.
GET
/rest/api/3/field/{fieldId}/contexts
Get contexts for a field
fieldId(path, required) — The ID of the field to return contexts for.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
GET
/rest/api/3/field/{fieldId}/screens
Get screens for a field
fieldId(path, required) — The ID of the field to return screens for.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
expand(query) — Use [expand](#expansion) 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.
GET
/rest/api/3/field/{fieldKey}/option
Get all issue field options
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
GET
/rest/api/3/fieldconfigurationscheme
Get all field configuration schemes
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
POST
/rest/api/3/field/{fieldKey}/option
Create issue field option
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
projectId(query) — Filters the results to options that are only available in the specified project.
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
projectId(query) — Filters the results to options that are only available in the specified project.
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
DELETE
/rest/api/3/field/{fieldKey}/option/{optionId}
Delete issue field option
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
optionId(path, required) — The ID of the option to be deleted.
GET
/rest/api/3/field/{fieldKey}/option/{optionId}
Get issue field option
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
optionId(path, required) — The ID of the option to be returned.
POST
/rest/api/3/fieldconfigurationscheme
Create field configuration scheme
PUT
/rest/api/3/field/{fieldKey}/option/{optionId}
Update issue field option
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
optionId(path, required) — The ID of the option to be updated.
replaceWith(query) — The ID of the option that will replace the currently selected option.
jql(query) — A JQL query that specifies the issues to be updated. For example, *project=10000*.
overrideScreenSecurity(query) — Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.
overrideEditableFlag(query) — Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
fieldKey(path, required) — 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](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `"key": "teams-add-on__team-issue-field"`
optionId(path, required) — The ID of the option to be deselected.
DELETE
/rest/api/3/field/{id}
Delete custom field
id(path, required) — The ID of a custom field.
POST
/rest/api/3/field/{id}/restore
Restore custom field from trash
id(path, required) — The ID of a custom field.
POST
/rest/api/3/field/{id}/trash
Move custom field to trash
id(path, required) — The ID of a custom field.
GET
/rest/api/3/fieldconfiguration
Get all field configurations
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
isDefault(query) — If *true* returns default field configurations only.
query(query) — The query string used to match against field configuration names and descriptions.
POST
/rest/api/3/fieldconfiguration
Create field configuration
DELETE
/rest/api/3/fieldconfiguration/{id}
Delete field configuration
id(path, required) — The ID of the field configuration.
PUT
/rest/api/3/fieldconfiguration/{id}
Update field configuration
id(path, required) — The ID of the field configuration.
GET
/rest/api/3/fieldconfiguration/{id}/fields
Get field configuration items
id(path, required) — The ID of the field configuration.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
PUT
/rest/api/3/fieldconfiguration/{id}/fields
Update field configuration items
id(path, required) — The ID of the field configuration.
GET
/rest/api/3/fieldconfigurationscheme/mapping
Get field configuration issue type items
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
fieldConfigurationSchemeId(query) — The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`.
GET
/rest/api/3/fieldconfigurationscheme/project
Get field configuration schemes for projects
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
projectId(query, required) — The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.
PUT
/rest/api/3/fieldconfigurationscheme/project
Assign field configuration scheme to project
DELETE
/rest/api/3/fieldconfigurationscheme/{id}
Delete field configuration scheme
id(path, required) — The ID of the field configuration scheme.
PUT
/rest/api/3/fieldconfigurationscheme/{id}
Update field configuration scheme
id(path, required) — The ID of the field configuration scheme.
PUT
/rest/api/3/fieldconfigurationscheme/{id}/mapping
Assign issue types to field configurations
id(path, required) — The ID of the field configuration scheme.
Remove issue types from field configuration scheme
id(path, required) — The ID of the field configuration scheme.
GET
/rest/api/3/filter
Get filters
expand(query) — Use [expand](#expansion) 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]`.
POST
/rest/api/3/filter
Create filter
expand(query) — Use [expand](#expansion) 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(query) — EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
GET
/rest/api/3/filter/defaultShareScope
Get default share scope
PUT
/rest/api/3/filter/defaultShareScope
Set default share scope
GET
/rest/api/3/filter/favourite
Get favorite filters
expand(query) — Use [expand](#expansion) 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]`.
GET
/rest/api/3/filter/my
Get my filters
expand(query) — Use [expand](#expansion) 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(query) — Include the user's favorite filters in the response.
GET
/rest/api/3/filter/search
Search for filters
filterName(query) — String used to perform a case-insensitive partial match with `name`.
accountId(query) — User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`.
owner(query) — This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with `accountId`.
groupname(query) — 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(query) — 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(query) — Project ID used to returns filters that are shared with a project that matches `sharePermissions.project.id`.
id(query) — 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(query) — [Order](#ordering) 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(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
expand(query) — Use [expand](#expansion) 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(query) — EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
DELETE
/rest/api/3/filter/{id}
Delete filter
id(path, required) — The ID of the filter to delete.
GET
/rest/api/3/filter/{id}
Get filter
id(path, required) — The ID of the filter to return.
expand(query) — Use [expand](#expansion) 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(query) — EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
PUT
/rest/api/3/filter/{id}
Update filter
id(path, required) — The ID of the filter to update.
expand(query) — Use [expand](#expansion) 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(query) — EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
DELETE
/rest/api/3/filter/{id}/columns
Reset columns
id(path, required) — The ID of the filter.
GET
/rest/api/3/filter/{id}/columns
Get columns
id(path, required) — The ID of the filter.
PUT
/rest/api/3/filter/{id}/columns
Set columns
id(path, required) — The ID of the filter.
DELETE
/rest/api/3/filter/{id}/favourite
Remove filter as favorite
id(path, required) — The ID of the filter.
expand(query) — Use [expand](#expansion) 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]`.
PUT
/rest/api/3/filter/{id}/favourite
Add filter as favorite
id(path, required) — The ID of the filter.
expand(query) — Use [expand](#expansion) 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]`.
PUT
/rest/api/3/filter/{id}/owner
Change filter owner
id(path, required) — The ID of the filter to update.
issueIdOrKey(path, required) — The ID or key of the issue.
worklogId(path, required) — The ID of the worklog.
propertyKey(path, required) — The key of the property.
POST
/rest/api/3/filter/{id}/permission
Add share permission
id(path, required) — The ID of the filter.
DELETE
/rest/api/3/filter/{id}/permission/{permissionId}
Delete share permission
id(path, required) — The ID of the filter.
permissionId(path, required) — The ID of the share permission.
GET
/rest/api/3/filter/{id}/permission/{permissionId}
Get share permission
id(path, required) — The ID of the filter.
permissionId(path, required) — The ID of the share permission.
DELETE
/rest/api/3/group
Remove group
groupname(query)
groupId(query) — The ID of the group. This parameter cannot be used with the `groupname` parameter.
swapGroup(query) — 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(query) — 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.
GET
/rest/api/3/group
Get group
groupname(query) — 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(query) — The ID of the group. This parameter cannot be used with the `groupName` parameter.
expand(query) — List of fields to expand.
POST
/rest/api/3/group
Create group
GET
/rest/api/3/group/bulk
Bulk get groups
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
groupId(query) — The ID of a group. To specify multiple IDs, pass multiple `groupId` parameters. For example, `groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5`.
groupName(query) — The name of a group. To specify multiple names, pass multiple `groupName` parameters. For example, `groupName=administrators&groupName=jira-software-users`.
accessType(query) — The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
applicationKey(query) — The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.
POST
/rest/api/3/issue
Create issue
updateHistory(query) — 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.
GET
/rest/api/3/group/member
Get users from group
groupname(query) — 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(query) — The ID of the group. This parameter cannot be used with the `groupName` parameter.
includeInactiveUsers(query) — Include inactive users.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
DELETE
/rest/api/3/group/user
Remove user from group
groupname(query) — 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(query) — The ID of the group. This parameter cannot be used with the `groupName` parameter.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query, required) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
POST
/rest/api/3/group/user
Add user to group
groupname(query) — 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(query) — The ID of the group. This parameter cannot be used with the `groupName` parameter.
GET
/rest/api/3/groups/picker
Find groups
accountId(query) — This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get).
query(query) — The string to find in group names.
exclude(query) — 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(query) — 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(query, limit) — 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(query) — Whether the search for groups should be case insensitive.
userName(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
GET
/rest/api/3/groupuserpicker
Find users and groups
query(query, required) — The search string.
maxResults(query, limit) — The maximum number of items to return in each list.
showAvatar(query) — Whether the user avatar should be returned. If an invalid value is provided, the default value is used.
fieldId(query) — The custom field ID of the field this request is for.
projectId(query) — 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(query) — 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(query) — The size of the avatar to return. If an invalid value is provided, the default value is used.
caseInsensitive(query) — Whether the search for groups should be case insensitive.
excludeConnectAddons(query) — Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.
issueIdOrKey(path, required) — The ID or key of the issue.
worklogId(path, required) — The ID of the worklog.
propertyKey(path, required) — The key of the issue property. The maximum length is 255 characters.
POST
/rest/api/3/issue/bulk
Bulk create issue
GET
/rest/api/3/issue/createmeta
Get create issue metadata
projectIds(query) — 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(query) — 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(query) — 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(query) — 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(query) — Use [expand](#expansion) 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](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
GET
/rest/api/3/issue/picker
Get issue picker suggestions
query(query) — A string to match against text fields in the issue such as title, description, or comments.
currentJQL(query) — 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(query) — The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
currentProjectId(query) — The ID of a project that suggested issues must belong to.
showSubTasks(query) — Indicate whether to include subtasks in the suggestions list.
showSubTaskParent(query) — When `currentIssueKey` is a subtask, whether to include the parent issue in the suggestions if it matches the query.
POST
/rest/api/3/issue/properties
Bulk set issues properties by list
POST
/rest/api/3/issue/properties/multi
Bulk set issue properties by issue
DELETE
/rest/api/3/issue/properties/{propertyKey}
Bulk delete issue property
propertyKey(path, required) — The key of the property.
PUT
/rest/api/3/issue/properties/{propertyKey}
Bulk set issue property
propertyKey(path, required) — The key of the property. The maximum length is 255 characters.
POST
/rest/api/3/issue/watching
Get is watching issue bulk
DELETE
/rest/api/3/issue/{issueIdOrKey}
Delete issue
issueIdOrKey(path, required) — The ID or key of the issue.
deleteSubtasks(query) — Whether the issue's subtasks are deleted when the issue is deleted.
issueIdOrKey(path, required) — The ID or key of the issue.
linkId(path, required) — The ID of the remote issue link.
GET
/rest/api/3/issue/{issueIdOrKey}
Get issue
issueIdOrKey(path, required) — The ID or key of the issue.
fields(query) — 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)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields.
fieldsByKeys(query) — 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(query) — Use [expand](#expansion) 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(query) — 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(query) — 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](#api-rest-api-3-search-get) `lastViewed` field.
PUT
/rest/api/3/issue/{issueIdOrKey}
Edit issue
issueIdOrKey(path, required) — The ID or key of the issue.
notifyUsers(query) — 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(query) — 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(query) — 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).
PUT
/rest/api/3/issue/{issueIdOrKey}/assignee
Assign issue
issueIdOrKey(path, required) — The ID or key of the issue to be assigned.
POST
/rest/api/3/issue/{issueIdOrKey}/attachments
Add attachment
issueIdOrKey(path, required) — The ID or key of the issue that attachments are added to.
GET
/rest/api/3/issue/{issueIdOrKey}/changelog
Get changelogs
issueIdOrKey(path, required) — The ID or key of the issue.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
POST
/rest/api/3/issue/{issueIdOrKey}/changelog/list
Get changelogs by IDs
issueIdOrKey(path, required) — The ID or key of the issue.
issueIdOrKey(path, required) — The ID or key of the issue.
linkId(path, required) — The ID of the remote issue link.
GET
/rest/api/3/issue/{issueIdOrKey}/comment
Get comments
issueIdOrKey(path, required) — The ID or key of the issue.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
orderBy(query) — [Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.
expand(query) — Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.
POST
/rest/api/3/issue/{issueIdOrKey}/comment
Add comment
issueIdOrKey(path, required) — The ID or key of the issue.
expand(query) — Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.
DELETE
/rest/api/3/issue/{issueIdOrKey}/comment/{id}
Delete comment
issueIdOrKey(path, required) — The ID or key of the issue.
id(path, required) — The ID of the comment.
GET
/rest/api/3/issue/{issueIdOrKey}/comment/{id}
Get comment
issueIdOrKey(path, required) — The ID or key of the issue.
id(path, required) — The ID of the comment.
expand(query) — Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.
PUT
/rest/api/3/issue/{issueIdOrKey}/comment/{id}
Update comment
issueIdOrKey(path, required) — The ID or key of the issue.
id(path, required) — The ID of the comment.
notifyUsers(query) — Whether users are notified when a comment is updated.
overrideEditableFlag(query) — 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(query) — Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.
GET
/rest/api/3/issue/{issueIdOrKey}/editmeta
Get edit issue metadata
issueIdOrKey(path, required) — The ID or key of the issue.
overrideScreenSecurity(query) — 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(query) — 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).
POST
/rest/api/3/issue/{issueIdOrKey}/notify
Send notification for issue
issueIdOrKey(path, required) — ID or key of the issue that the notification is sent for.
GET
/rest/api/3/issue/{issueIdOrKey}/properties
Get issue property keys
issueIdOrKey(path, required) — The key or ID of the issue.
issueIdOrKey(path, required) — The ID or key of the issue.
linkId(path, required) — The ID of a remote issue link.
GET
/rest/api/3/issue/{issueIdOrKey}/transitions
Get transitions
issueIdOrKey(path, required) — The ID or key of the issue.
expand(query) — Use [expand](#expansion) 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](#api-rest-api-3-issue-issueIdOrKey-transitions-post).
transitionId(query) — The ID of the transition.
skipRemoteOnlyCondition(query) — Whether transitions with the condition *Hide From User Condition* are included in the response.
includeUnavailableTransitions(query) — Whether details of transitions that fail a condition are included in the response
sortByOpsBarAndStatus(query) — 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.
POST
/rest/api/3/issue/{issueIdOrKey}/transitions
Transition issue
issueIdOrKey(path, required) — The ID or key of the issue.
DELETE
/rest/api/3/issue/{issueIdOrKey}/votes
Delete vote
issueIdOrKey(path, required) — The ID or key of the issue.
GET
/rest/api/3/issue/{issueIdOrKey}/votes
Get votes
issueIdOrKey(path, required) — The ID or key of the issue.
POST
/rest/api/3/issue/{issueIdOrKey}/votes
Add vote
issueIdOrKey(path, required) — The ID or key of the issue.
DELETE
/rest/api/3/issue/{issueIdOrKey}/watchers
Delete watcher
issueIdOrKey(path, required) — The ID or key of the issue.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.
GET
/rest/api/3/issue/{issueIdOrKey}/watchers
Get issue watchers
issueIdOrKey(path, required) — The ID or key of the issue.
POST
/rest/api/3/issue/{issueIdOrKey}/watchers
Add watcher
issueIdOrKey(path, required) — The ID or key of the issue.
GET
/rest/api/3/issue/{issueIdOrKey}/worklog
Get issue worklogs
issueIdOrKey(path, required) — The ID or key of the issue.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
startedAfter(query) — The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
startedBefore(query) — The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.
expand(query) — Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts`properties`, which returns worklog properties.
POST
/rest/api/3/issue/{issueIdOrKey}/worklog
Add worklog
issueIdOrKey(path, required) — The ID or key the issue.
notifyUsers(query) — Whether users watching the issue are notified by email.
adjustEstimate(query) — 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(query) — 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(query) — 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(query) — Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties.
overrideEditableFlag(query) — 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](https://confluence.atlassian.com/x/x4dKLg) can use this flag.
DELETE
/rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Delete worklog
issueIdOrKey(path, required) — The ID or key of the issue.
id(path, required) — The ID of the worklog.
notifyUsers(query) — Whether users watching the issue are notified by email.
adjustEstimate(query) — 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(query) — 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(query) — 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(query) — 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.
GET
/rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Get worklog
issueIdOrKey(path, required) — The ID or key of the issue.
id(path, required) — The ID of the worklog.
expand(query) — Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties.
PUT
/rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Update worklog
issueIdOrKey(path, required) — The ID or key the issue.
id(path, required) — The ID of the worklog.
notifyUsers(query) — Whether users watching the issue are notified by email.
adjustEstimate(query) — 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(query) — 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(query) — Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties`, which returns worklog properties.
overrideEditableFlag(query) — 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](https://confluence.atlassian.com/x/x4dKLg) can use this flag.
issueIdOrKey(path, required) — The ID or key of the issue.
worklogId(path, required) — The ID of the worklog.
propertyKey(path, required) — The key of the property.
GET
/rest/api/3/issueLink/{linkId}
Get issue link
linkId(path, required) — The ID of the issue link.
GET
/rest/api/3/issueLinkType
Get issue link types
POST
/rest/api/3/issueLinkType
Create issue link type
DELETE
/rest/api/3/issueLinkType/{issueLinkTypeId}
Delete issue link type
issueLinkTypeId(path, required) — The ID of the issue link type.
GET
/rest/api/3/issueLinkType/{issueLinkTypeId}
Get issue link type
issueLinkTypeId(path, required) — The ID of the issue link type.
PUT
/rest/api/3/issueLinkType/{issueLinkTypeId}
Update issue link type
issueLinkTypeId(path, required) — The ID of the issue link type.
GET
/rest/api/3/issuesecurityschemes
Get issue security schemes
GET
/rest/api/3/issuesecurityschemes/{id}
Get issue security scheme
id(path, required) — The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs.
issueSecuritySchemeId(path, required) — The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
issueSecurityLevelId(query) — The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: `issueSecurityLevelId=10000&issueSecurityLevelId=10001`.
expand(query) — 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.
GET
/rest/api/3/issuetype
Get all issue types for user
POST
/rest/api/3/issuetype
Create issue type
POST
/rest/api/3/jql/pdcleaner
Convert user identifiers to account IDs in JQL queries
GET
/rest/api/3/issuetype/project
Get issue types for project
projectId(query, required) — The ID of the project.
level(query) — The level of the issue type to filter by. Use: * `-1` for Subtask. * `0` for Base. * `1` for Epic.
DELETE
/rest/api/3/issuetype/{id}
Delete issue type
id(path, required) — The ID of the issue type.
alternativeIssueTypeId(query) — The ID of the replacement issue type.
GET
/rest/api/3/issuetype/{id}
Get issue type
id(path, required) — The ID of the issue type.
PUT
/rest/api/3/issuetype/{id}
Update issue type
id(path, required) — The ID of the issue type.
GET
/rest/api/3/issuetype/{id}/alternatives
Get alternative issue types
id(path, required) — The ID of the issue type.
POST
/rest/api/3/issuetype/{id}/avatar2
Load issue type avatar
id(path, required) — The ID of the issue type.
x(query) — The X coordinate of the top-left corner of the crop region.
y(query) — The Y coordinate of the top-left corner of the crop region.
size(query, required, limit) — The length of each side of the crop region.
GET
/rest/api/3/issuetype/{issueTypeId}/properties
Get issue type property keys
issueTypeId(path, required) — The ID of the issue type.
issueTypeId(path, required) — The ID of the issue type.
propertyKey(path, required) — The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys.
issueTypeId(path, required) — The ID of the issue type.
propertyKey(path, required) — The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys.
issueTypeId(path, required) — The ID of the issue type.
propertyKey(path, required) — The key of the issue type property. The maximum length is 255 characters.
POST
/rest/api/3/jql/sanitize
Sanitize JQL queries
GET
/rest/api/3/issuetypescheme
Get all issue type schemes
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
orderBy(query) — [Order](#ordering) the results by a field: * `name` Sorts by issue type scheme name. * `id` Sorts by issue type scheme ID.
expand(query) — Use [expand](#expansion) 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(query) — String used to perform a case-insensitive partial match with issue type scheme name.
POST
/rest/api/3/issuetypescheme
Create issue type scheme
GET
/rest/api/3/issuetypescheme/mapping
Get issue type scheme items
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
issueTypeSchemeId(query) — The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `issueTypeSchemeId=10000&issueTypeSchemeId=10001`.
GET
/rest/api/3/issuetypescheme/project
Get issue type schemes for projects
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
projectId(query, required) — The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, `projectId=10000&projectId=10001`.
PUT
/rest/api/3/issuetypescheme/project
Assign issue type scheme to project
DELETE
/rest/api/3/issuetypescheme/{issueTypeSchemeId}
Delete issue type scheme
issueTypeSchemeId(path, required) — The ID of the issue type scheme.
PUT
/rest/api/3/issuetypescheme/{issueTypeSchemeId}
Update issue type scheme
issueTypeSchemeId(path, required) — The ID of the issue type scheme.
issueTypeSchemeId(path, required) — The ID of the issue type scheme.
issueTypeId(path, required) — The ID of the issue type.
GET
/rest/api/3/issuetypescreenscheme
Get issue type screen schemes
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
queryString(query) — String used to perform a case-insensitive partial match with issue type screen scheme name.
orderBy(query) — [Order](#ordering) the results by a field: * `name` Sorts by issue type screen scheme name. * `id` Sorts by issue type screen scheme ID.
expand(query) — Use [expand](#expansion) 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.
POST
/rest/api/3/issuetypescreenscheme
Create issue type screen scheme
GET
/rest/api/3/issuetypescreenscheme/mapping
Get issue type screen scheme items
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
issueTypeScreenSchemeId(query) — The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: `issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001`.
GET
/rest/api/3/issuetypescreenscheme/project
Get issue type screen schemes for projects
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
projectId(query, required) — The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.
issueTypeScreenSchemeId(path, required) — The ID of the issue type screen scheme.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
query(query)
GET
/rest/api/3/jql/autocompletedata
Get field reference data (GET)
POST
/rest/api/3/jql/autocompletedata
Get field reference data (POST)
GET
/rest/api/3/jql/autocompletedata/suggestions
Get field auto complete suggestions
fieldName(query) — The name of the field.
fieldValue(query) — The partial field item name entered by the user.
predicateName(query) — The name of the [ CHANGED operator predicate](https://confluence.atlassian.com/x/hQORLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for which the suggestions are generated. The valid predicate operators are *by*, *from*, and *to*.
predicateValue(query) — The partial predicate item name entered by the user.
GET
/rest/api/3/jql/function/computation
Get precomputation
functionKey(query)
startAt(query)
maxResults(query, limit)
orderBy(query)
filter(query)
POST
/rest/api/3/jql/function/computation
Update precomputations
POST
/rest/api/3/jql/match
Check issues against JQL
POST
/rest/api/3/jql/parse
Parse JQL query
validation(query) — 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.
projectKey(query) — The key of project. Ignored if `projectId` is provided.
projectId(query) — The ID of project.
issueKey(query) — The key of the issue. Ignored if `issueId` is provided.
issueId(query) — The ID of the issue.
permissions(query) — A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use [Get all permissions](#api-rest-api-3-permissions-get).
projectUuid(query)
projectConfigurationUuid(query)
commentId(query) — The ID of the comment.
DELETE
/rest/api/3/mypreferences
Delete preference
key(query, required) — The key of the preference.
GET
/rest/api/3/mypreferences
Get preference
key(query, required) — The key of the preference.
PUT
/rest/api/3/mypreferences
Set preference
key(query, required) — The key of the preference. The maximum length is 255 characters.
DELETE
/rest/api/3/mypreferences/locale
Delete locale
GET
/rest/api/3/mypreferences/locale
Get locale
PUT
/rest/api/3/mypreferences/locale
Set locale
GET
/rest/api/3/myself
Get current user
expand(query) — Use [expand](#expansion) 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.
GET
/rest/api/3/notificationscheme
Get notification schemes paginated
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of notification schemes IDs to be filtered by
projectId(query) — The list of projects IDs to be filtered by
onlyDefault(query) — 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(query) — Use [expand](#expansion) 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
POST
/rest/api/3/notificationscheme
Create notification scheme
GET
/rest/api/3/notificationscheme/project
Get projects using notification schemes paginated
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
notificationSchemeId(query) — The list of notifications scheme IDs to be filtered out
projectId(query) — The list of project IDs to be filtered out
GET
/rest/api/3/permissionscheme/{schemeId}
Get permission scheme
schemeId(path, required) — The ID of the permission scheme to return.
expand(query) — 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.
GET
/rest/api/3/notificationscheme/{id}
Get notification scheme
id(path, required) — The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) to get a list of notification scheme IDs.
expand(query) — Use [expand](#expansion) 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
PUT
/rest/api/3/notificationscheme/{id}
Update notification scheme
id(path, required) — The ID of the notification scheme.
PUT
/rest/api/3/notificationscheme/{id}/notification
Add notifications to notification scheme
id(path, required) — The ID of the notification scheme.
notificationSchemeId(path, required) — The ID of the notification scheme.
notificationId(path, required) — The ID of the notification.
GET
/rest/api/3/permissions
Get all permissions
POST
/rest/api/3/permissions/check
Get bulk permissions
POST
/rest/api/3/permissions/project
Get permitted projects
GET
/rest/api/3/permissionscheme
Get all permission schemes
expand(query) — 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.
POST
/rest/api/3/permissionscheme
Create permission scheme
expand(query) — 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.
DELETE
/rest/api/3/permissionscheme/{schemeId}
Delete permission scheme
schemeId(path, required) — The ID of the permission scheme being deleted.
PUT
/rest/api/3/permissionscheme/{schemeId}
Update permission scheme
schemeId(path, required) — The ID of the permission scheme to update.
expand(query) — 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.
schemeId(path, required) — The ID of the permission scheme.
expand(query) — 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.
schemeId(path, required) — The ID of the permission scheme in which to create a new permission grant.
expand(query) — 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.
schemeId(path, required) — The ID of the permission scheme.
permissionId(path, required) — The ID of the permission grant.
expand(query) — 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.
GET
/rest/api/3/priority
Get priorities
POST
/rest/api/3/priority
Create priority
PUT
/rest/api/3/priority/default
Set default priority
PUT
/rest/api/3/priority/move
Move priorities
GET
/rest/api/3/priority/search
Search priorities
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=2&id=3`.
onlyDefault(query) — Whether only the default priority is returned.
DELETE
/rest/api/3/priority/{id}
Delete priority
id(path, required) — The ID of the issue priority.
replaceWith(query, required) — The ID of the issue priority that will replace the currently selected resolution.
GET
/rest/api/3/priority/{id}
Get priority
id(path, required) — The ID of the issue priority.
PUT
/rest/api/3/priority/{id}
Update priority
id(path, required) — The ID of the issue priority.
GET
/rest/api/3/project
Get all projects
expand(query) — Use [expand](#expansion) 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(query) — 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(query) — A list of project properties to return for the project. This parameter accepts a comma-separated list.
POST
/rest/api/3/project
Create project
GET
/rest/api/3/project/recent
Get recent projects
expand(query) — Use [expand](#expansion) 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(query) — EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored.
GET
/rest/api/3/project/search
Get projects paginated
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
orderBy(query) — [Order](#ordering) the results by a field. * `category` Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-3-projectCategory-get). * `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(query) — 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(query) — 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(query) — Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive).
typeKey(query) — Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are `business`, `service_desk`, and `software`.
categoryId(query) — The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation.
action(query) — 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).
expand(query) — Use [expand](#expansion) 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(query) — EXPERIMENTAL. Filter results by project status: * `live` Search live projects. * `archived` Search archived projects. * `deleted` Search deleted projects, those in the recycle bin.
properties(query) — EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.
propertyQuery(query) — 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`.
GET
/rest/api/3/resolution
Get resolutions
GET
/rest/api/3/project/type
Get all project types
GET
/rest/api/3/project/type/accessible
Get licensed project types
GET
/rest/api/3/project/type/{projectTypeKey}
Get project type by key
projectTypeKey(path, required) — The key of the project type.
projectTypeKey(path, required) — The key of the project type.
DELETE
/rest/api/3/project/{projectIdOrKey}
Delete project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
enableUndo(query) — Whether this project is placed in the Jira recycle bin where it will be available for restoration.
GET
/rest/api/3/project/{projectIdOrKey}
Get project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
expand(query) — Use [expand](#expansion) 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(query) — A list of project properties to return for the project. This parameter accepts a comma-separated list.
PUT
/rest/api/3/project/{projectIdOrKey}
Update project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
expand(query) — Use [expand](#expansion) 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.
POST
/rest/api/3/project/{projectIdOrKey}/archive
Archive project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
PUT
/rest/api/3/project/{projectIdOrKey}/avatar
Set project avatar
projectIdOrKey(path, required) — The ID or (case-sensitive) key of the project.
DELETE
/rest/api/3/project/{projectIdOrKey}/avatar/{id}
Delete project avatar
projectIdOrKey(path, required) — The project ID or (case-sensitive) key.
id(path, required) — The ID of the avatar.
POST
/rest/api/3/project/{projectIdOrKey}/avatar2
Load project avatar
projectIdOrKey(path, required) — The ID or (case-sensitive) key of the project.
x(query) — The X coordinate of the top-left corner of the crop region.
y(query) — The Y coordinate of the top-left corner of the crop region.
size(query, limit) — The length of each side of the crop region.
GET
/rest/api/3/project/{projectIdOrKey}/avatars
Get all project avatars
projectIdOrKey(path, required) — The ID or (case-sensitive) key of the project.
GET
/rest/api/3/project/{projectIdOrKey}/component
Get project components paginated
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
orderBy(query) — [Order](#ordering) 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.
query(query) — Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive).
GET
/rest/api/3/project/{projectIdOrKey}/components
Get project components
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
POST
/rest/api/3/project/{projectIdOrKey}/delete
Delete project asynchronously
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
POST
/rest/api/3/resolution
Create resolution
PUT
/rest/api/3/resolution/default
Set default resolution
PUT
/rest/api/3/resolution/move
Move resolutions
GET
/rest/api/3/project/{projectIdOrKey}/features
Get project features
projectIdOrKey(path, required) — The ID or (case-sensitive) key of the project.
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
propertyKey(path, required) — The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys.
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
propertyKey(path, required) — The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys.
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
propertyKey(path, required) — The key of the project property. The maximum length is 255 characters.
POST
/rest/api/3/project/{projectIdOrKey}/restore
Restore deleted or archived project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
GET
/rest/api/3/project/{projectIdOrKey}/role
Get project roles for project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
GET
/rest/api/3/resolution/search
Search resolutions
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of resolutions IDs to be filtered out
onlyDefault(query) — When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false
DELETE
/rest/api/3/project/{projectIdOrKey}/role/{id}
Delete actors from project role
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
user(query) — The user account ID of the user to remove from the project role.
group(query) — 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(query) — The ID of the group to remove from the project role. This parameter cannot be used with the `group` parameter.
GET
/rest/api/3/project/{projectIdOrKey}/role/{id}
Get project role for project
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
newProjectTypeKey(path, required) — The key of the new project type.
GET
/rest/api/3/project/{projectIdOrKey}/version
Get project versions paginated
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
orderBy(query) — [Order](#ordering) 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(query) — Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive).
status(query) — 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(query) — Use [expand](#expansion) 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.
GET
/rest/api/3/project/{projectIdOrKey}/versions
Get project versions
projectIdOrKey(path, required) — The project ID or project key (case sensitive).
expand(query) — Use [expand](#expansion) to include additional information in the response. This parameter accepts `operations`, which returns actions that can be performed on the version.
GET
/rest/api/3/project/{projectId}/email
Get project's sender email
projectId(path, required) — The project ID.
PUT
/rest/api/3/project/{projectId}/email
Set project's sender email
projectId(path, required) — The project ID.
GET
/rest/api/3/project/{projectId}/hierarchy
Get project issue type hierarchy
projectId(path, required) — The ID of the project.
projectKeyOrId(path, required) — The project ID or project key (case sensitive).
DELETE
/rest/api/3/user/columns
Reset user default columns
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
projectKeyOrId(path, required) — The project ID or project key (case sensitive).
expand(query) — Use [expand](#expansion) 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
projectKeyOrId(path, required) — The project ID or project key (case sensitive).
expand(query) — Use [expand](#expansion) 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.
projectKeyOrId(path, required) — The project ID or project key (case sensitive).
expand(query) — Use [expand](#expansion) 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.
projectKeyOrId(path, required) — The project ID or project key (case sensitive).
GET
/rest/api/3/projectCategory
Get all project categories
POST
/rest/api/3/projectCategory
Create project category
DELETE
/rest/api/3/projectCategory/{id}
Delete project category
id(path, required) — ID of the project category to delete.
GET
/rest/api/3/projectCategory/{id}
Get project category by ID
id(path, required) — The ID of the project category.
PUT
/rest/api/3/projectCategory/{id}
Update project category
id(path, required)
GET
/rest/api/3/projectvalidate/key
Validate project key
key(query) — The project key.
GET
/rest/api/3/projectvalidate/validProjectKey
Get valid project key
key(query) — The project key.
GET
/rest/api/3/projectvalidate/validProjectName
Get valid project name
name(query, required) — The project name.
GET
/rest/api/3/role
Get all project roles
POST
/rest/api/3/role
Create project role
DELETE
/rest/api/3/role/{id}
Delete project role
id(path, required) — The ID of the project role to delete. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
swap(query) — The ID of the project role that will replace the one being deleted.
GET
/rest/api/3/role/{id}
Get project role by ID
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
POST
/rest/api/3/role/{id}
Partial update project role
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
PUT
/rest/api/3/role/{id}
Fully update project role
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
DELETE
/rest/api/3/role/{id}/actors
Delete default actors from project role
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
user(query) — The user account ID of the user to remove as a default actor.
groupId(query) — The group ID of the group to be removed as a default actor. This parameter cannot be used with the `group` parameter.
group(query) — 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.
GET
/rest/api/3/role/{id}/actors
Get default actors for project role
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
POST
/rest/api/3/role/{id}/actors
Add default actors to project role
id(path, required) — The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
GET
/rest/api/3/user/columns
Get user default columns
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
username(query) — This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
GET
/rest/api/3/screens
Get screens
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
queryString(query) — String used to perform a case-insensitive partial match with screen name.
scope(query) — The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, `scope=GLOBAL&scope=PROJECT`.
orderBy(query) — [Order](#ordering) the results by a field: * `id` Sorts by screen ID. * `name` Sorts by screen name.
pos(path, required) — The position of tab. The base index is 0.
PUT
/rest/api/3/user/columns
Set user default columns
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
GET
/rest/api/3/screenscheme
Get screen schemes
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
id(query) — The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
expand(query) — Use [expand](#expansion) 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(query) — String used to perform a case-insensitive partial match with screen scheme name.
orderBy(query) — [Order](#ordering) the results by a field: * `id` Sorts by screen scheme ID. * `name` Sorts by screen scheme name.
POST
/rest/api/3/screenscheme
Create screen scheme
DELETE
/rest/api/3/screenscheme/{screenSchemeId}
Delete screen scheme
screenSchemeId(path, required) — The ID of the screen scheme.
PUT
/rest/api/3/screenscheme/{screenSchemeId}
Update screen scheme
screenSchemeId(path, required) — The ID of the screen scheme.
GET
/rest/api/3/search
Search for issues using JQL (GET)
jql(query) — The [JQL](https://confluence.atlassian.com/x/egORLQ) 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(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — 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(query) — 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(query) — 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](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
expand(query) — Use [expand](#expansion) 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(query) — 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(query) — Reference fields by their key (rather than ID).
POST
/rest/api/3/search
Search for issues using JQL (POST)
GET
/rest/api/3/securitylevel/{id}
Get issue security level
id(path, required) — The ID of the issue security level.
GET
/rest/api/3/serverInfo
Get Jira instance info
GET
/rest/api/3/settings/columns
Get issue navigator default columns
PUT
/rest/api/3/settings/columns
Set issue navigator default columns
GET
/rest/api/3/status
Get all statuses
GET
/rest/api/3/status/{idOrName}
Get status
idOrName(path, required) — The ID or name of the status.
GET
/rest/api/3/statuscategory
Get all status categories
GET
/rest/api/3/statuscategory/{idOrKey}
Get status category
idOrKey(path, required) — The ID or key of the status category.
DELETE
/rest/api/3/statuses
Bulk delete Statuses
id(query) — 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`
GET
/rest/api/3/statuses
Bulk get statuses
expand(query) — Use [expand](#expansion) 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.
id(query) — 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`
POST
/rest/api/3/statuses
Bulk create statuses
PUT
/rest/api/3/statuses
Bulk update statuses
GET
/rest/api/3/statuses/search
Search statuses paginated
expand(query) — Use [expand](#expansion) 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.
projectId(query) — The project the status is part of or null for global statuses.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
searchString(query) — Term to match status names against or null to search for all statuses in the search scope.
statusCategory(query) — Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`.
GET
/rest/api/3/task/{taskId}
Get task
taskId(path, required) — The ID of the task.
POST
/rest/api/3/task/{taskId}/cancel
Cancel task
taskId(path, required) — The ID of the task.
GET
/rest/api/3/uiModifications
Get UI modifications
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
expand(query) — 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.
POST
/rest/api/3/uiModifications
Create UI modification
DELETE
/rest/api/3/uiModifications/{uiModificationId}
Delete UI modification
uiModificationId(path, required) — The ID of the UI modification.
PUT
/rest/api/3/uiModifications/{uiModificationId}
Update UI modification
uiModificationId(path, required) — The ID of the UI modification.
GET
/rest/api/3/user/email
Get user email
accountId(query, required) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.
type(path, required) — The icon type of the avatar.
entityId(path, required) — The ID of the project or issue type the avatar belongs to.
size(query, limit) — The size of the avatar image. If not provided the default size is returned.
format(query) — The format to return the avatar image in. If not provided the original content format is returned.
DELETE
/rest/api/3/user
Delete user
accountId(query, required) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
key(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
GET
/rest/api/3/user
Get user
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details.
key(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details.
expand(query) — Use [expand](#expansion) 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.
POST
/rest/api/3/user
Create user
GET
/rest/api/3/user/assignable/multiProjectSearch
Find users assignable to projects
query(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(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query) — A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.
projectKeys(query, required) — A list of project keys (case sensitive). This parameter accepts a comma-separated list.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
GET
/rest/api/3/user/assignable/search
Find users assignable to issues
query(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(query) — The sessionId of this request. SessionId is the same until the assignee is set.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query) — A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.
project(query) — The project ID or project key (case sensitive). Required, unless `issueKey` is specified.
issueKey(query) — The key of the issue. Required, unless `project` is specified.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — 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(query) — The ID of the transition.
recommend(query)
GET
/rest/api/3/user/bulk
Bulk get users
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
username(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
key(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query, required) — The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.
GET
/rest/api/3/user/bulk/migration
Get account IDs for users
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
username(query) — 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(query) — 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.
GET
/rest/api/3/user/email/bulk
Get user email bulk
accountId(query, required) — 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).
GET
/rest/api/3/user/groups
Get user groups
accountId(query, required) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
username(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
key(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
GET
/rest/api/3/user/permission/search
Find users with permissions
query(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(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query) — A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.
permissions(query, required) — A comma separated list of permissions. Permissions can be specified as any: * permission returned by [Get all permissions](#api-rest-api-3-permissions-get). * 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(query) — The issue key for the issue.
projectKey(query) — The project key for the project (case sensitive).
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
GET
/rest/api/3/user/picker
Find users for picker
query(query, required) — 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(query, limit) — The maximum number of items to return. The total number of matched users is returned in `total`.
showAvatar(query) — Include the URI to the user's avatar.
exclude(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
excludeAccountIds(query) — 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(query)
excludeConnectUsers(query)
GET
/rest/api/3/user/properties
Get user property keys
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
userKey(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
username(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
DELETE
/rest/api/3/user/properties/{propertyKey}
Delete user property
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
userKey(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
username(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
propertyKey(path, required) — The key of the user's property.
addonKey(path, required) — The key of the app, as defined in its descriptor.
propertyKey(path, required) — The key of the property.
GET
/rest/api/3/user/properties/{propertyKey}
Get user property
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
userKey(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
username(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
propertyKey(path, required) — The key of the user's property.
PUT
/rest/api/3/user/properties/{propertyKey}
Set user property
accountId(query) — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
userKey(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
username(query) — This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
propertyKey(path, required) — The key of the user's property. The maximum length is 255 characters.
GET
/rest/api/3/user/search
Find users
query(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(query)
accountId(query) — A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.
startAt(query) — The index of the first item to return in a page of filtered results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
property(query) — 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.
GET
/rest/api/3/user/search/query
Find users by query
query(query, required) — The search query.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
GET
/rest/api/3/user/search/query/key
Find user keys by query
query(query, required) — The search query.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
GET
/rest/api/3/user/viewissue/search
Find users with browse permission
query(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(query) — This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
accountId(query) — A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.
issueKey(query) — The issue key for the issue. Required, unless `projectKey` is specified.
projectKey(query) — The project key for the project (case sensitive). Required, unless `issueKey` is specified.
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
GET
/rest/api/3/version/{id}/relatedIssueCounts
Get version's related issues count
id(path, required) — The ID of the version.
POST
/rest/api/3/version/{id}/removeAndSwap
Delete and replace version
id(path, required) — The ID of the version.
GET
/rest/api/3/version/{id}/unresolvedIssueCount
Get version's unresolved issues count
id(path, required) — The ID of the version.
DELETE
/rest/api/3/webhook
Delete webhooks by ID
GET
/rest/api/3/users
Get all users default
startAt(query) — The index of the first item to return.
maxResults(query, limit) — The maximum number of items to return.
GET
/rest/api/3/users/search
Get all users
startAt(query) — The index of the first item to return.
maxResults(query, limit) — The maximum number of items to return.
POST
/rest/api/3/version
Create version
DELETE
/rest/api/3/version/{id}
Delete version
id(path, required) — The ID of the version.
moveFixIssuesTo(query) — 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(query) — 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.
GET
/rest/api/3/version/{id}
Get version
id(path, required) — The ID of the version.
expand(query) — Use [expand](#expansion) 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*.
PUT
/rest/api/3/version/{id}
Update version
id(path, required) — The ID of the version.
PUT
/rest/api/3/version/{id}/mergeto/{moveIssuesTo}
Merge versions
id(path, required) — The ID of the version to delete.
moveIssuesTo(path, required) — The ID of the version to merge into.
POST
/rest/api/3/version/{id}/move
Move version
id(path, required) — The ID of the version to be moved.
GET
/rest/api/3/webhook
Get dynamic webhooks for app
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
POST
/rest/api/3/webhook
Register dynamic webhooks
GET
/rest/api/3/webhook/failed
Get failed webhooks
maxResults(query, limit) — 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(query) — The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch.
PUT
/rest/api/3/webhook/refresh
Extend webhook life
GET
/rest/api/3/workflow
Get all workflows
workflowName(query) — The name of the workflow to be returned. Only one workflow can be specified.
POST
/rest/api/3/workflow
Create workflow
GET
/rest/api/3/workflow/rule/config
Get workflow transition rule configurations
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
types(query, required) — The types of the transition rules to return.
keys(query) — The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
workflowNames(query) — EXPERIMENTAL: The list of workflow names to filter by.
withTags(query) — EXPERIMENTAL: The list of `tags` to filter by.
draft(query) — EXPERIMENTAL: Whether draft or published workflows are returned. If not provided, both workflow types are returned.
expand(query) — Use [expand](#expansion) 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.
PUT
/rest/api/3/workflow/rule/config
Update workflow transition rule configurations
PUT
/rest/api/3/workflow/rule/config/delete
Delete workflow transition rule configurations
GET
/rest/api/3/workflow/search
Get workflows paginated
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
workflowName(query) — The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, `workflowName=name1&workflowName=name2`.
expand(query) — Use [expand](#expansion) 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(query) — String used to perform a case-insensitive partial match with workflow name.
orderBy(query) — [Order](#ordering) the results by a field: * `name` Sorts by workflow name. * `created` Sorts by create time. * `updated` Sorts by update time.
isActive(query) — Filters active and inactive workflows.
transitionId(path, required) — 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(query, required) — The name of the transition property to delete, also known as the name of the property.
workflowName(query, required) — The name of the workflow that the transition belongs to.
workflowMode(query) — The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited.
transitionId(path, required) — 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(query) — 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(query) — 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(query, required) — The name of the workflow that the transition belongs to.
workflowMode(query) — The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.
transitionId(path, required) — 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(query, required) — 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(query, required) — The name of the workflow that the transition belongs to.
workflowMode(query) — The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited.
transitionId(path, required) — 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(query, required) — 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(query, required) — The name of the workflow that the transition belongs to.
workflowMode(query) — The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited.
DELETE
/rest/api/3/workflow/{entityId}
Delete inactive workflow
entityId(path, required) — The entity ID of the workflow.
GET
/rest/api/3/workflowscheme/{id}/default
Get default workflow
id(path, required) — The ID of the workflow scheme.
returnDraftIfExists(query) — 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.
GET
/rest/api/3/workflowscheme
Get all workflow schemes
startAt(query) — The index of the first item to return in a page of results (page offset).
maxResults(query, limit) — The maximum number of items to return per page.
POST
/rest/api/3/workflowscheme
Create workflow scheme
GET
/rest/api/3/workflowscheme/project
Get workflow scheme project associations
projectId(query, required) — 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`.
PUT
/rest/api/3/workflowscheme/project
Assign workflow scheme to project
DELETE
/rest/api/3/workflowscheme/{id}
Delete workflow scheme
id(path, required) — 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*.
GET
/rest/api/3/workflowscheme/{id}
Get workflow scheme
id(path, required) — 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(query) — 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.
PUT
/rest/api/3/workflowscheme/{id}
Update workflow scheme
id(path, required) — 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*.
POST
/rest/api/3/workflowscheme/{id}/createdraft
Create draft workflow scheme
id(path, required) — The ID of the active workflow scheme that the draft is created from.
DELETE
/rest/api/3/workflowscheme/{id}/default
Delete default workflow
id(path, required) — The ID of the workflow scheme.
updateDraftIfNeeded(query) — 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`.
PUT
/rest/api/3/workflowscheme/{id}/default
Update default workflow
id(path, required) — The ID of the workflow scheme.
DELETE
/rest/api/3/workflowscheme/{id}/draft
Delete draft workflow scheme
id(path, required) — The ID of the active workflow scheme that the draft was created from.
GET
/rest/api/3/workflowscheme/{id}/draft
Get draft workflow scheme
id(path, required) — The ID of the active workflow scheme that the draft was created from.
PUT
/rest/api/3/workflowscheme/{id}/draft
Update draft workflow scheme
id(path, required) — The ID of the active workflow scheme that the draft was created from.
DELETE
/rest/api/3/workflowscheme/{id}/draft/default
Delete draft default workflow
id(path, required) — The ID of the workflow scheme that the draft belongs to.
GET
/rest/api/3/workflowscheme/{id}/draft/default
Get draft default workflow
id(path, required) — The ID of the workflow scheme that the draft belongs to.
PUT
/rest/api/3/workflowscheme/{id}/draft/default
Update draft default workflow
id(path, required) — The ID of the workflow scheme that the draft belongs to.
id(path, required) — The ID of the workflow scheme.
issueType(path, required) — The ID of the issue type.
updateDraftIfNeeded(query) — 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`.
id(path, required) — The ID of the workflow scheme.
issueType(path, required) — The ID of the issue type.
returnDraftIfExists(query) — 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.
id(path, required) — The ID of the workflow scheme.
issueType(path, required) — The ID of the issue type.
DELETE
/rest/api/3/workflowscheme/{id}/workflow
Delete issue types for workflow in workflow scheme
id(path, required) — The ID of the workflow scheme.
workflowName(query, required) — The name of the workflow.
updateDraftIfNeeded(query) — 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`.
GET
/rest/api/3/workflowscheme/{id}/workflow
Get issue types for workflows in workflow scheme
id(path, required) — The ID of the workflow scheme.
workflowName(query) — The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
returnDraftIfExists(query) — 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.
PUT
/rest/api/3/workflowscheme/{id}/workflow
Set issue types for workflow in workflow scheme
id(path, required) — The ID of the workflow scheme.
workflowName(query, required) — The name of the workflow.
GET
/rest/api/3/worklog/deleted
Get IDs of deleted worklogs
since(query) — The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned.
POST
/rest/api/3/worklog/list
Get worklogs
expand(query) — Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog.
GET
/rest/api/3/worklog/updated
Get IDs of updated worklogs
since(query) — The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned.
expand(query) — Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog.
addonKey(path, required) — The key of the app, as defined in its descriptor.
propertyKey(path, required) — The key of the property.
DELETE
/rest/atlassian-connect/1/app/module/dynamic
Remove modules
moduleKey(query) — 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.
GET
/rest/atlassian-connect/1/app/module/dynamic
Get modules
POST
/rest/atlassian-connect/1/app/module/dynamic
Register modules
PUT
/rest/atlassian-connect/1/migration/field
Bulk update custom field value
Atlassian-Transfer-Id(header, required) — The ID of the transfer.
