Jira

Learn how to use Jira with Composio

Overview

Enum

JIRA

Description

A tool for bug tracking, issue tracking, and agile project management.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read:jira-work,write:jira-work,manage:jira-project,manage:jira-configuration,read:jira-user,manage:jira-webhook,manage:jira-data-provider,read:servicedesk-request,manage:servicedesk-customer,write:servicedesk-request,read:servicemanagement-insight-objects,offline_access
Base64_Encode
stringRequired
your-domain
stringRequired

Actions

Sets default values for custom fields in contexts like date, options, and forge types. one default per request; set to null to unset. admin rights needed.

Action Parameters

fieldId
stringRequired
defaultValues
array

Action Response

data
object
successful
boolean
error

This tool transforms jql queries with usernames or user keys to ones using account ids for gdpr compliance. important for systems storing jqls. access to jira is necessary. see the migration guide for gdpr changes.

Action Parameters

queryStrings
array

Action Response

data
object
successful
boolean
error

Screen schemes in classic projects can be deleted unless linked to an issue type screen scheme. admin jira global permission is needed.

Action Parameters

screenSchemeId
stringRequired

Action Response

data
object
successful
boolean
error

Bulk edit dashboards. maximum number of dashboards to be edited at the same time is 100. permissions required: none the dashboards to be updated must be owned by the user, or the user must be an administrator.

Action Parameters

action
stringRequired
changeOwnerDetails__autofixName
boolean
changeOwnerDetails__newOwner
string
entityIds
arrayRequired
extendAdminPermissions
boolean
permissionDetails__editPermissions
array
permissionDetails__sharePermissions
array

Action Response

data
object
successful
boolean
error

Retrieves project role details and associated actors, ordered by name. use ‘get user’ with ‘groups’ parameter to confirm user-role membership. anonymous access allowed. requires ‘administer projects’ or ‘administer jira’ permissions.

Action Parameters

projectIdOrKey
stringRequired
id
integerRequired
excludeInactiveUsers
boolean

Action Response

data
object
successful
boolean
error

A workflow can only be deleted if it’s not active, a system workflow, or linked to any (draft) workflow scheme. administer jira global permissions required.

Action Parameters

entityId
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a field configuration scheme, applicable only in company-managed projects. requires ‘administer jira’ global permission.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieve the attributes of given service registries. permissions required: only connect apps can make this request and the servicesids belong to the tenant you are requesting

Action Parameters

serviceIds
arrayRequired

Action Response

data
object
successful
boolean
error

Returns information about the jira instance. this operation can be accessed anonymously. permissions required: none.

Action Parameters

Action Response

data
object
successful
boolean
error

Creates a workflow scheme. permissions required: administer jira global permission.

Action Parameters

description
string
defaultWorkflow
string
draft
boolean
id
integer
issueTypeMappings
object
issueTypes
object
lastModified
string
lastModifiedUser__accountId
string
lastModifiedUser__accountType
string
lastModifiedUser__active
boolean
lastModifiedUser__applicationRoles__items
array
lastModifiedUser__applicationRoles__max__results
integer
lastModifiedUser__applicationRoles__size
integer
lastModifiedUser__avatarUrls__16x16
string
lastModifiedUser__avatarUrls__24x24
string
lastModifiedUser__avatarUrls__32x32
string
lastModifiedUser__avatarUrls__48x48
string
lastModifiedUser__displayName
string
lastModifiedUser__emailAddress
string
lastModifiedUser__expand
string
lastModifiedUser__groups__items
array
lastModifiedUser__groups__max__results
integer
lastModifiedUser__groups__size
integer
lastModifiedUser__key
string
lastModifiedUser__locale
string
lastModifiedUser__name
string
lastModifiedUser__self
string
lastModifiedUser__timeZone
string
name
string
originalDefaultWorkflow
string
originalIssueTypeMappings
object
self
string
updateDraftIfNeeded
boolean

Action Response

data
object
successful
boolean
error

Sets default issue priority. permissions required: administer jira global permission.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The function provides a pageable list of mappings between context and projects for a custom field, filterable by contextid. requires the administer jira global permission. invalid ids are discarded.

Action Parameters

fieldId
stringRequired
contextId
array
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Lists recently failed webhook delivery attempts to connect apps within 72 hours, using cursor pagination. returns oldest failure first; use failedafter or provided url for next page.

Action Parameters

maxResults
integer
after
integer

Action Response

data
object
successful
boolean
error

Assigned a permission scheme to a project. for details, visit the provided links. requires “administer jira” global permission.

Action Parameters

projectKeyOrId
stringRequired
expand
string
id
integerRequired

Action Response

data
object
successful
boolean
error

Use jql to search for issues; a get version exists for brief queries. anonymous access is available. requires ‘browse projects’ permission and, if applicable, issue-level security permission.

Action Parameters

expand
array
fields
array
fieldsByKeys
boolean
jql
string
maxResults
integerDefaults to 50
properties
array
startAt
integer
validateQuery
string

Action Response

data
object
successful
boolean
error

Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key. permissions required: none.

Action Parameters

key
string

Action Response

data
object
successful
boolean
error

The text describes that only members with issue security levels from classic projects are returned. administering jira global permission is required for access.

Action Parameters

issueSecuritySchemeId
integerRequired
startAt
integer
maxResults
integerDefaults to 50
issueSecurityLevelId
array
expand
string

Action Response

data
object
successful
boolean
error

To delete a comment in a project, one needs ‘browse projects’ permission, appropriate issue-level security, ‘delete all comments’ or ‘delete own comments’ permission, and suitable visibility group access.

Action Parameters

issueIdOrKey
stringRequired
id
stringRequired

Action Response

data
object
successful
boolean
error

Fetches a paginated list of select list issue field options added by connect apps. not for jira-created options. requires administer jira permission; no jira permissions needed for the app’s field.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
fieldKey
stringRequired

Action Response

data
object
successful
boolean
error

Updates a screen. only screens used in classic projects can be updated. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

The api allows users to customize app dashboard gadgets and provides item ids but lacks resource for item management. it supports anonymous access for owners or permitted users.

Action Parameters

dashboardId
stringRequired
itemId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Removes a permission grant from a scheme; requires administer jira global permission. details: about permission schemes and grants.

Action Parameters

schemeId
integerRequired
permissionId
integerRequired

Action Response

data
object
successful
boolean
error

This operation provides issue type metadata for a project to help with issue creation requests and can be used without login. create issues permission in the project is required.

Action Parameters

projectIdOrKey
stringRequired
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Returns a paginated list of groups. permissions required: browse users and groups global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
groupId
array
groupName
array
accessType
string
applicationKey
string

Action Response

data
object
successful
boolean
error

Provides a list of all atlassian account users with privacy filters applied based on preferences, which might hide emails. requires “browse users and groups” permission. more info on profile visibility is available.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Returns all permission grants for a permission scheme. permissions required: permission to access jira.

Action Parameters

schemeId
integerRequired
expand
string

Action Response

data
object
successful
boolean
error

Deletes a screen. a screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. only screens used in classic projects can be deleted.

Action Parameters

screenId
integerRequired

Action Response

data
object
successful
boolean
error

Search tool matches users/groups with query, insensitive for users but sensitive for groups. supports detailed searches with result highlighting. anonymous use allowed, but specific permission required.

Action Parameters

query
stringRequired
maxResults
integerDefaults to 50
showAvatar
boolean
fieldId
string
projectId
array
issueTypeId
array
avatarSize
stringDefaults to xsmall
caseInsensitive
boolean
excludeConnectAddons
boolean

Action Response

data
object
successful
boolean
error

Returns the default project or issue type avatar image. this operation can be accessed anonymously. permissions required: none.

Action Parameters

type
stringRequired
size
string
format
string

Action Response

data
object
successful
boolean
error

The operation allows anonymous access to issue types. users with administer jira permission can see all types; those with browse projects see types linked to accessible projects.

Action Parameters

Action Response

data
object
successful
boolean
error

Workflow schemes are designated to classic projects without issues by users with the ‘administer jira’ global permission.

Action Parameters

projectId
stringRequired
workflowSchemeId
string

Action Response

data
object
successful
boolean
error

Jira now allows the creator app (connect or forge) to update workflow transition rules, such as post functions, conditions, validators, disable rules, and add tags, with default enabled status and restricted to authorized apps.

Action Parameters

workflows
arrayRequired

Action Response

data
object
successful
boolean
error

Removes a user from jira’s user base if successful. does not affect their atlassian account. site admin permissions required.

Action Parameters

accountId
stringRequired
username
string
key
string

Action Response

data
object
successful
boolean
error

Returns all project types, whether or not the instance has a valid license for each type. this operation can be accessed anonymously. permissions required: none.

Action Parameters

Action Response

data
object
successful
boolean
error

Fetches a paginated list of project versions; for a full list without pagination, use the get project versions resource. anonymous access allowed but requires browse projects permission.

Action Parameters

projectIdOrKey
stringRequired
startAt
integer
maxResults
integerDefaults to 50
orderBy
string
query
string
status
string
expand
string

Action Response

data
object
successful
boolean
error

The operation retrieves a status linked to an active workflow, prioritizing the first status found if multiple have the same name. status can be fetched by id for specificity. no permissions needed; anonymous access allowed.

Action Parameters

idOrName
stringRequired

Action Response

data
object
successful
boolean
error

Removes a dashboard gadget from a dashboard. when a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position. permissions required: none.

Action Parameters

dashboardId
integerRequired
gadgetId
integerRequired

Action Response

data
object
successful
boolean
error

Returns a user’s email address. this api is only available to apps approved by atlassian, according to these guidelines.

Action Parameters

accountId
arrayRequired

Action Response

data
object
successful
boolean
error

Asynchronously deletes an issue resolution. track the task status through the ‘location’ link response and use ‘get task’ for updates. administer jira global permission is required.

Action Parameters

id
stringRequired
replaceWith
stringRequired

Action Response

data
object
successful
boolean
error

Returns the list of all issue priorities. permissions required: permission to access jira.

Action Parameters

Action Response

data
object
successful
boolean
error

The text outlines the process to assign an issue type scheme to a classic jira project, noting that it fails if there are issues with types not in the new scheme. admin rights are required.

Action Parameters

issueTypeSchemeId
stringRequired
projectId
stringRequired

Action Response

data
object
successful
boolean
error

Validates a project key by confirming the key is a valid string and not in use. permissions required: none.

Action Parameters

key
string

Action Response

data
object
successful
boolean
error

Returns the default issue table columns for a user. if no accountid is provided, the caller’s details are returned. admin rights are needed to retrieve any user’s details; jira access is required for one’s own details.

Action Parameters

accountId
string
username
string

Action Response

data
object
successful
boolean
error

Summary: the text provides a link to the issue security scheme for a project and states that one needs either ‘administer jira’ global permission or ‘administer projects’ project permission to access it.

Action Parameters

projectKeyOrId
stringRequired

Action Response

data
object
successful
boolean
error

Creates an issue resolution. permissions required: administer jira global permission.

Action Parameters

description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

This function retrieves all property keys for a user but excludes jira-specific user properties. admin global permission is required for any user’s keys, while jira access is needed for one’s own keys.

Action Parameters

accountId
string
userKey
string
username
string

Action Response

data
object
successful
boolean
error

Adds a user to a group. permissions required: site administration (that is, member of the site-admin group).

Action Parameters

groupname
string
groupId
string
accountId
string
name
string

Action Response

data
object
successful
boolean
error

Updates an issue priority. permissions required: administer jira global permission.

Action Parameters

id
stringRequired
description
string
iconUrl
string
name
string
statusColor
string

Action Response

data
object
successful
boolean
error

Deletes a custom avatar from a project. note that system avatars cannot be deleted. permissions required: administer projects project permission.

Action Parameters

projectIdOrKey
stringRequired
id
integerRequired

Action Response

data
object
successful
boolean
error

Fetches a paginated list of comments by id, accessible anonymously if the user has relevant project permissions, issue-level security access, and visibility group or role rights.

Action Parameters

expand
string
ids
arrayRequired

Action Response

data
object
successful
boolean
error

Retrieve a paginated list of filters anonymously. filters can be fetched by ‘id’ or by matching multiple attributes. results are limited to filters owned, shared with user’s group or project, or public filters. no specific permissions needed.

Action Parameters

filterName
string
accountId
string
owner
string
groupname
string
groupId
string
projectId
integer
id
array
orderBy
stringDefaults to name
startAt
integer
maxResults
integerDefaults to 50
expand
string
overrideSharePermissions
boolean

Action Response

data
object
successful
boolean
error

De-select and replace select-list options on issues via jql query. only for options added by connect apps. requires administer jira permission to override security. asynchronous operation with a task link provided. not for jira-native field options.

Action Parameters

replaceWith
integer
jql
string
overrideScreenSecurity
boolean
overrideEditableFlag
boolean
fieldKey
stringRequired
optionId
integerRequired

Action Response

data
object
successful
boolean
error

Creates a new project version; accessible without login. requires either administer jira global permission or administer projects project-specific permission.

Action Parameters

description
string
approvers
array
archived
boolean
driver
string
expand
string
id
string
issuesStatusForFixVersion__done
integer
issuesStatusForFixVersion__inProgress
integer
issuesStatusForFixVersion__toDo
integer
issuesStatusForFixVersion__unmapped
integer
moveUnfixedIssuesTo
string
name
string
operations
array
overdue
boolean
project
string
projectId
integer
releaseDate
string
released
boolean
self
string
startDate
string
userReleaseDate
string
userStartDate
string

Action Response

data
object
successful
boolean
error

This operation retrieves both system and custom avatars for projects or issue types, accessible even anonymously. custom avatars require the “browse projects” permission for the relevant project or issue type. system avatars require no permissions.

Action Parameters

type
stringRequired
entityId
stringRequired

Action Response

data
object
successful
boolean
error

Updated project details via a request with optional parameters; schemes update only when included. admin jira global permission needed for schemes or project key changes; otherwise, admin projects permission suffices.

Action Parameters

projectIdOrKey
stringRequired
expand
string
description
string
assigneeType
string
avatarId
integer
categoryId
integer
issueSecurityScheme
integer
key
string
lead
string
leadAccountId
string
name
string
notificationScheme
integer
permissionScheme
integer
url
string

Action Response

data
object
successful
boolean
error

Returns a workflow scheme. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
returnDraftIfExists
boolean

Action Response

data
object
successful
boolean
error

Deletes an avatar from a project or issue type. permissions required: administer jira global permission.

Action Parameters

type
stringRequired
owningObjectId
stringRequired
id
integerRequired

Action Response

data
object
successful
boolean
error

Updates up to 10k issues with ≤10 properties per issue in json format. single property capped at 32,768 chars. allows anonymous use, transactional and async. needs ‘browse projects,’ ‘edit issues,’ and issue security view permissions.

Action Parameters

entitiesIds
array
properties
object

Action Response

data
object
successful
boolean
error

This operation removes issue types from field configuration schemes in classic projects and requires ‘administer jira’ global permissions.

Action Parameters

id
integerRequired
issueTypeIds
arrayRequired

Action Response

data
object
successful
boolean
error

Jira cloud project roles let users customize member associations per project, affecting permissions and workflows. “actors” are users/groups in roles, adjustable by admins either as defaults or per project.

Action Parameters

Action Response

data
object
successful
boolean
error

The text provides a link for obtaining a paginated list of field configuration schemes specific to classic projects, with a requirement of the ‘administer jira’ global permission for access.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
id
array

Action Response

data
object
successful
boolean
error

Moves a screen tab field. if after and position are provided in the request, position is ignored. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
tabId
integerRequired
id
stringRequired
after
string
position
string

Action Response

data
object
successful
boolean
error

The function retrieves voting information for a jira issue if voting is enabled. anonymous access is possible with requisite permissions, yet voter details are hidden from users without “view voters and watchers” permission.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Creates a screen scheme. permissions required: administer jira global permission.

Action Parameters

description
string
name
stringRequired
screens__create
integer
screens__default
integer
screens__edit
integer
screens__view
integer

Action Response

data
object
successful
boolean
error

Generates a paginated list of field config issues for classic projects. requires ‘administer jira’ global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
fieldConfigurationSchemeId
array

Action Response

data
object
successful
boolean
error

Deprecated method returns either a single workflow or all jira workflows; use “get workflows paginated” instead. requires “administer jira” global permission. if workflowname is given, a single object is returned, otherwise an array.

Action Parameters

workflowName
string

Action Response

data
object
successful
boolean
error

Summarizes filter share permissions: filters can be shared with user-owned groups, projects, logged-in users, or public. they can be accessed without login but only show if relevant to the user based on ownership or group/project membership.

Action Parameters

id
integerRequired
permissionId
integerRequired

Action Response

data
object
successful
boolean
error

Use this operation to extend the life of rest api webhooks beyond 30 days; it ignores webhooks with unrecognized ids. only connect and oauth 2.0 apps are permitted to use this.

Action Parameters

webhookIds
arrayRequired

Action Response

data
object
successful
boolean
error

Retrieve paginated list of projects with security schemes by filtering with scheme/project ids. if none provided, all mappings shown. for classic projects only; ‘administer jira’ rights needed.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
issueSecuritySchemeId
array
projectId
array

Action Response

data
object
successful
boolean
error

Creates a tab for a screen. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
id
integer
name
stringRequired

Action Response

data
object
successful
boolean
error

Deprecated: to get group members, use group/member instead. requires “browse users and groups” or “administer jira” permissions.

Action Parameters

groupname
string
groupId
string
expand
string

Action Response

data
object
successful
boolean
error

Provides a sorted, paginated list of field configuration schemes for classic projects, including associated project ids, with the first item being the default. requires jira admin permissions.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
projectId
arrayRequired

Action Response

data
object
successful
boolean
error

Fetches a paginated list of screen schemes for classic projects, requiring the administer jira global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 25
id
array
expand
string
queryString
string
orderBy
string

Action Response

data
object
successful
boolean
error

Deletes an issue security scheme. permissions required: administer jira global permission.

Action Parameters

schemeId
stringRequired

Action Response

data
object
successful
boolean
error

Updates, and restricts, field configurations in classic projects; sets text/wiki renderers but excludes autocomplete. admin rights required.

Action Parameters

id
integerRequired
fieldConfigurationItems
arrayRequired

Action Response

data
object
successful
boolean
error

Returns the issue type-workflow mapping for an issue type in a workflow scheme. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
issueType
stringRequired
returnDraftIfExists
boolean

Action Response

data
object
successful
boolean
error

Creates a screen with a default field tab. permissions required: administer jira global permission.

Action Parameters

description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

Assigns a forge app property that can be accessed in jira expressions. app context variable for retrieval. use storage api otherwise. request body must be valid, non-empty json under 32768 chars. only forge apps have permissions.

Action Parameters

propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

This operation removes options only from select lists added by connect apps in jira fields, not options created in jira or with issue custom field options. admin jira global permission is required, but no jira permissions for the app’s field.

Action Parameters

fieldKey
stringRequired
optionId
integerRequired

Action Response

data
object
successful
boolean
error

Use “load project avatar” to upload project avatars, then apply this operation to choose the displayed one. administer projects permission is necessary.

Action Parameters

projectIdOrKey
stringRequired
fileName
string
id
stringRequired
isDeletable
boolean
isSelected
boolean
isSystemAvatar
boolean
owner
string
urls
object

Action Response

data
object
successful
boolean
error

Changes issue navigator default columns by passing ‘columns’ parameters in html form data via curl. if omitted, defaults are cleared. admin rights required. see atlassian docs for navigable fields info.

Action Parameters

columns
array

Action Response

data
object
successful
boolean
error

Creates a project category. permissions required: administer jira global permission.

Action Parameters

description
string
id
string
name
string
self
string

Action Response

data
object
successful
boolean
error

Jira allows changing application properties, such as the clone prefix and date formats, with default values listed. advanced settings affect jira’s look and functionality, and should be altered with caution by jira admins.

Action Parameters

id
stringRequired
value
string

Action Response

data
object
successful
boolean
error

Retrieves time tracking configurations like format and units. requires ‘administer jira’ global permission. more details: [configuring time tracking] and [permissions].

Action Parameters

Action Response

data
object
successful
boolean
error

The feature shows up to 20 recent projects visible to the user, accessible anonymously with appropriate permissions to browse, administer the project, or administer jira.

Action Parameters

expand
string
properties
array

Action Response

data
object
successful
boolean
error

This function allows a user to remove a filter from their favorites. if a favorited public filter becomes private and invisible, it can’t be unfavored. access to jira is required.

Action Parameters

id
integerRequired
expand
string

Action Response

data
object
successful
boolean
error

Removes an issue security level asynchronously. check the task status via the ‘location’ link, and get updates using ‘get task’. admin jira global permission needed.

Action Parameters

schemeId
stringRequired
levelId
stringRequired
replaceWith
string

Action Response

data
object
successful
boolean
error

Get a paginated list of classic jira project fields, including all fields, specific ones by id, or those with a string in their name or description using query. only “custom” type fields are searchable. requires jira admin permissions.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
type
array
id
array
query
string
orderBy
string
expand
string

Action Response

data
object
successful
boolean
error

Returns data policies for the projects specified in the request.

Action Parameters

ids
string

Action Response

data
object
successful
boolean
error

Retrieves an estimated count of user accounts for a jira license, data cached for 7 days. administer jira global permission required.

Action Parameters

applicationKey
stringRequired

Action Response

data
object
successful
boolean
error

Generates a list of workflow schemes linked to projects, detailing project associations per scheme. team-managed/non-existent projects are excluded silently. no id for projects using ‘default workflow scheme’. admin rights required.

Action Parameters

projectId
arrayRequired

Action Response

data
object
successful
boolean
error

New permission scheme creation is available, with or without specifying permissions. requires “administer jira” global permission.

Action Parameters

expand
string
description
string
id
integer
name
stringRequired
permissions
array
scope__project__avatarUrls__16x16
string
scope__project__avatarUrls__24x24
string
scope__project__avatarUrls__32x32
string
scope__project__avatarUrls__48x48
string
scope__project__id
string
scope__project__key
string
scope__project__name
string
scope__project__projectCategory__description
string
scope__project__projectCategory__id
string
scope__project__projectCategory__name
string
scope__project__projectCategory__self
string
scope__project__projectTypeKey
string
scope__project__self
string
scope__project__simplified
boolean
scope__type
string
self
string

Action Response

data
object
successful
boolean
error

Get a paginated list of issue type scheme items for classic projects. requires the ‘administer jira’ global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
issueTypeSchemeId
array

Action Response

data
object
successful
boolean
error

The service returns a paginated list of jira priorities, filterable by priority ids, project ids, and default field configurations for company-managed projects. inaccessible or invalid ids are ignored. jira access permission is required.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
id
array
projectId
array
priorityName
string
onlyDefault
boolean

Action Response

data
object
successful
boolean
error

Archive a project to prevent deletion. restore it via the jira ui to delete it afterward. administer jira global permission is necessary.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

The text covers how to set/update user/system preferences, like notifications and shortcuts, within a 255-character limit. old locale/timezone settings default to a new api that requires permissions.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

Returns all the projects where the user is granted a list of project permissions. this operation can be accessed anonymously. permissions required: none.

Action Parameters

permissions
arrayRequired

Action Response

data
object
successful
boolean
error

Test jira expressions to fetch data or plan usage with the jira expressions documentation. context variables such as user, issue, and project can be used. anonymous access is allowed; permissions influence outcomes.

Action Parameters

expand
string
context__board
integer
context__custom
array
context__customerRequest
integer
context__issue__id
integer
context__issue__key
string
context__issues__jql__maxResults
integer
context__issues__jql__query
string
context__issues__jql__startAt
integer
context__issues__jql__validation
stringDefaults to strict
context__project__id
integer
context__project__key
string
context__serviceDesk
integer
context__sprint
integer
expression
stringRequired

Action Response

data
object
successful
boolean
error

Returns the issue type-workflow mapping for an issue type in a workflow scheme’s draft. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
issueType
stringRequired

Action Response

data
object
successful
boolean
error

The text explains how to create jira workflow rules, covering conditions, validators, and post functions for transitions, with a bulk create option and a guide [linked]. admin rights are needed.

Action Parameters

description
string
name
stringRequired
statuses
arrayRequired
transitions
arrayRequired

Action Response

data
object
successful
boolean
error

Updates or creates a draft workflow scheme for an existing active workflow. each active scheme can only have one draft. administer jira global permission required.

Action Parameters

id
integerRequired
description
string
defaultWorkflow
string
draft
boolean
issueTypeMappings
object
issueTypes
object
lastModified
string
lastModifiedUser__accountId
string
lastModifiedUser__accountType
string
lastModifiedUser__active
boolean
lastModifiedUser__applicationRoles__items
array
lastModifiedUser__applicationRoles__max__results
integer
lastModifiedUser__applicationRoles__size
integer
lastModifiedUser__avatarUrls__16x16
string
lastModifiedUser__avatarUrls__24x24
string
lastModifiedUser__avatarUrls__32x32
string
lastModifiedUser__avatarUrls__48x48
string
lastModifiedUser__displayName
string
lastModifiedUser__emailAddress
string
lastModifiedUser__expand
string
lastModifiedUser__groups__items
array
lastModifiedUser__groups__max__results
integer
lastModifiedUser__groups__size
integer
lastModifiedUser__key
string
lastModifiedUser__locale
string
lastModifiedUser__name
string
lastModifiedUser__self
string
lastModifiedUser__timeZone
string
name
string
originalDefaultWorkflow
string
originalIssueTypeMappings
object
self
string
updateDraftIfNeeded
boolean

Action Response

data
object
successful
boolean
error

Reorders issue types in a scheme; requires all types in scheme & either ‘after’ or ‘position’ specified—excluding ‘after’ type from the list. admin jira rights needed.

Action Parameters

issueTypeSchemeId
integerRequired
after
string
issueTypeIds
arrayRequired
position
string

Action Response

data
object
successful
boolean
error

Returns a permission scheme. permissions required: permission to access jira.

Action Parameters

schemeId
integerRequired
expand
string

Action Response

data
object
successful
boolean
error

Cancels a task. permissions required: either of: * administer jira global permission. * creator of the task.

Action Parameters

taskId
stringRequired

Action Response

data
object
successful
boolean
error

Creates a new issue in jira with specified fields, updates, and properties. this endpoint allows for comprehensive issue creation, supporting standard jira fields as well as custom fields and issue properties. it can be used to initiate new tasks, bugs, stories, or any other issue type defined in your jira project. the endpoint is particularly useful for automating issue creation from external systems or for bulk issue creation. it provides flexibility in setting initial issue state, including the ability to specify transitions, add history metadata, and set custom properties. however, it’s important to note that the fields available and required may vary depending on the specific jira configuration and issue type being created. proper permissions are necessary to create issues in the specified project.

Action Parameters

updateHistory
boolean
fields__summary
string
fields__issuetype__id
string
fields__description__version
integerDefaults to 1
fields__description__type
stringDefaults to doc
fields__description__content
array
fields__project__id
string
historyMetadata__extraData
object
transition__fields
object
update
object

Action Response

data
object
successful
boolean
error

Deletes an issue type screen scheme. permissions required: administer jira global permission.

Action Parameters

issueTypeScreenSchemeId
stringRequired

Action Response

data
object
successful
boolean
error

The tool asynchronously removes a property from filtered issues transactionally. results are clickable links. without filters, all issues are affected. edit and browse permissions, plus issue security compliance, are needed.

Action Parameters

propertyKey
stringRequired
currentValue
entityIds
array

Action Response

data
object
successful
boolean
error

Restores a deleted custom field in jira, requiring ‘administer jira’ global permission. for details on deleting custom fields, visit provided links.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Fetches issue worklogs from jira starting at the oldest or a specified date if time tracking is enabled. requires ‘browse projects’ permission and respects issue-level security and visibility restrictions. can be done anonymously.

Action Parameters

issueIdOrKey
stringRequired
startAt
integer
maxResults
integerDefaults to 5000
startedAfter
integer
startedBefore
integer
expand
string

Action Response

data
object
successful
boolean
error

Issue type schemes from classic projects can be deleted. projects using the scheme switch to the default. admin rights in jira are needed.

Action Parameters

issueTypeSchemeId
integerRequired

Action Response

data
object
successful
boolean
error

This operation checks the status of a long-running async task, returning a json result when completed, retaining details for 14 days. oauth scopes update on june 15, 2024. requires admin permission or task creator access.

Action Parameters

taskId
stringRequired

Action Response

data
object
successful
boolean
error

Jira cloud provides a list of project roles with names and urls, accessible even anonymously. roles are shared across projects. admin rights needed. see details and permission links online.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Get a paginated list of issue security schemes, filterable by project id. use a specific method to find all projects associated with a scheme. only for classic projects and requires jira admin permission.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
id
array
projectId
array

Action Response

data
object
successful
boolean
error

Sets default issue resolution. permissions required: administer jira global permission.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Apps can update the value of their own declared custom fields for issues but only if they have the necessary permissions as the operation is restricted to the app that owns the fields.

Action Parameters

fieldIdOrKey
stringRequired
generateChangelog
booleanDefaults to True
updates
array

Action Response

data
object
successful
boolean
error

This operation extracts metadata from files within a zip attachment anonymously, ideal for backend use. it requires ‘browse projects’ permission and respects issue-level security. for comprehensive attachment metadata, use ‘get all metadata’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Updates an issue type scheme. permissions required: administer jira global permission.

Action Parameters

issueTypeSchemeId
integerRequired
description
string
defaultIssueTypeId
string
name
string

Action Response

data
object
successful
boolean
error

Deletes a custom field in jira to trash; admin rights needed. see guides for further details on deletion processes. edit/delete info, permissions.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The operation allows adding comments to an issue anonymously but requires ‘browse projects’ and ‘add comments’ permissions for the related project, and issue-level security permission if set.

Action Parameters

issueIdOrKey
stringRequired
expand
string
author__accountId
string
author__accountType
string
author__active
boolean
author__avatarUrls__16x16
string
author__avatarUrls__24x24
string
author__avatarUrls__32x32
string
author__avatarUrls__48x48
string
author__displayName
string
author__emailAddress
string
author__key
string
author__name
string
author__self
string
author__timeZone
string
body
created
string
id
string
jsdAuthorCanSeeRequest
boolean
jsdPublic
boolean
properties
array
renderedBody
string
self
string
updateAuthor__accountId
string
updateAuthor__accountType
string
updateAuthor__active
boolean
updateAuthor__avatarUrls__16x16
string
updateAuthor__avatarUrls__24x24
string
updateAuthor__avatarUrls__32x32
string
updateAuthor__avatarUrls__48x48
string
updateAuthor__displayName
string
updateAuthor__emailAddress
string
updateAuthor__key
string
updateAuthor__name
string
updateAuthor__self
string
updateAuthor__timeZone
string
updated
string
visibility__identifier
string
visibility__type
string
visibility__value
string

Action Response

data
object
successful
boolean
error

Returns an application role. permissions required: administer jira global permission.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

The text offers a guide for jql searches with field/function info, reserved words, custom field filters by project, and efficient use of collapsed fields, all without needing permissions.

Action Parameters

includeCollapsedFields
boolean
projectIds
array

Action Response

data
object
successful
boolean
error

The system transforms jql queries to use entity ids for privacy when users don’t have access, altering clauses with restricted projects, but it’s not gdpr compliant without admin rights.

Action Parameters

queries
arrayRequired

Action Response

data
object
successful
boolean
error

Updates an issue type screen scheme. permissions required: administer jira global permission.

Action Parameters

issueTypeScreenSchemeId
stringRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

Retrieves a paginated list of issue type screen schemes with their associated classic projects. requires jira admin global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
projectId
arrayRequired

Action Response

data
object
successful
boolean
error

Deprecated api to get a paginated list of field contexts is replaced by “get custom field contexts.” admin rights required.

Action Parameters

fieldId
stringRequired
startAt
integer
maxResults
integerDefaults to 20

Action Response

data
object
successful
boolean
error

Provides a paginated list of webhooks for the calling app, accessible only by connect and oauth 2.0 apps.

Action Parameters

startAt
integer
maxResults
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Retrieves the project’s permission scheme. requires ‘administer jira’ global permission or ‘administer projects’ project permission.

Action Parameters

projectKeyOrId
stringRequired
expand
string

Action Response

data
object
successful
boolean
error

Returns the default sharing settings for new filters and dashboards for a user. permissions required: permission to access jira.

Action Parameters

Action Response

data
object
successful
boolean
error

Deprecated method returns all projects a user can see. use the paginated “get projects” with search support instead. anonymous access available. requires ‘browse’ or ‘administer’ project permissions.

Action Parameters

expand
string
recent
integer
properties
array
name
string

Action Response

data
object
successful
boolean
error

Removing projects from a custom field context makes it apply to all projects. if a project isn’t in the context or causes duplicate global contexts, the operation fails. admin rights are required.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
projectIds
arrayRequired

Action Response

data
object
successful
boolean
error

Removes a user from a group. permissions required: site administration (that is, member of the site-admin group).

Action Parameters

groupname
string
groupId
string
username
string
accountId
stringRequired

Action Response

data
object
successful
boolean
error

Returns the list of features for a project.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

The service provides a paged list of all jira workflow schemes, excluding drafts. it requires the ‘administer jira’ global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Updates a notification scheme. permissions required: administer jira global permission.

Action Parameters

id
stringRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

This operation retrieves project issue types and can be used without login. required permissions: either “browse projects” in the project or “administer jira” globally.

Action Parameters

projectId
integerRequired
level
integer

Action Response

data
object
successful
boolean
error

Operation returns an issue type and can be used without login. requires “browse projects” permission in the relevant project or “administer jira” global permission.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Get a paginated list of all project components, including global ones, anonymously. requires “browse projects” permission for the project.

Action Parameters

projectIdsOrKeys
array
startAt
integer
maxResults
integerDefaults to 50
orderBy
string
query
string

Action Response

data
object
successful
boolean
error

This operation updates a project version and can be done anonymously. it requires either “administer jira” global permission or “administer projects” project permission for the relevant project.

Action Parameters

id
stringRequired
description
string
approvers
array
archived
boolean
driver
string
expand
string
issuesStatusForFixVersion__done
integer
issuesStatusForFixVersion__inProgress
integer
issuesStatusForFixVersion__toDo
integer
issuesStatusForFixVersion__unmapped
integer
moveUnfixedIssuesTo
string
name
string
operations
array
overdue
boolean
project
string
projectId
integer
releaseDate
string
released
boolean
self
string
startDate
string
userReleaseDate
string
userStartDate
string

Action Response

data
object
successful
boolean
error

This operation updates custom field options for select lists in jira, but not for options from connect/forge apps. admin jira permissions are required.

Action Parameters

replaceWith
integer
jql
string
fieldId
stringRequired
optionId
integerRequired
contextId
integerRequired

Action Response

data
object
successful
boolean
error

Returns an issue priority. permissions required: permission to access jira.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The text provides instructions to remove the “issue type property” in jira, noting that “administer jira” global permission is necessary for this operation.

Action Parameters

issueTypeId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Provides a paginated list of select list issue field options from connect apps, not usable with jira-native options. requires jira access permissions.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
projectId
integer
fieldKey
stringRequired

Action Response

data
object
successful
boolean
error

Sets user’s default issue table columns in jira. without an account id, it affects the caller’s settings. if no columns are specified, defaults are cleared. admins can set any user’s columns; others can only set their own. data is sent as html form data.

Action Parameters

accountId
string
columns
array

Action Response

data
object
successful
boolean
error

This operation deletes an issue type from a scheme but can’t remove types in use, from the default scheme, or the last in a scheme. admin rights needed.

Action Parameters

issueTypeSchemeId
integerRequired
issueTypeId
integerRequired

Action Response

data
object
successful
boolean
error

This operation analyzes and confirms the validity of jira expressions and can optionally type-check them. it’s experimental, with no permissions needed. learn more in the documentation.

Action Parameters

check
stringDefaults to syntax
contextVariables
object
expressions
arrayRequired

Action Response

data
object
successful
boolean
error

A draft workflow scheme with new statuses for issue types is published. issue status updates are mapped accordingly. the process is asynchronous; track status via provided links. admin jira rights needed.

Action Parameters

id
integerRequired
validateOnly
boolean
statusMappings
array

Action Response

data
object
successful
boolean
error

The operation retrieves users matching a query, often less than maxresults, using and/or for roles/properties. ‘browse users and groups’ permission required.

Action Parameters

query
stringRequired
startAt
integer
maxResults
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Forge apps can make ui changes with or without explicit permissions, supporting 3000 modifications, each with 1000 contexts. however, there’s a cap of 100 modifications for each context.

Action Parameters

description
string
contexts
array
data
string
name
stringRequired

Action Response

data
object
successful
boolean
error

Remove all or a list of modules registered by the calling app. permissions required: only connect apps can make this request.

Action Parameters

moduleKey
array

Action Response

data
object
successful
boolean
error

Adds a field to the default tab of the default screen. permissions required: administer jira global permission.

Action Parameters

fieldId
stringRequired

Action Response

data
object
successful
boolean
error

Updates a company-managed project workflow scheme and its components. if active, updates/creates a draft scheme if updatedraftifneeded is true. admin jira permissions needed.

Action Parameters

id
integerRequired
description
string
defaultWorkflow
string
draft
boolean
issueTypeMappings
object
issueTypes
object
lastModified
string
lastModifiedUser__accountId
string
lastModifiedUser__accountType
string
lastModifiedUser__active
boolean
lastModifiedUser__applicationRoles__items
array
lastModifiedUser__applicationRoles__max__results
integer
lastModifiedUser__applicationRoles__size
integer
lastModifiedUser__avatarUrls__16x16
string
lastModifiedUser__avatarUrls__24x24
string
lastModifiedUser__avatarUrls__32x32
string
lastModifiedUser__avatarUrls__48x48
string
lastModifiedUser__displayName
string
lastModifiedUser__emailAddress
string
lastModifiedUser__expand
string
lastModifiedUser__groups__items
array
lastModifiedUser__groups__max__results
integer
lastModifiedUser__groups__size
integer
lastModifiedUser__key
string
lastModifiedUser__locale
string
lastModifiedUser__name
string
lastModifiedUser__self
string
lastModifiedUser__timeZone
string
name
string
originalDefaultWorkflow
string
originalIssueTypeMappings
object
self
string
updateDraftIfNeeded
boolean

Action Response

data
object
successful
boolean
error

The service provides a paginated list of users in a group, sorted by username (which is not shown for privacy), with required permissions being “browse users and groups” or “administer jira.”

Action Parameters

groupname
string
groupId
string
includeInactiveUsers
boolean
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Returns a user’s property value; if no key is provided, it lists available keys. does not access jira user properties. requires administer jira permission for others’ properties, or user access for own.

Action Parameters

accountId
string
userKey
string
username
string
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Changes the order of issue resolutions. permissions required: administer jira global permission.

Action Parameters

after
string
ids
arrayRequired
position
string

Action Response

data
object
successful
boolean
error

Updates the issue type. permissions required: administer jira global permission.

Action Parameters

id
stringRequired
description
string
avatarId
integer
name
string

Action Response

data
object
successful
boolean
error

Use the user management rest api’s “update a user profile” to set user locale in jira; ensure appropriate permissions.

Action Parameters

locale
string

Action Response

data
object
successful
boolean
error

Set custom data on a comment by sending a valid, non-empty json under 32,768 characters. requires permissions to “edit all comments” or “edit own comments,” with additional role/group membership if the comment is restricted.

Action Parameters

commentId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Project deletion is asynchronous and transactional; if it fails, the project remains. track progress via ‘location’ link and ‘get task’. requires ‘administer jira’ global permission.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Updating custom field options in jira only applies to select list options made in jira or via its api. updates ignore unchanged values and omit them in the response. requires jira admin permissions. connect app options can’t be updated this way.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
options
array

Action Response

data
object
successful
boolean
error

To bulk create workflows in jira, you need ‘administer jira’ permission for global workflows and ‘administer projects’ for project-specific ones.

Action Parameters

payload__scope__project__id
string
payload__scope__type
string
payload__statuses
array
payload__workflows
array
validationOptions__levels
array

Action Response

data
object
successful
boolean
error

This operation removes a property from a project in jira and can be done anonymously, but requires either ‘administer jira’ global or ‘administer projects’ project permissions.

Action Parameters

projectIdOrKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Get a list of workflows and statuses using names, ids, or by project/issue type. requires ‘administer jira’ for all or ‘administer projects’/‘view workflow’ for project-level access.

Action Parameters

expand
string
projectAndIssueTypes
array
workflowIds
array
workflowNames
array

Action Response

data
object
successful
boolean
error

The text explains that only users with “administer jira” permissions can assign issue type screen schemes to classic projects.

Action Parameters

issueTypeScreenSchemeId
string
projectId
string

Action Response

data
object
successful
boolean
error

The api fetches jira issue watchers if “issue watch” is enabled, allowing anonymous queries. it needs permissions for project browsing, issue security if applicable, and to view voter/watcher info. setup details are in jira documentation.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Jira provides project templates for various types, with options varying by product (core, service management, software). administrative rights are required for management and customization through apps settings.

Action Parameters

description
string
assigneeType
string
avatarId
integer
categoryId
integer
fieldConfigurationScheme
integer
issueSecurityScheme
integer
issueTypeScheme
integer
issueTypeScreenScheme
integer
key
stringRequired
lead
string
leadAccountId
string
name
stringRequired
notificationScheme
integer
permissionScheme
integer
projectTemplateKey
string
projectTypeKey
string
url
string
workflowScheme
integer

Action Response

data
object
successful
boolean
error

Fetches a worklog property value. anonymous access allowed. requires ‘browse projects’ permission, issue security permission if set, and worklog visibility group/role access.

Action Parameters

issueIdOrKey
stringRequired
worklogId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves the value of a jira project property, available even without authentication. requires ‘browse projects’ permission for the associated project.

Action Parameters

projectIdOrKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

To delete a filter in jira, you need access permission. only the filter creator or a user with ‘administer jira’ global permission can perform the deletion.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

To add a user to an issue’s watcher list, use the account id or default to the caller. ensure “allow users to watch issues” is on, and appropriate permissions, including “manage watcher list” for adding others, are granted.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Fetches a paginated list of classic workflows, detailing specified names or all published ones; excludes next-gen workflows. requires ‘administer jira’ global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
workflowName
array
expand
string
queryString
string
orderBy
string
isActive
boolean

Action Response

data
object
successful
boolean
error

Access a paginated, date-ordered list of issue changelogs anonymously. requires ‘browse projects’ permission and, if set, issue-level security clearance.

Action Parameters

issueIdOrKey
stringRequired
startAt
integer
maxResults
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Update a project role’s name and description in jira; both fields are required. admin privileges needed. links provided for permissions details.

Action Parameters

id
integerRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

Sets the state of a project feature.

Action Parameters

projectIdOrKey
stringRequired
featureKey
stringRequired
state
string

Action Response

data
object
successful
boolean
error

The operation retrieves dashboard gadgets based on specified criteria: by list of ids, module key, list of uris, or all gadgets if no parameters are given. it can be accessed without any permissions.

Action Parameters

dashboardId
integerRequired
moduleKey
array
uri
array
gadgetId
array

Action Response

data
object
successful
boolean
error

A new project role without default actors can be created and later assigned actors. note: existing projects won’t get new actors automatically. admin rights required.

Action Parameters

description
string
name
string

Action Response

data
object
successful
boolean
error

This operation retrieves avatar images for projects or issue types, available anonymously. no permissions needed for system avatars. custom avatars require ‘browse projects’ permission for the related project or issue type.

Action Parameters

type
stringRequired
entityId
stringRequired
size
string
format
string

Action Response

data
object
successful
boolean
error

This api returns both system and custom project avatars without login. users need ‘browse projects’ permission for access.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

To modify an active workflow scheme’s issue type in jira, set ‘updatedraftifneeded’ to ‘true’ to create/update a draft. publish the draft to apply changes. admin permissions required.

Action Parameters

id
integerRequired
issueType
stringRequired
updateDraftIfNeeded
boolean
workflow
string

Action Response

data
object
successful
boolean
error

Creates an issue type screen scheme. permissions required: administer jira global permission.

Action Parameters

description
string
issueTypeMappings
arrayRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

Attach files to a jira issue using multipart/form-data and ‘x-atlassian-token: no-check’ header. include ‘file’ parameter; examples in various languages. requires ‘browse projects’ and ‘create attachments’ permissions, anonymous allowed.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

The text outlines that to return the default data classification for a project, one needs browse projects and administer projects permissions for the project, as well as administer jira global permission.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Generates a list of company-managed projects with their notification plans through pagination, filtering by id, or displaying all by default. limited to projects with default schemes, jira access needed.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
notificationSchemeId
array
projectId
array

Action Response

data
object
successful
boolean
error

Get a project or issue type avatar image by id. accessible without login for system avatars; requires “browse projects” permission for custom avatars related to specific projects or issue types.

Action Parameters

type
stringRequired
id
integerRequired
size
string
format
string

Action Response

data
object
successful
boolean
error

Returns the default issue navigator columns. permissions required: administer jira global permission.

Action Parameters

Action Response

data
object
successful
boolean
error

Deletes the issue type-workflow mapping for an issue type in a workflow scheme’s draft. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
issueType
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of all statuses associated with active workflows. this operation can be accessed anonymously. permissions required: none.

Action Parameters

Action Response

data
object
successful
boolean
error

Provides a paginated list of issue security level members for classic projects. filtering by security scheme and level ids is possible. requires ‘administer jira’ global permission.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
id
array
schemeId
array
levelId
array
expand
string

Action Response

data
object
successful
boolean
error

Deletes a group. permissions required: site administration (that is, member of the site-admin strategic group).

Action Parameters

groupname
string
groupId
string
swapGroup
string
swapGroupId
string

Action Response

data
object
successful
boolean
error

Merges two project versions by deleting one and updating references to it. alternative solution and permissions required are detailed. accessible anonymously.

Action Parameters

id
stringRequired
moveIssuesTo
stringRequired

Action Response

data
object
successful
boolean
error

The default workflow for a jira workflow scheme draft assigns unmapped issue types to a specific workflow labeled all unassigned issue types. administering jira global permission is needed to access it.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Resets a draft workflow scheme’s default to jira’s system workflow; requires ‘administer jira’ global permission.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Deletes only the calling app’s webhooks by id, ignoring others. requires connect and oauth 2.0 app permissions.

Action Parameters

webhookIds
arrayRequired

Action Response

data
object
successful
boolean
error

Updating a permission scheme either changes its name/description or replaces all grants with a given list; an empty list removes all grants. specific endpoints handle individual grant changes. admin rights are needed.

Action Parameters

schemeId
integerRequired
expand
string
description
string
id
integer
name
stringRequired
permissions
array
scope__project__avatarUrls__16x16
string
scope__project__avatarUrls__24x24
string
scope__project__avatarUrls__32x32
string
scope__project__avatarUrls__48x48
string
scope__project__id
string
scope__project__key
string
scope__project__name
string
scope__project__projectCategory__description
string
scope__project__projectCategory__id
string
scope__project__projectCategory__name
string
scope__project__projectCategory__self
string
scope__project__projectTypeKey
string
scope__project__self
string
scope__project__simplified
boolean
scope__type
string
self
string

Action Response

data
object
successful
boolean
error

Returns all permissions, including: * global permissions. * project permissions. * global permissions added by plugins. this operation can be accessed anonymously. permissions required: none.

Action Parameters

Action Response

data
object
successful
boolean
error

The text provides instructions for removing a property from a workflow transition, which affects its behavior. references include detailed documentation on transition and workflow properties. admin rights in jira are required.

Action Parameters

transitionId
integerRequired
key
stringRequired
workflowName
stringRequired
workflowMode
string

Action Response

data
object
successful
boolean
error

Summary: this function retrieves all fields for a jira screen tab, requiring “administer jira” global permission or “administer projects” permission if a project key is provided and the screen is linked via screen and issue type screen schemes.

Action Parameters

screenId
integerRequired
tabId
integerRequired
projectKey
string

Action Response

data
object
successful
boolean
error

Update jira worklog by enabling time tracking, checking permissions (project browsing, issue security viewing, worklog editing), adhering to visibility rules. anonymous edits allowed. for setup, see the time tracking configuration guide.

Action Parameters

issueIdOrKey
stringRequired
id
stringRequired
notifyUsers
booleanDefaults to True
adjustEstimate
stringDefaults to auto
newEstimate
string
expand
string
overrideEditableFlag
boolean
author__accountId
string
author__accountType
string
author__active
boolean
author__avatarUrls__16x16
string
author__avatarUrls__24x24
string
author__avatarUrls__32x32
string
author__avatarUrls__48x48
string
author__displayName
string
author__emailAddress
string
author__key
string
author__name
string
author__self
string
author__timeZone
string
comment
created
string
issueId
string
properties
array
self
string
started
string
timeSpent
string
timeSpentSeconds
integer
updateAuthor__accountId
string
updateAuthor__accountType
string
updateAuthor__active
boolean
updateAuthor__avatarUrls__16x16
string
updateAuthor__avatarUrls__24x24
string
updateAuthor__avatarUrls__32x32
string
updateAuthor__avatarUrls__48x48
string
updateAuthor__displayName
string
updateAuthor__emailAddress
string
updateAuthor__key
string
updateAuthor__name
string
updateAuthor__self
string
updateAuthor__timeZone
string
updated
string
visibility__identifier
string
visibility__type
string
visibility__value
string

Action Response

data
object
successful
boolean
error

This operation lists project-specific issue security levels accessible to the user, anonymously available but requires ‘browse projects’ and ‘set issue security’ permissions for detailed access.

Action Parameters

projectKeyOrId
stringRequired

Action Response

data
object
successful
boolean
error

This operation updates field configuration schemes for classic projects in jira and requires ‘administer jira’ global permission.

Action Parameters

id
integerRequired
description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

Validates project name availability, returning the original or a modified version with a sequence number. if a valid name can’t be created, a 404 error is issued. no permissions required.

Action Parameters

name
stringRequired

Action Response

data
object
successful
boolean
error

Removes default actors from a project role in jira, with the restriction of deleting either a group or user per request, not both. pre-existing project roles remain unaffected. admin jira rights are required.

Action Parameters

id
integerRequired
user
string
groupId
string
group
string

Action Response

data
object
successful
boolean
error

Jira allows setting property values on multiple issues with constants or expressions, filtering by various criteria. updates to properties are transactional, asynchronous, and require proper permissions.

Action Parameters

propertyKey
stringRequired
expression
string
filter__currentValue
filter__entityIds
array
filter__hasProperty
boolean
value

Action Response

data
object
successful
boolean
error

Updates the announcement banner configuration. permissions required: administer jira global permission.

Action Parameters

isDismissible
boolean
isEnabled
boolean
message
string
visibility
string

Action Response

data
object
successful
boolean
error

An anonymous user can update a comment if they have the ‘browse projects’ permission, ‘edit all/own comments’ permission, and visibility permission if the comment is restricted.

Action Parameters

issueIdOrKey
stringRequired
id
stringRequired
notifyUsers
booleanDefaults to True
overrideEditableFlag
boolean
expand
string
author__accountId
string
author__accountType
string
author__active
boolean
author__avatarUrls__16x16
string
author__avatarUrls__24x24
string
author__avatarUrls__32x32
string
author__avatarUrls__48x48
string
author__displayName
string
author__emailAddress
string
author__key
string
author__name
string
author__self
string
author__timeZone
string
body
created
string
jsdAuthorCanSeeRequest
boolean
jsdPublic
boolean
properties
array
renderedBody
string
self
string
updateAuthor__accountId
string
updateAuthor__accountType
string
updateAuthor__active
boolean
updateAuthor__avatarUrls__16x16
string
updateAuthor__avatarUrls__24x24
string
updateAuthor__avatarUrls__32x32
string
updateAuthor__avatarUrls__48x48
string
updateAuthor__displayName
string
updateAuthor__emailAddress
string
updateAuthor__key
string
updateAuthor__name
string
updateAuthor__self
string
updateAuthor__timeZone
string
updated
string
visibility__identifier
string
visibility__type
string
visibility__value
string

Action Response

data
object
successful
boolean
error

Retrieve user preferences using the user management rest api before 15/07/2024, as locale/timezone keys are deprecated. notification keys remain unaffected. permissions needed.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

This procedure removes actors from a project role and can be done without logging in. requires either “administer projects” project or “administer jira” global permissions. use the provided link for default actor removal.

Action Parameters

projectIdOrKey
stringRequired
id
integerRequired
user
string
group
string
groupId
string

Action Response

data
object
successful
boolean
error

The text provides a project role description and its default actors, sorted by display name, requiring ‘administer jira’ global permission for access.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves a paginated list of screens, filterable by specific screen ids. requires ‘administer jira’ global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 100
id
array
queryString
string
scope
array
orderBy
string

Action Response

data
object
successful
boolean
error

Retrieves an issue’s key and value property, available without login. requires ‘browse projects’ permission for the project and issue-level security permission if set.

Action Parameters

issueIdOrKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

The operation allows anonymous access to return a comment, provided the user has permission to browse the project, view issues with security restrictions, and is part of any visibility-restricted group or role.

Action Parameters

issueIdOrKey
stringRequired
id
stringRequired
expand
string

Action Response

data
object
successful
boolean
error

Returns the account ids for the users specified in the key or username parameters. note that multiple key or username parameters can be specified. permissions required: permission to access jira.

Action Parameters

startAt
integer
maxResults
integerDefaults to 10
username
array
key
array

Action Response

data
object
successful
boolean
error

Detailed project and issue type data for user requests in jira creation screens, now deprecated. information filters by query and accessible without login. requires project “create issues” permission. see deprecation notice for alternatives.

Action Parameters

projectIds
array
projectKeys
array
issuetypeIds
array
issuetypeNames
array
expand
string

Action Response

data
object
successful
boolean
error

Fetches a list of statuses for given status ids. requires ‘administer projects’ and ‘administer jira’ permissions.

Action Parameters

expand
string
id
arrayRequired

Action Response

data
object
successful
boolean
error

Returns a component. this operation can be accessed anonymously. permissions required: browse projects project permission for project containing the component.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Generates a user list based on criteria, access levels, and scope while respecting privacy. fully inclusive without searches. accessible without login but needs jira or admin rights.

Action Parameters

query
string
username
string
accountId
string
permissions
stringRequired
issueKey
string
projectKey
string
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Updates the value of a custom field added by connect apps on one or more issues. the values of up to 200 custom fields can be updated. permissions required: only connect apps can make this request

Action Parameters

updateValueList
array

Action Response

data
object
successful
boolean
error

Resets user’s default issue table columns to system default; if no accountid specified, affects caller’s defaults. administer jira rights needed to alter any user’s columns, jira access required for self-reset.

Action Parameters

accountId
string
username
string

Action Response

data
object
successful
boolean
error

Returns the fields that can be added to a tab on a screen. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired

Action Response

data
object
successful
boolean
error

Updates an issue resolution. permissions required: administer jira global permission.

Action Parameters

id
stringRequired
description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

Resets default workflow to jira’s system workflow; active schemes need updatedraftifneeded=true for edits, creating/updating a draft that can be published. requires administer jira permission.

Action Parameters

id
integerRequired
updateDraftIfNeeded
boolean

Action Response

data
object
successful
boolean
error

The tool matches and highlights user queries, supports exclusions, and might return fewer results than the maximum due to privacy. use “get all users” for full results. anonymous searches yield exact names with restrictions.

Action Parameters

query
stringRequired
maxResults
integerDefaults to 50
showAvatar
boolean
exclude
array
excludeAccountIds
array
avatarSize
string
excludeConnectUsers
boolean

Action Response

data
object
successful
boolean
error

Returns user’s visible favorite filters, including those owned, shared with their groups, their private/public projects, or the public. anonymous access allowed. filters not returned if access changes. (255 characters)

Action Parameters

expand
string

Action Response

data
object
successful
boolean
error

Returns a paginated list of labels.

Action Parameters

startAt
integer
maxResults
integerDefaults to 1000

Action Response

data
object
successful
boolean
error

Store custom data in a worklog by setting a property with a valid json blob, up to 32768 characters. anonymous access allowed. requires ‘browse projects’ and ‘edit worklogs’ permissions, and adherence to issue-level security if set.

Action Parameters

issueIdOrKey
stringRequired
worklogId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Adds members to the issue security level. you can add up to 100 members per request. permissions required: administer jira global permission.

Action Parameters

schemeId
stringRequired
levelId
stringRequired
members
array

Action Response

data
object
successful
boolean
error

This operation updates a field configuration’s name and description for company-managed projects and requires ‘administer jira’ global permission.

Action Parameters

id
integerRequired
description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

This api returns an estimate of jira user accounts, caching data for 7 days. admin rights are required for access.

Action Parameters

Action Response

data
object
successful
boolean
error

Admins can archive 1000 issues per request, with archive status and errors reported. subtasks archived via parents. limited to certain project types. jira or site admin rights, premium or enterprise license, and signed-in users required.

Action Parameters

issueIdsOrKeys
array

Action Response

data
object
successful
boolean
error

This operation provides the number of total and unresolved issues in a project version, is available without login, and requires ‘browse projects’ permission.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Add actors to a project role; replace using the provided link. anonymous access allowed. requires ‘administer projects’ or ‘administer jira’ permissions.

Action Parameters

projectIdOrKey
stringRequired
id
integerRequired
group
array
groupId
array
user
array

Action Response

data
object
successful
boolean
error

Operation updates a component, overwrites given fields, and can unset lead with empty leadaccountid. anonymous access permitted. needs administer projects or administer jira permissions.

Action Parameters

id
stringRequired
description
string
ari
string
assignee__accountId
string
assignee__accountType
string
assignee__active
boolean
assignee__applicationRoles__items
array
assignee__applicationRoles__max__results
integer
assignee__applicationRoles__size
integer
assignee__avatarUrls__16x16
string
assignee__avatarUrls__24x24
string
assignee__avatarUrls__32x32
string
assignee__avatarUrls__48x48
string
assignee__displayName
string
assignee__emailAddress
string
assignee__expand
string
assignee__groups__items
array
assignee__groups__max__results
integer
assignee__groups__size
integer
assignee__key
string
assignee__locale
string
assignee__name
string
assignee__self
string
assignee__timeZone
string
assigneeType
string
isAssigneeTypeValid
boolean
lead__accountId
string
lead__accountType
string
lead__active
boolean
lead__applicationRoles__items
array
lead__applicationRoles__max__results
integer
lead__applicationRoles__size
integer
lead__avatarUrls__16x16
string
lead__avatarUrls__24x24
string
lead__avatarUrls__32x32
string
lead__avatarUrls__48x48
string
lead__displayName
string
lead__emailAddress
string
lead__expand
string
lead__groups__items
array
lead__groups__max__results
integer
lead__groups__size
integer
lead__key
string
lead__locale
string
lead__name
string
lead__self
string
lead__timeZone
string
leadAccountId
string
leadUserName
string
metadata
object
name
string
project
string
projectId
integer
realAssignee__accountId
string
realAssignee__accountType
string
realAssignee__active
boolean
realAssignee__applicationRoles__items
array
realAssignee__applicationRoles__max__results
integer
realAssignee__applicationRoles__size
integer
realAssignee__avatarUrls__16x16
string
realAssignee__avatarUrls__24x24
string
realAssignee__avatarUrls__32x32
string
realAssignee__avatarUrls__48x48
string
realAssignee__displayName
string
realAssignee__emailAddress
string
realAssignee__expand
string
realAssignee__groups__items
array
realAssignee__groups__max__results
integer
realAssignee__groups__size
integer
realAssignee__key
string
realAssignee__locale
string
realAssignee__name
string
realAssignee__self
string
realAssignee__timeZone
string
realAssigneeType
string
self
string

Action Response

data
object
successful
boolean
error

Returns a paginated list of company-managed projects linked to an issue type screen scheme. requires ‘administer jira’ global permission.

Action Parameters

issueTypeScreenSchemeId
integerRequired
startAt
integer
maxResults
integerDefaults to 50
query
string

Action Response

data
object
successful
boolean
error

Creates an issue type scheme. permissions required: administer jira global permission.

Action Parameters

description
string
defaultIssueTypeId
string
issueTypeIds
arrayRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

Add either groups or users, not both, as default actors to a jira role. existing projects’ roles remain unchanged. admin rights required.

Action Parameters

id
integerRequired
group
array
groupId
array
user
array

Action Response

data
object
successful
boolean
error

Stores custom data for an app using a non-empty json value up to 32768 characters. only connect apps with matching addonkey or forge apps can access these properties.

Action Parameters

addonKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a paginated list of field configurations for company-managed projects, filterable by item ids, defaults, or search terms. requires ‘administer jira’ permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
id
array
isDefault
boolean
query
string

Action Response

data
object
successful
boolean
error

The provided text indicates that to delete a custom field context in jira, one needs to have the ‘administer jira’ global permission.

Action Parameters

fieldId
stringRequired
contextId
integerRequired

Action Response

data
object
successful
boolean
error

Allows creation of up to 1000 select and cascading field options per request for a jira custom field (max 10,000 options). use the issue custom field options for connect apps. admin rights needed.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
options
array

Action Response

data
object
successful
boolean
error

Summary: the text outlines that to create statuses applicable across global or project levels, one must have “administer projects” and “administer jira” permissions.

Action Parameters

scope__project__id
string
scope__type
string
statuses
arrayRequired

Action Response

data
object
successful
boolean
error

The api returns all components in a project, offering a paginated list for projects with compass components. it’s accessible anonymously but requires ‘browse projects’ permission. for full pagination, refer to a specific resource.

Action Parameters

projectIdOrKey
stringRequired
componentSource
stringDefaults to jira

Action Response

data
object
successful
boolean
error

In jira, the default workflow applies to unassigned issue types within a scheme. requires administer jira global permission.

Action Parameters

id
integerRequired
returnDraftIfExists
boolean

Action Response

data
object
successful
boolean
error

Retrieves jira’s global settings to check enabled features like subtasks, time tracking; includes time tracking config if active. access permission required.

Action Parameters

Action Response

data
object
successful
boolean
error

Updates unique combinations of custom fields on issues. restricted to only the app that declared those fields and requires app ownership for updates.

Action Parameters

generateChangelog
booleanDefaults to True
updates
array

Action Response

data
object
successful
boolean
error

Adds levels and levels’ members to the issue security scheme. you can add up to 100 levels per request. permissions required: administer jira global permission.

Action Parameters

schemeId
stringRequired
levels
array

Action Response

data
object
successful
boolean
error

Deletes a permission scheme. permissions required: administer jira global permission.

Action Parameters

schemeId
integerRequired

Action Response

data
object
successful
boolean
error

The system shows essential and globally-configured jira fields, plus additional ones if the user has permission. anonymous users can access without permissions.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns all project types with a valid license.

Action Parameters

Action Response

data
object
successful
boolean
error

A custom field context is created; if no projectids, it’s global (for all projects); if no issuetypeids, it affects all issue types. admin jira rights required.

Action Parameters

fieldId
stringRequired
description
string
id
string
issueTypeIds
array
name
stringRequired
projectIds
array

Action Response

data
object
successful
boolean
error

Updates the issue security level. permissions required: administer jira global permission.

Action Parameters

schemeId
stringRequired
levelId
stringRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

Changes the default workflow in a scheme; active ones need updatedraftifneeded set to true to edit. creates/updates a draft workflow scheme in jira for publishing. admin rights required.

Action Parameters

id
integerRequired
updateDraftIfNeeded
boolean
workflow
stringRequired

Action Response

data
object
successful
boolean
error

Deletes statuses by id; requires ‘administer projects’ and ‘administer jira’ project permissions.

Action Parameters

id
arrayRequired

Action Response

data
object
successful
boolean
error

Removes a field from a screen tab. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
tabId
integerRequired
id
stringRequired

Action Response

data
object
successful
boolean
error

The operation displays user access to projects/issues, defaults to the user, ignores invalid input, and caps at 1000. post-06/15/2024, anonymous users allowed, others require admin, and connected apps gain more rights.

Action Parameters

accountId
string
globalPermissions
array
projectPermissions
array

Action Response

data
object
successful
boolean
error

Provides auto-complete suggestions for issues via two lists: history search with user’s past issues containing a query string, and current search with issues matching a jql expression and the query. accessible anonymously, no permissions needed.

Action Parameters

query
string
currentJQL
string
currentIssueKey
string
currentProjectId
string
showSubTasks
boolean
showSubTaskParent
boolean

Action Response

data
object
successful
boolean
error

Gets a list of all available gadgets that can be added to all dashboards. permissions required: none.

Action Parameters

Action Response

data
object
successful
boolean
error

Updates the default screen scheme in an issue type screen scheme for all issue types not individually mapped. requires administer jira global permission.

Action Parameters

issueTypeScreenSchemeId
stringRequired
screenSchemeId
stringRequired

Action Response

data
object
successful
boolean
error

Use the user management rest api’s update a user profile instead of deprecated method to revert user’s locale to default. requires jira access permission.

Action Parameters

Action Response

data
object
successful
boolean
error

Retrieval of jira custom field options from select lists requires administer jira or browse projects permissions and is not for connect app fields. anonymous access allowed.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The text provides a link to a function that retrieves a paginated list of fields from classic company-managed project configurations, which requires jira admin global permissions.

Action Parameters

id
integerRequired
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Creates an issue priority. permissions required: administer jira global permission.

Action Parameters

description
string
iconUrl
string
name
stringRequired
statusColor
stringRequired

Action Response

data
object
successful
boolean
error

This resource allows storing custom data on an issue with a valid json blob up to 32,768 characters, even anonymously. requires ‘browse projects’ and ‘edit issues’ permissions, plus issue-level security access if set.

Action Parameters

issueIdOrKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Returns all project categories. permissions required: permission to access jira.

Action Parameters

Action Response

data
object
successful
boolean
error

Sets the default sharing for new filters and dashboards for a user. permissions required: permission to access jira.

Action Parameters

scope
stringRequired

Action Response

data
object
successful
boolean
error

Apps can add custom data gadgets to user dashboards, with a 32,768 character limit for json data, and controls for content and settings. dashboard ownership or admin rights are needed for access.

Action Parameters

dashboardId
stringRequired
itemId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Access key and value of jira issue type property anonymously. requires ‘administer jira’ for any issue type, ‘browse projects’ for associated projects’ permissions.

Action Parameters

issueTypeId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Admins can archive 100k jira issues per request with jql; includes status url, task management apis, and project type limits. requires jira admin rights, premium/enterprise license, and non-anonymous access; only one active request allowed per instance.

Action Parameters

jql
string

Action Response

data
object
successful
boolean
error

Removes a dashboard property and doesn’t require login. user must own the dashboard or have administer jira global permission to qualify.

Action Parameters

dashboardId
stringRequired
itemId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Fetches user’s owned filters; includes favorites if includefavourites is true. requires jira access permission. visibility depends on ownership, group membership, or project permissions. if a favorited public filter goes private, it won’t be returned.

Action Parameters

expand
string
includeFavourites
boolean

Action Response

data
object
successful
boolean
error

The operation returns attachment settings, detailing if enabled and the size limit, with user restrictions set by project permissions. it’s accessible without login. no permissions required.

Action Parameters

Action Response

data
object
successful
boolean
error

To delete an issue watcher in jira, “allow users to watch issues” must be enabled. requires “browse projects” permission, issue-level security view access, and “manage watcher list” to remove others. see links for configuration and permissions.

Action Parameters

issueIdOrKey
stringRequired
username
string
accountId
string

Action Response

data
object
successful
boolean
error

Jira’s permission schemes pair holders with specific permissions based on holder type and id, covering project and issue management, with the option for custom permissions.

Action Parameters

expand
string

Action Response

data
object
successful
boolean
error

Retrieves a user-viewable, paginated list of select list issue field options from connect apps only, not those created in jira or via the issue custom field options resource. jira access is required.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
projectId
integer
fieldKey
stringRequired

Action Response

data
object
successful
boolean
error

The operation allows a user with assign issues and browse projects permissions to assign a project issue to a user or set it to unassigned, without needing edit issues permission, and it supports anonymous use.

Action Parameters

issueIdOrKey
stringRequired
accountId
string
accountType
string
active
boolean
applicationRoles__items
array
applicationRoles__max__results
integer
applicationRoles__size
integer
avatarUrls__16x16
string
avatarUrls__24x24
string
avatarUrls__32x32
string
avatarUrls__48x48
string
displayName
string
emailAddress
string
expand
string
groups__items
array
groups__max__results
integer
groups__size
integer
key
string
locale
string
name
string
self
string
timeZone
string

Action Response

data
object
successful
boolean
error

The operation searches and returns a paginated list of users based on a query, with filters and limits defined by startat and maxresults. it requires appropriate permissions and can handle complex queries with logical operators.

Action Parameters

query
stringRequired
startAt
integer
maxResult
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Generates a paginated list of notification schemes, sorted by name, including those with no recipients. requires jira access and admin rights to a related project for scheme visibility.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
id
array
projectId
array
onlyDefault
boolean
expand
string

Action Response

data
object
successful
boolean
error

Get a list of workflow schemes with scheme/project ids. requires ‘administer jira’ for all schemes, ‘administer projects’ for project-specific ones.

Action Parameters

expand
string
projectIds
array
workflowSchemeIds
array

Action Response

data
object
successful
boolean
error

Moves a screen tab. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
tabId
integerRequired
pos
integerRequired

Action Response

data
object
successful
boolean
error

The api returns a paginated list of project components, including compass components linked to issues. anonymous access is supported if users have the ‘browse projects’ permission.

Action Parameters

projectIdOrKey
stringRequired
startAt
integer
maxResults
integerDefaults to 50
orderBy
string
componentSource
stringDefaults to jira
query
string

Action Response

data
object
successful
boolean
error

To bulk update workflows, you need “administer jira” permission for global workflows and “administer projects” for project-specific ones.

Action Parameters

payload__statuses
array
payload__workflows
array
validationOptions__levels
array

Action Response

data
object
successful
boolean
error

Deletes a project category. permissions required: administer jira global permission.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Creates a dashboard. permissions required: none.

Action Parameters

description
string
editPermissions
arrayRequired
name
stringRequired
sharePermissions
arrayRequired

Action Response

data
object
successful
boolean
error

Use jql to search for issues; if the query is too large, use the post method. anonymous access allowed, but you need ‘browse projects’ permission and possibly ‘issue-level security’ permission to view issues.

Action Parameters

jql
string
startAt
integer
maxResults
integerDefaults to 50
validateQuery
stringDefaults to strict
fields
array
expand
string
properties
array
fieldsByKeys
boolean

Action Response

data
object
successful
boolean
error

Changes the title, position, and color of the gadget on a dashboard. permissions required: none.

Action Parameters

dashboardId
integerRequired
gadgetId
integerRequired
title
string
color
string
position__The__column__position__of__the__gadget
integer
position__The__row__position__of__the__gadget
integer

Action Response

data
object
successful
boolean
error

Admins can unarchive up to 1000 issues per request from specific jira projects; details and errors are provided. no subtask direct unarchival. jira or site admin rights and premium/enterprise license needed. no anonymous access.

Action Parameters

issueIdsOrKeys
array

Action Response

data
object
successful
boolean
error

Use jql to find issue ids. for more data, use the search endpoint, which is slower. anonymous access is allowed. required permissions are ‘browse projects’ and, if applicable, ‘issue-level security’.

Action Parameters

jql
string
maxResults
integerDefaults to 1000
nextPageToken
string

Action Response

data
object
successful
boolean
error

Create a component to organize issues in a project. anonymous access allowed, but requires project admin or global jira admin permissions.

Action Parameters

description
string
ari
string
assignee__accountId
string
assignee__accountType
string
assignee__active
boolean
assignee__applicationRoles__items
array
assignee__applicationRoles__max__results
integer
assignee__applicationRoles__size
integer
assignee__avatarUrls__16x16
string
assignee__avatarUrls__24x24
string
assignee__avatarUrls__32x32
string
assignee__avatarUrls__48x48
string
assignee__displayName
string
assignee__emailAddress
string
assignee__expand
string
assignee__groups__items
array
assignee__groups__max__results
integer
assignee__groups__size
integer
assignee__key
string
assignee__locale
string
assignee__name
string
assignee__self
string
assignee__timeZone
string
assigneeType
string
id
string
isAssigneeTypeValid
boolean
lead__accountId
string
lead__accountType
string
lead__active
boolean
lead__applicationRoles__items
array
lead__applicationRoles__max__results
integer
lead__applicationRoles__size
integer
lead__avatarUrls__16x16
string
lead__avatarUrls__24x24
string
lead__avatarUrls__32x32
string
lead__avatarUrls__48x48
string
lead__displayName
string
lead__emailAddress
string
lead__expand
string
lead__groups__items
array
lead__groups__max__results
integer
lead__groups__size
integer
lead__key
string
lead__locale
string
lead__name
string
lead__self
string
lead__timeZone
string
leadAccountId
string
leadUserName
string
metadata
object
name
string
project
string
projectId
integer
realAssignee__accountId
string
realAssignee__accountType
string
realAssignee__active
boolean
realAssignee__applicationRoles__items
array
realAssignee__applicationRoles__max__results
integer
realAssignee__applicationRoles__size
integer
realAssignee__avatarUrls__16x16
string
realAssignee__avatarUrls__24x24
string
realAssignee__avatarUrls__32x32
string
realAssignee__avatarUrls__48x48
string
realAssignee__displayName
string
realAssignee__emailAddress
string
realAssignee__expand
string
realAssignee__groups__items
array
realAssignee__groups__max__results
integer
realAssignee__groups__size
integer
realAssignee__key
string
realAssignee__locale
string
realAssignee__name
string
realAssignee__self
string
realAssignee__timeZone
string
realAssigneeType
string
self
string

Action Response

data
object
successful
boolean
error

This text describes a notification scheme in jira that outlines events and their notification recipients. access requires jira permissions and project administration rights.

Action Parameters

id
integerRequired
expand
string

Action Response

data
object
successful
boolean
error

Retrieves filter’s column configuration used in list view when columns set to filter, available anonymously. only returns details for filters owned, shared with user’s group, or projects where user has permissions.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

The operation provides a paginated list of projects a user can see, which can be accessed without login. visibility depends on having browse, administer projects permission, or administer jira global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
orderBy
stringDefaults to key
id
array
keys
array
query
string
typeKey
string
categoryId
integer
action
stringDefaults to view
expand
string
status
array
properties
array
propertyQuery
string

Action Response

data
object
successful
boolean
error

A project’s issue hierarchy may have optional epics at top, standard issues like story/task/bug, and optional subtasks for breakdown. browsing the project requires permissions.

Action Parameters

projectId
integerRequired

Action Response

data
object
successful
boolean
error

Returns a status category. status categories provided a mechanism for categorizing statuses. permissions required: permission to access jira.

Action Parameters

idOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Adding a global share permission to a filter will replace existing permissions. requires “share dashboards and filters” global permission and filter ownership. note different objects for updates than in update filter link documentation.

Action Parameters

id
integerRequired
accountId
string
groupId
string
groupname
string
projectId
string
projectRoleId
string
rights
integer
type
stringRequired

Action Response

data
object
successful
boolean
error

Worklog deletion in jira requires time tracking enabled. users can do it anonymously but need project permissions to browse and delete worklogs, and issue-level security permissions if set up. visit provided links for more on permissions.

Action Parameters

issueIdOrKey
stringRequired
id
stringRequired
notifyUsers
booleanDefaults to True
adjustEstimate
stringDefaults to auto
newEstimate
string
increaseBy
string
overrideEditableFlag
boolean

Action Response

data
object
successful
boolean
error

Returns a project type if it is accessible to the user. permissions required: permission to access jira.

Action Parameters

projectTypeKey
stringRequired

Action Response

data
object
successful
boolean
error

The text describes a process to check if jql queries will return any issues. no specific permissions are needed, but the user must have ‘browse projects’ permission and, if applicable, issue-level security permission to view the issues.

Action Parameters

issueIds
arrayRequired
jqls
arrayRequired

Action Response

data
object
successful
boolean
error

Lists tabs on a screen, requiring “administer jira” global permission or “administer projects” within a project, linked via screen and issue type screen schemes.

Action Parameters

screenId
integerRequired
projectKey
string

Action Response

data
object
successful
boolean
error

This resource returns a user’s locale in jira: if unset or anonymous, the detected browser locale via ‘accept-language’ header is used, falling back to jira’s default if no match is found. anonymous access is allowed; no permissions needed.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns the list of tabs for a bulk of screens. permissions required: * administer jira global permission.

Action Parameters

screenId
array
tabId
array
startAt
integer
maxResult
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Operation updates either a project role’s name or description, not both. only the name is changed if both are provided. administer jira global permission is required.

Action Parameters

id
integerRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

Returns the groups to which a user belongs. permissions required: browse users and groups global permission.

Action Parameters

accountId
stringRequired
username
string
key
string

Action Response

data
object
successful
boolean
error

Retrieves a paginated list of issue type screen scheme items for classic projects. requires administer jira global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
issueTypeScreenSchemeId
array

Action Response

data
object
successful
boolean
error

Updates a dashboard, replacing all the dashboard details with those provided. permissions required: none the dashboard to be updated must be owned by the user.

Action Parameters

id
stringRequired
description
string
editPermissions
arrayRequired
name
stringRequired
sharePermissions
arrayRequired

Action Response

data
object
successful
boolean
error

List users eligible for jira issue assignment using projectkeyorid for new issues or issuekey for updates. during transitions, add actiondescriptorid. user privacy and selection range may limit results. access requires specific permissions.

Action Parameters

query
string
sessionId
string
username
string
accountId
string
project
string
issueKey
string
startAt
integer
maxResults
integerDefaults to 50
actionDescriptorId
integer
recommend
boolean

Action Response

data
object
successful
boolean
error

Gets ui modifications. ui modifications can only be retrieved by forge apps. permissions required: none.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
expand
string

Action Response

data
object
successful
boolean
error

Summarizes metadata retrieval for attachments, specifically zip files. includes id and name access, with project browsing rights and issue security permissions if needed. anonymous access allowed.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Anonymous users can access a dashboard. no permissions needed. to get a specific dashboard, it must be shared or owned by the user. ‘administer jira’ holders are deemed system dashboard owners, which is shared with all users.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This operation lists dashboard item keys and allows anonymous access. users must be owners or have shared access. administrators are deemed system dashboard owners, accessible to all if anonymous access in jira is allowed.

Action Parameters

dashboardId
stringRequired
itemId
stringRequired

Action Response

data
object
successful
boolean
error

This operation transitions an issue, updates its fields if a screen is present, and requires certain permissions. use ‘fields’ in the request to specify updates. it’s accessible anonymously, but project and issue-level permissions are needed.

Action Parameters

issueIdOrKey
stringRequired
fields__summary
string
fields__assignee__accountId
string
fields__assignee__accountType
string
fields__assignee__active
boolean
fields__assignee__avatarUrls__16x16
string
fields__assignee__avatarUrls__24x24
string
fields__assignee__avatarUrls__32x32
string
fields__assignee__avatarUrls__48x48
string
fields__assignee__displayName
string
fields__assignee__emailAddress
string
fields__assignee__key
string
fields__assignee__name
string
fields__assignee__self
string
fields__assignee__timeZone
string
fields__issueType__description
string
fields__issueType__avatarId
integer
fields__issueType__entityId
string
fields__issueType__hierarchyLevel
integer
fields__issueType__iconUrl
string
fields__issueType__id
string
fields__issueType__name
string
fields__issueType__scope__project__avatarUrls__16x16
string
fields__issueType__scope__project__avatarUrls__24x24
string
fields__issueType__scope__project__avatarUrls__32x32
string
fields__issueType__scope__project__avatarUrls__48x48
string
fields__issueType__scope__project__id
string
fields__issueType__scope__project__key
string
fields__issueType__scope__project__name
string
fields__issueType__scope__project__projectCategory__description
string
fields__issueType__scope__project__projectCategory__id
string
fields__issueType__scope__project__projectCategory__name
string
fields__issueType__scope__project__projectCategory__self
string
fields__issueType__scope__project__projectTypeKey
string
fields__issueType__scope__project__self
string
fields__issueType__scope__project__simplified
boolean
fields__issueType__scope__type
string
fields__issueType__self
string
fields__issueType__subtask
boolean
fields__issuetype__description
string
fields__issuetype__avatarId
integer
fields__issuetype__entityId
string
fields__issuetype__hierarchyLevel
integer
fields__issuetype__iconUrl
string
fields__issuetype__id
string
fields__issuetype__name
string
fields__issuetype__scope__project__avatarUrls__16x16
string
fields__issuetype__scope__project__avatarUrls__24x24
string
fields__issuetype__scope__project__avatarUrls__32x32
string
fields__issuetype__scope__project__avatarUrls__48x48
string
fields__issuetype__scope__project__id
string
fields__issuetype__scope__project__key
string
fields__issuetype__scope__project__name
string
fields__issuetype__scope__project__projectCategory__description
string
fields__issuetype__scope__project__projectCategory__id
string
fields__issuetype__scope__project__projectCategory__name
string
fields__issuetype__scope__project__projectCategory__self
string
fields__issuetype__scope__project__projectTypeKey
string
fields__issuetype__scope__project__self
string
fields__issuetype__scope__project__simplified
boolean
fields__issuetype__scope__type
string
fields__issuetype__self
string
fields__issuetype__subtask
boolean
fields__priority__description
string
fields__priority__iconUrl
string
fields__priority__id
string
fields__priority__isDefault
boolean
fields__priority__name
string
fields__priority__self
string
fields__priority__statusColor
string
fields__status__description
string
fields__status__iconUrl
string
fields__status__id
string
fields__status__name
string
fields__status__scope__project__avatarUrls__16x16
string
fields__status__scope__project__avatarUrls__24x24
string
fields__status__scope__project__avatarUrls__32x32
string
fields__status__scope__project__avatarUrls__48x48
string
fields__status__scope__project__id
string
fields__status__scope__project__key
string
fields__status__scope__project__name
string
fields__status__scope__project__projectCategory__description
string
fields__status__scope__project__projectCategory__id
string
fields__status__scope__project__projectCategory__name
string
fields__status__scope__project__projectCategory__self
string
fields__status__scope__project__projectTypeKey
string
fields__status__scope__project__self
string
fields__status__scope__project__simplified
boolean
fields__status__scope__type
string
fields__status__self
string
fields__status__statusCategory__colorName
string
fields__status__statusCategory__id
integer
fields__status__statusCategory__key
string
fields__status__statusCategory__name
string
fields__status__statusCategory__self
string
fields__timetracking__originalEstimate
string
fields__timetracking__originalEstimateSeconds
integer
fields__timetracking__remainingEstimate
string
fields__timetracking__remainingEstimateSeconds
integer
fields__timetracking__timeSpent
string
fields__timetracking__timeSpentSeconds
integer
fields__project__id
string
historyMetadata__description
string
historyMetadata__activityDescription
string
historyMetadata__activityDescriptionKey
string
historyMetadata__actor__avatarUrl
string
historyMetadata__actor__displayName
string
historyMetadata__actor__displayNameKey
string
historyMetadata__actor__id
string
historyMetadata__actor__type
string
historyMetadata__actor__url
string
historyMetadata__cause__avatarUrl
string
historyMetadata__cause__displayName
string
historyMetadata__cause__displayNameKey
string
historyMetadata__cause__id
string
historyMetadata__cause__type
string
historyMetadata__cause__url
string
historyMetadata__descriptionKey
string
historyMetadata__emailDescription
string
historyMetadata__emailDescriptionKey
string
historyMetadata__extraData
object
historyMetadata__generator__avatarUrl
string
historyMetadata__generator__displayName
string
historyMetadata__generator__displayNameKey
string
historyMetadata__generator__id
string
historyMetadata__generator__type
string
historyMetadata__generator__url
string
historyMetadata__type
string
properties
array
transition__expand
string
transition__fields
object
transition__hasScreen
boolean
transition__id
string
transition__isAvailable
boolean
transition__isConditional
boolean
transition__isGlobal
boolean
transition__isInitial
boolean
transition__looped
boolean
transition__name
string
transition__to__description
string
transition__to__iconUrl
string
transition__to__id
string
transition__to__name
string
transition__to__scope__project__avatarUrls__16x16
string
transition__to__scope__project__avatarUrls__24x24
string
transition__to__scope__project__avatarUrls__32x32
string
transition__to__scope__project__avatarUrls__48x48
string
transition__to__scope__project__id
string
transition__to__scope__project__key
string
transition__to__scope__project__name
string
transition__to__scope__project__projectCategory__description
string
transition__to__scope__project__projectCategory__id
string
transition__to__scope__project__projectCategory__name
string
transition__to__scope__project__projectCategory__self
string
transition__to__scope__project__projectTypeKey
string
transition__to__scope__project__self
string
transition__to__scope__project__simplified
boolean
transition__to__scope__type
string
transition__to__self
string
transition__to__statusCategory__colorName
string
transition__to__statusCategory__id
integer
transition__to__statusCategory__key
string
transition__to__statusCategory__name
string
transition__to__statusCategory__self
string
update
object

Action Response

data
object
successful
boolean
error

The text describes an operation that assigns custom field contexts to projects, which fails if a project is already assigned a context. administer jira global permission is needed.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
projectIds
arrayRequired

Action Response

data
object
successful
boolean
error

Sets the default workflow for a workflow scheme’s draft. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
updateDraftIfNeeded
boolean
workflow
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint shows user-accessible issue fields, factoring in availability, visibility, project context, and permissions. editability requires certain flags and permissions, with exceptions for fields like attachments. anonymous use is permitted.

Action Parameters

issueIdOrKey
stringRequired
overrideScreenSecurity
boolean
overrideEditableFlag
boolean

Action Response

data
object
successful
boolean
error

Fetches all common project roles and their details. can be accessed without login. requires ‘administer jira’ or ‘administer projects’ permissions.

Action Parameters

projectIdOrKey
stringRequired
currentMember
boolean
excludeConnectAddons
boolean

Action Response

data
object
successful
boolean
error

Returns the current announcement banner configuration. permissions required: administer jira global permission.

Action Parameters

Action Response

data
object
successful
boolean
error

The operation searches for and filters active users based on a string and property, displays them within a range, allows anonymous access, respects privacy, and needs ‘browse users and groups’ permission for results.

Action Parameters

query
string
username
string
accountId
string
startAt
integer
maxResults
integerDefaults to 50
property
string

Action Response

data
object
successful
boolean
error

Revives archived or recycled jira projects. requires ‘administer jira’ for company-managed or ‘administer jira’/‘administer projects’ for team-managed projects.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

The text provides instructions for jira administrators to manage application roles via a specific configuration page, noting that the “administer jira” global permission is required.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns all modules registered dynamically by the calling app. permissions required: only connect apps can make this request.

Action Parameters

Action Response

data
object
successful
boolean
error

Draft a workflow scheme by cloning an active one; an active scheme allows only one draft. admin rights in jira are needed.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieve paginated custom field contexts from jira: get all, filter by ids, issue types, or project scope (global or limited). admin rights required.

Action Parameters

fieldId
stringRequired
isAnyIssueType
boolean
isGlobalContext
boolean
contextId
array
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Deletes a dashboard. permissions required: none the dashboard to be deleted must be owned by the user.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

New field configuration with optional fields is created, mirroring default settings, for company-managed projects. administer jira global permission is needed.

Action Parameters

description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

Appends issue type to screen scheme mappings to an issue type screen scheme. permissions required: administer jira global permission.

Action Parameters

issueTypeScreenSchemeId
stringRequired
issueTypeMappings
arrayRequired

Action Response

data
object
successful
boolean
error

Updates the name of a screen tab. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
tabId
integerRequired
id
integer
name
stringRequired

Action Response

data
object
successful
boolean
error

Lists ids and timestamps of worklogs updated after a specific time, limited to 1000 per page and ordered by date. pagination available with until and nextpage. excludes last minute updates. viewing requires jira access and specific permissions.

Action Parameters

since
integer
expand
string

Action Response

data
object
successful
boolean
error

Retrieves an attachment’s metadata without returning the file. accessible anonymously; requires ‘browse projects’ permission and, if applicable, issue-level security permission.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Updating a workflow transition modifies an existing property or adds a new one if it’s not present, altering the transition’s behavior. administer jira global permission is required. more info on transition and workflow properties is available online.

Action Parameters

transitionId
integerRequired
key
stringRequired
workflowName
stringRequired
workflowMode
string
id
string
value
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves field metadata for a project and issuetype to use in issue creation on atlassian. accessible anonymously with ‘create issues’ project permission needed.

Action Parameters

projectIdOrKey
stringRequired
issueTypeId
stringRequired
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

The api returns a paginated list of statuses based on name or project searches. requires ‘administer projects’ and ‘administer jira’ permissions.

Action Parameters

expand
string
projectId
string
startAt
integer
maxResults
integerDefaults to 200
searchString
string
statusCategory
string

Action Response

data
object
successful
boolean
error

Copies a dashboard. any values provided in the dashboard parameter replace those in the copied dashboard. permissions required: none the dashboard to be copied must be owned by or shared with the user.

Action Parameters

id
stringRequired
description
string
editPermissions
arrayRequired
name
stringRequired
sharePermissions
arrayRequired

Action Response

data
object
successful
boolean
error

To create workflows and their statuses in jira, users need ‘administer jira’ permission for global workflows and ‘administer projects’ for project-specific ones.

Action Parameters

scope__project__id
string
scope__type
string
statuses
arrayRequired
workflows
arrayRequired

Action Response

data
object
successful
boolean
error

Updates a custom field. permissions required: administer jira global permission.

Action Parameters

fieldId
stringRequired
description
string
name
string
searcherKey
string

Action Response

data
object
successful
boolean
error

You can delete a workflow scheme in jira only if it’s not currently active. admin rights are required for this action.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Adds a worklog to a jira issue. requires time tracking enabled and “browse projects” & “work on issues” permissions. allows anonymous access but may need issue-level security permission.

Action Parameters

issueIdOrKey
stringRequired
notifyUsers
booleanDefaults to True
adjustEstimate
stringDefaults to auto
newEstimate
string
reduceBy
string
expand
string
overrideEditableFlag
boolean
author__accountId
string
author__accountType
string
author__active
boolean
author__avatarUrls__16x16
string
author__avatarUrls__24x24
string
author__avatarUrls__32x32
string
author__avatarUrls__48x48
string
author__displayName
string
author__emailAddress
string
author__key
string
author__name
string
author__self
string
author__timeZone
string
comment
created
string
id
string
issueId
string
properties
array
self
string
started
string
timeSpent
string
timeSpentSeconds
integer
updateAuthor__accountId
string
updateAuthor__accountType
string
updateAuthor__active
boolean
updateAuthor__avatarUrls__16x16
string
updateAuthor__avatarUrls__24x24
string
updateAuthor__avatarUrls__32x32
string
updateAuthor__avatarUrls__48x48
string
updateAuthor__displayName
string
updateAuthor__emailAddress
string
updateAuthor__key
string
updateAuthor__name
string
updateAuthor__self
string
updateAuthor__timeZone
string
updated
string
visibility__identifier
string
visibility__type
string
visibility__value
string

Action Response

data
object
successful
boolean
error

The operation returns a worklog if time tracking is enabled in jira. accessible anonymously, it requires ‘browse projects’ permission, issue-level security permission, and visibility group/role if restrictions apply. see links for setup details.

Action Parameters

issueIdOrKey
stringRequired
id
stringRequired
expand
string

Action Response

data
object
successful
boolean
error

To delete a project in jira, it must not be archived. first, restore it using the jira ui, if necessary. administer jira global permission is required.

Action Parameters

projectIdOrKey
stringRequired
enableUndo
booleanDefaults to True

Action Response

data
object
successful
boolean
error

Adds a field to a screen tab. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
tabId
integerRequired
fieldId
stringRequired

Action Response

data
object
successful
boolean
error

Creates a group. permissions required: site administration (that is, member of the site-admin group).

Action Parameters

name
stringRequired

Action Response

data
object
successful
boolean
error

This operation allows deletion of a custom field option in jira, but cascading options must be removed first. it applies to jira-created fields, not connect app fields. requires jira admin permissions.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
optionId
integerRequired

Action Response

data
object
successful
boolean
error

Returns a list of all issue resolution values. permissions required: permission to access jira.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns details for the current user. permissions required: permission to access jira.

Action Parameters

expand
string

Action Response

data
object
successful
boolean
error

Returns a project type. this operation can be accessed anonymously. permissions required: none.

Action Parameters

projectTypeKey
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of assignable users in projects, filtering by attributes. it picks from a start point and up to a max, often returning fewer users. privacy settings may hide some info. can be accessed anonymously; no permissions required.

Action Parameters

query
string
username
string
accountId
string
projectKeys
stringRequired
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Sets the workflow for an issue type in a workflow scheme’s draft. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
issueType
stringRequired
updateDraftIfNeeded
boolean
workflow
string

Action Response

data
object
successful
boolean
error

Returns a paginated list of the screens a field is used in. permissions required: administer jira global permission.

Action Parameters

fieldId
stringRequired
startAt
integer
maxResults
integerDefaults to 100
expand
string

Action Response

data
object
successful
boolean
error

The text describes how transition properties affect workflow transitions in jira, linking to related resources. admin rights are necessary to make changes.

Action Parameters

transitionId
integerRequired
includeReservedKeys
boolean
key
string
workflowName
stringRequired
workflowMode
stringDefaults to live

Action Response

data
object
successful
boolean
error

Sets the time tracking settings. permissions required: administer jira global permission.

Action Parameters

defaultUnit
stringRequired
timeFormat
stringRequired
workingDaysPerWeek
integerRequired
workingHoursPerDay
integerRequired

Action Response

data
object
successful
boolean
error

Admins can use an api to receive an email with a csv link for archived issues; it includes system fields but not custom ones. jira/site admin rights, a premium/enterprise plan, and sign-in are needed. only one active request is allowed.

Action Parameters

archivedBy
array
archivedDateRange__dateAfter
string
archivedDateRange__dateBefore
string
issueTypes
array
projects
array
reporters
array

Action Response

data
object
successful
boolean
error

Use the “delete and replace version” feature to swap version values in jira, as deleting a version clears fields without alternatives. anonymous access allowed with proper admin permissions.

Action Parameters

id
stringRequired
moveFixIssuesTo
string
moveAffectedIssuesTo
string

Action Response

data
object
successful
boolean
error

Returns licensing information about the jira instance. permissions required: none.

Action Parameters

Action Response

data
object
successful
boolean
error

Deletes the workflow-issue type mapping for a workflow in a workflow scheme’s draft. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
workflowName
stringRequired

Action Response

data
object
successful
boolean
error

To remove a project’s default data classification level, users need ‘administer projects’ project permission and ‘administer jira’ global permission.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a notification scheme. permissions required: administer jira global permission.

Action Parameters

notificationSchemeId
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of project-issue type mappings with applicable custom field context ids. if no specific context is assigned, a default one is used. duplicates aren’t allowed in the request. administer jira global permission is required.

Action Parameters

fieldId
stringRequired
startAt
integer
maxResults
integerDefaults to 50
mappings
arrayRequired

Action Response

data
object
successful
boolean
error

Updates statuses by id, requiring “administer projects” and “administer jira” permissions. more info at provided atlassian links.

Action Parameters

statuses
arrayRequired

Action Response

data
object
successful
boolean
error

Deletes a screen tab. permissions required: administer jira global permission.

Action Parameters

screenId
integerRequired
tabId
integerRequired

Action Response

data
object
successful
boolean
error

This operation anonymously retrieves all comments from an issue. users need “browse projects” permission, issue-level security permission, and must belong to the right group or role if comments have visibility restrictions.

Action Parameters

issueIdOrKey
stringRequired
startAt
integer
maxResults
integerDefaults to 5000
orderBy
string
expand
string

Action Response

data
object
successful
boolean
error

The feature checks if a user watches issues from a list; invalid ids return false. it requires “watch issues” permission, project browsing, and issue security access. details on jira config and permissions.

Action Parameters

issueIds
arrayRequired

Action Response

data
object
successful
boolean
error

Selects a time tracking provider. permissions required: administer jira global permission.

Action Parameters

key
stringRequired
name
string
url
string

Action Response

data
object
successful
boolean
error

The text describes a system that allows creation of a security scheme with up to 100 levels and members per level, requiring “administer jira” global permissions.

Action Parameters

description
string
levels
array
name
stringRequired

Action Response

data
object
successful
boolean
error

This operation anonymously returns a filter if it’s owned by the user, shared within their group or project, or is public. no permissions required.

Action Parameters

id
integerRequired
expand
string
overrideSharePermissions
boolean

Action Response

data
object
successful
boolean
error

Retrieves all comment property keys; accessible anonymously with ‘browse projects’ permission, issue-level security permission if set, and visibility restrictions adherence if applicable.

Action Parameters

commentId
stringRequired

Action Response

data
object
successful
boolean
error

An authorized connect app with a matching addonkey can delete its property. also, forge apps can delete properties if they share the app.connect.key.

Action Parameters

addonKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Access workflow features with workflow/project id, including scope, types, rules, and sources. admin rights required. api gives details for validators/conditions and post functions.

Action Parameters

workflowId
string
projectId
string
issueTypeId
string

Action Response

data
object
successful
boolean
error

Retrieves a comment’s value anonymously, needing ‘browse projects’ permission, issue-level security permission if set, and visibility group/role restrictions compliance if applied.

Action Parameters

commentId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Jira has a default time tracking provider, with more available via atlassian marketplace apps. admin rights are needed for access and configuration. for details, visit the time tracking provider module.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns a paginated list of custom field options, both normal and cascading, in display order for jira contexts. for connect app select list options, use specified issue custom field options operations. admin jira permissions required.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
optionId
integer
onlyOptions
boolean
startAt
integer
maxResults
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Deletes a forge app’s property. permissions required: only forge apps can make this request.

Action Parameters

propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of dashboards owned by or shared with the user. the list may be filtered to include only favorite or owned dashboards. this operation can be accessed anonymously. permissions required: none.

Action Parameters

filter
string
startAt
integer
maxResults
integerDefaults to 20

Action Response

data
object
successful
boolean
error

Returns filtered audit records based on matches in specified fields, date range, and requires ‘administer jira’ global permission. filters include summary, category, event source, and various objectitem attributes.

Action Parameters

offset
integer
limit
integerDefaults to 1000
filter
string
from
string
to
string

Action Response

data
object
successful
boolean
error

This operation retrieves a project version and is publicly accessible. however, browsing the project containing the version necessitates the “browse projects” permission.

Action Parameters

id
stringRequired
expand
string

Action Response

data
object
successful
boolean
error

Issue types can be added to a jira custom field context, limiting its application to those types only. if types are already present, the add fails. admin permissions needed.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
issueTypeIds
arrayRequired

Action Response

data
object
successful
boolean
error

Workflow scheme draft in jira can have issue types set and a default workflow assigned. unassigned issue types default to this workflow. admin permissions are required.

Action Parameters

id
integerRequired
workflowName
stringRequired
defaultMapping
boolean
issueTypes
array
updateDraftIfNeeded
boolean
workflow
string

Action Response

data
object
successful
boolean
error

Assign issue types to workflows within a scheme, setting a default workflow for unmapped types. active schemes require updatedraftifneeded set to true to edit. admin rights needed.

Action Parameters

id
integerRequired
workflowName
stringRequired
defaultMapping
boolean
issueTypes
array
updateDraftIfNeeded
boolean
workflow
string

Action Response

data
object
successful
boolean
error

Returns a project category. permissions required: permission to access jira.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

The text announces the deprecation of an issue priority deletion api, referring to the changelog for details. the deletion process is asynchronous, requiring admin permissions for jira, with status updates accessible via provided links.

Action Parameters

id
stringRequired
replaceWith
stringRequired

Action Response

data
object
successful
boolean
error

Reset filter column settings to default for filters owned by the user, those in shared groups, private projects with browse permission, public projects, and public filters. permission to access jira required.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Updates a screen scheme. only screen schemes used in classic projects can be updated. permissions required: administer jira global permission.

Action Parameters

screenSchemeId
stringRequired
description
string
name
string
screens__create
string
screens__default
string
screens__edit
string
screens__view
string

Action Response

data
object
successful
boolean
error

Creates a notification scheme with notifications. you can create up to 1000 notifications per request. permissions required: administer jira global permission.

Action Parameters

description
string
name
stringRequired
notificationSchemeEvents
array

Action Response

data
object
successful
boolean
error

Creates an issue type and adds it to the default issue type scheme. permissions required: administer jira global permission.

Action Parameters

description
string
hierarchyLevel
integer
name
stringRequired
type
string

Action Response

data
object
successful
boolean
error

Returns a paginated list of the users specified by one or more account ids. permissions required: permission to access jira.

Action Parameters

startAt
integer
maxResults
integerDefaults to 10
username
array
key
array
accountId
arrayRequired

Action Response

data
object
successful
boolean
error

Updates a project category. permissions required: administer jira global permission.

Action Parameters

id
stringRequired
description
string
name
string
self
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

expand
string
ruleIds
arrayRequired
workflowEntityId
stringRequired

Action Response

data
object
successful
boolean
error

Removes an issue attachment. anonymous access allowed. requires project permissions: “delete own attachments” for user-created attachments or “delete all attachments” for any attachment.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Creates field configuration schemes for company-managed projects. requires ‘administer jira’ global permission.

Action Parameters

description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

The service displays atlassian account users (active, inactive, deleted) with privacy settings. some details like email might be hidden. ‘browse users and groups’ permission required for more on profile visibility and permissions.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Get jql autocomplete suggestions for a field by specifying fieldname, with optional fieldvalue, predicatename, and predicatevalue. anonymous access is available. no permissions required.

Action Parameters

fieldName
string
fieldValue
string
predicateName
string
predicateValue
string

Action Response

data
object
successful
boolean
error

Update the precomputation value of a function created by a forge/connect app. permissions required: an api for apps to update their own precomputations.

Action Parameters

values
array

Action Response

data
object
successful
boolean
error

Deletes a draft workflow scheme. permissions required: administer jira global permission.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Removes a workflow-issue type mapping from a workflow scheme in jira. active schemes must use updatedraftifneeded for edits, creating or updating a draft that can be published. admin rights required.

Action Parameters

id
integerRequired
workflowName
stringRequired
updateDraftIfNeeded
boolean

Action Response

data
object
successful
boolean
error

Assigns new actors to a project role, replacing current actors. use a different option to add without replacing. requires project admin or jira admin permissions.

Action Parameters

projectIdOrKey
stringRequired
id
integerRequired
categorisedActors
object

Action Response

data
object
successful
boolean
error

Provides a list of alternative issue types sharing the same workflow, field configuration, and screen schemes. accessible without login. no permissions required.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This resource allows for setting custom user data. it doesn’t affect jira user properties. admin rights are needed to modify any user, while self-edit requires jira access.

Action Parameters

accountId
string
userKey
string
username
string
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Webhooks are set for oauth apps; they work if the app owner is the webhook registrar. only connect and oauth 2.0 apps have the necessary permissions to operate this.

Action Parameters

url
stringRequired
webhooks
arrayRequired

Action Response

data
object
successful
boolean
error

Generates a thumbnail for an attachment, accessible without login. requires ‘browse projects’ permission and, if applicable, issue-level security permission. details: get attachment content.

Action Parameters

id
stringRequired
redirect
booleanDefaults to True
fallbackToDefault
booleanDefaults to True
width
integer
height
integer

Action Response

data
object
successful
boolean
error

The text provides instructions for updating a jira custom field context and specifies that the user must have the ‘administer jira’ global permission to do so.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

User can vote on an issue in jira if the voting option is enabled in general configuration. necessary permissions include browsing projects and viewing the issue if issue-level security is set. see provided links for details.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

The text outlines that to access the project’s notification scheme, one needs either the ‘administer jira’ global permission or the ‘administer projects’ project permission.

Action Parameters

projectKeyOrId
stringRequired
expand
string

Action Response

data
object
successful
boolean
error

Returns a user’s email address. this api is only available to apps approved by atlassian, according to these guidelines.

Action Parameters

accountId
stringRequired

Action Response

data
object
successful
boolean
error

This operation removes a property from a user in jira. to delete any user’s property, the ‘administer jira’ permission is needed; to delete from one’s own record, jira access suffices. it does not affect jira’s user properties.

Action Parameters

accountId
string
userKey
string
username
string
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Forge apps can update ui modifications, each with up to 1,000 contexts; a single context can be used in up to 100 such modifications. no permissions needed if no context is set; ‘browse projects’ permission required for context-specific modifications.

Action Parameters

uiModificationId
stringRequired
description
string
contexts
array
data
string
name
string

Action Response

data
object
successful
boolean
error

Updates issue entity properties for up to 100 issues asynchronously; limited to 10 properties per issue with valid json in the request body. the operation is non-transactional, and permissions like ‘browse projects’ and ‘edit issues’ are required.

Action Parameters

issues
array

Action Response

data
object
successful
boolean
error

Deletes a ui modification. all the contexts that belong to the ui modification are deleted too. ui modification can only be deleted by forge apps. permissions required: none.

Action Parameters

uiModificationId
stringRequired

Action Response

data
object
successful
boolean
error

This service provides accessible issue transitions based on status and user permissions. without project permission or issue-level security access, transitions are not listed, even anonymously. transition issues permission is necessary for access.

Action Parameters

issueIdOrKey
stringRequired
expand
string
transitionId
string
skipRemoteOnlyCondition
boolean
includeUnavailableTransitions
boolean
sortByOpsBarAndStatus
boolean

Action Response

data
object
successful
boolean
error

Removes an issue security level member from an issue security scheme. permissions required: administer jira global permission.

Action Parameters

schemeId
stringRequired
levelId
stringRequired
memberId
stringRequired

Action Response

data
object
successful
boolean
error

This api returns valid statuses for project issues, based on issue type. accessible anonymously but requires “browse projects” permission for the relevant project.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

This operation, which can be accessed anonymously, returns worklog property keys but requires ‘browse projects’ permission for the issue’s project, issue-level security permission if applicable, and visibility restriction compliance.

Action Parameters

issueIdOrKey
stringRequired
worklogId
stringRequired

Action Response

data
object
successful
boolean
error

Update a forge app’s custom field settings in jira with “administer jira” global permission; the forge app itself doesn’t need jira permissions.

Action Parameters

fieldIdOrKey
stringRequired
configurations
arrayRequired

Action Response

data
object
successful
boolean
error

Removes a worklog property, available without login. requires ‘browse projects’ permission, issue-level security permission if set, and appropriate group or role if worklog visibility is restricted.

Action Parameters

issueIdOrKey
stringRequired
worklogId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

The text describes how to reset a user preference to default settings in jira, noting that ‘jira.user.locale’ and ‘jira.user.timezone’ are deprecated, and recommending the user management rest api with proper permissions.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

Creates a custom field. permissions required: administer jira global permission.

Action Parameters

description
string
name
stringRequired
searcherKey
string
type
stringRequired

Action Response

data
object
successful
boolean
error

This api endpoint allows updating or creating a property for a jira issue type with a valid json blob up to 32768 characters. administer jira global permission is required.

Action Parameters

issueTypeId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Returns a permission grant. permissions required: permission to access jira.

Action Parameters

schemeId
integerRequired
permissionId
integerRequired
expand
string

Action Response

data
object
successful
boolean
error

Sets default issue security levels for schemes. permissions required: administer jira global permission.

Action Parameters

defaultValues
arrayRequired

Action Response

data
object
successful
boolean
error

Returns all issue events. permissions required: administer jira global permission.

Action Parameters

Action Response

data
object
successful
boolean
error

Get all issue type property keys; anonymous access allowed. requires ‘administer jira’ for any issue type; ‘browse projects’ for permitted projects.

Action Parameters

issueTypeId
stringRequired

Action Response

data
object
successful
boolean
error

Assigns a field config scheme to a project or defaults if null. only for classic projects. requires ‘administer jira’ global permission.

Action Parameters

fieldConfigurationSchemeId
string
projectId
stringRequired

Action Response

data
object
successful
boolean
error

Configures the project’s email sender address; an empty ‘emailaddress’ resets to default. requires ‘administer jira’ or ‘administer projects’ permissions.

Action Parameters

projectId
integerRequired
emailAddress
string
emailAddressStatus
array

Action Response

data
object
successful
boolean
error

Parses and validates jql queries. validation is performed in context of the current user. this operation can be accessed anonymously. permissions required: none.

Action Parameters

validation
stringRequired
queries
arrayRequired

Action Response

data
object
successful
boolean
error

You can anonymously delete an issue unless it has subtasks. to delete subtasks with the issue, use deletesubtasks. required permissions: “browse projects,” “delete issues,” and issue-level security if set.

Action Parameters

issueIdOrKey
stringRequired
deleteSubtasks
stringDefaults to false

Action Response

data
object
successful
boolean
error

The process removes a user’s vote from an issue in jira, which needs ‘allow users to vote on issues’ enabled in general config. permissions needed: ‘browse projects’ for the project and issue-level security if applicable. see jira docs for details.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

The document offers guidance on jql search data, covering fields, functions, and reserved words for crafting jql queries and recommends using post to filter fields per project. access to the operation is unrestricted.

Action Parameters

Action Response

data
object
successful
boolean
error

Deletes a share permission from a filter. permissions required: permission to access jira and the user must own the filter.

Action Parameters

id
integerRequired
permissionId
integerRequired

Action Response

data
object
successful
boolean
error

Access jira’s advanced settings via: jira icon > jira settings > system > general configuration, click advanced settings. requires administer jira permission.

Action Parameters

Action Response

data
object
successful
boolean
error

Use put with form data to set columns for a jira filter. only ‘navigable’ fields allowed, fetched using ‘get fields’. restricted to filters owned by the user, their groups, or projects they have permissions for.

Action Parameters

id
integerRequired
columns
array

Action Response

data
object
successful
boolean
error

Get a filtered, paginated list of workflows with transition rules created by connect or forge apps. can be refined by rule types or keys. some workflows with no rules might appear due to server optimizations. only available to connect/forge apps.

Action Parameters

startAt
integer
maxResults
integerDefaults to 10
types
arrayRequired
keys
array
workflowNames
array
withTags
array
draft
boolean
expand
string

Action Response

data
object
successful
boolean
error

This operation allows anonymous users to delete an issue’s property, provided they have ‘browse projects’ and ‘edit issues’ permissions for the project, and issue-level security permissions if applicable.

Action Parameters

issueIdOrKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

This operation provides urls and keys for an issue’s properties, available anonymously, but requires the user to have browse projects permission and, if applicable, issue-level security permission to view the details.

Action Parameters

issueIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

Returns an app’s property key and value. access is limited to the connect app with a matching addonkey and forge apps with the same app.connect.key. permissions are required.

Action Parameters

addonKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Users can mark filters as favorites in jira if they own it, are in a group it’s shared with, or if it’s shared with a project or the public they have access to. permissions needed.

Action Parameters

id
integerRequired
expand
string

Action Response

data
object
successful
boolean
error

Deletes an in-use project role if a replacement is provided. requires ‘administer jira’ global permission.

Action Parameters

id
integerRequired
swap
integer

Action Response

data
object
successful
boolean
error

Changes the owner of the filter. permissions required: permission to access jira. however, the user must own the filter or have the administer jira global permission.

Action Parameters

id
integerRequired
accountId
stringRequired

Action Response

data
object
successful
boolean
error

The operation counts component-assigned issues and allows anonymous access. it will update oauth 2.0 scopes on june 15, 2024, requiring read:jira-work or granular permissions. no permissions needed currently.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Returns all issue security schemes. permissions required: administer jira global permission.

Action Parameters

Action Response

data
object
successful
boolean
error

Retrieves a paginated list of issue type screen schemes for classic projects. requires ‘administer jira’ global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
id
array
queryString
string
orderBy
stringDefaults to id
expand
string

Action Response

data
object
successful
boolean
error

This operation provides project details and is accessible even without logging in. however, one must have the ‘browse projects’ permission for the specific project to use it.

Action Parameters

projectIdOrKey
stringRequired
expand
string
properties
array

Action Response

data
object
successful
boolean
error

Returns an issue resolution value. permissions required: permission to access jira.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Summarizes issue security level details. ids can be found using the “get issue security scheme”. accessible anonymously with no permissions needed.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves a paginated list of issue type schemes for classic projects. requires “administer jira” global permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
id
array
orderBy
stringDefaults to id
expand
string
queryString
string

Action Response

data
object
successful
boolean
error

Access a filtered, paginated list of dashboards with specific attributes. anonymous users can view public dashboards; logged-in users see more, based on ownership, group, and project access.

Action Parameters

dashboardName
string
accountId
string
owner
string
groupname
string
groupId
string
projectId
integer
orderBy
stringDefaults to name
startAt
integer
maxResults
integerDefaults to 50
status
stringDefaults to active
expand
string

Action Response

data
object
successful
boolean
error

Updated project’s default data classification level; requires ‘administer projects’ project permission and ‘administer jira’ global permission.

Action Parameters

projectIdOrKey
stringRequired
id
stringRequired

Action Response

data
object
successful
boolean
error

This operation appends new issue types to a scheme in jira. if any issue types already exist within the scheme, the process fails. administer jira global permission is required.

Action Parameters

issueTypeSchemeId
integerRequired
issueTypeIds
arrayRequired

Action Response

data
object
successful
boolean
error

Retrieve default settings for custom fields in jira, sorted by ‘contextid’. different fields like date or user picker have varying defaults. no defaults returned if none set. supports forge fields; ‘administer jira’ rights needed.

Action Parameters

fieldId
stringRequired
contextId
array
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

The current time tracking provider is returned; if disabled, an empty response is given. administer jira global permission is required.

Action Parameters

Action Response

data
object
successful
boolean
error

This operation returns all non-paginated versions of a project and allows anonymous access. for a paginated response, use the provided link. ‘browse projects’ permission is required.

Action Parameters

projectIdOrKey
stringRequired
expand
string

Action Response

data
object
successful
boolean
error

Removes issue type to screen scheme mappings from an issue type screen scheme. permissions required: administer jira global permission.

Action Parameters

issueTypeScreenSchemeId
stringRequired
issueTypeIds
arrayRequired

Action Response

data
object
successful
boolean
error

Updates a filter. use this operation to update a filter’s name, description, jql, or sharing. permissions required: permission to access jira, however the user must own the filter.

Action Parameters

id
stringRequired
expand
string
overrideSharePermissions
boolean
description
string
approximateLastUsed
string
editPermissions
array
favourite
boolean
favouritedCount
integer
jql
string
name
stringRequired
owner__accountId
string
owner__accountType
string
owner__active
boolean
owner__applicationRoles__items
array
owner__applicationRoles__max__results
integer
owner__applicationRoles__size
integer
owner__avatarUrls__16x16
string
owner__avatarUrls__24x24
string
owner__avatarUrls__32x32
string
owner__avatarUrls__48x48
string
owner__displayName
string
owner__emailAddress
string
owner__expand
string
owner__groups__items
array
owner__groups__max__results
integer
owner__groups__size
integer
owner__key
string
owner__locale
string
owner__name
string
owner__self
string
owner__timeZone
string
searchUrl
string
self
string
sharePermissions
array
sharedUsers__end__index
integer
sharedUsers__items
array
sharedUsers__max__results
integer
sharedUsers__size
integer
sharedUsers__start__index
integer
subscriptions__end__index
integer
subscriptions__items
array
subscriptions__max__results
integer
subscriptions__size
integer
subscriptions__start__index
integer
viewUrl
string

Action Response

data
object
successful
boolean
error

Update or create select list options for an issue field in connect apps by providing an identical option id in both path and body. admin rights needed; not for jira-built issue fields.

Action Parameters

fieldKey
stringRequired
optionId
integerRequired
config__attributes
array
config__scope__global__attributes
array
config__scope__projects
array
config__scope__projects2
array
id
integerRequired
properties
object
value
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of all status categories. permissions required: permission to access jira.

Action Parameters

Action Response

data
object
successful
boolean
error

Delete field configurations only from company-managed projects. requires ‘administer jira’ global permission. see provided links for details.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

This operation allows reordering of jira custom field options. for connect app fields, use “issue custom field options (apps)” operations. administer jira global permission is required.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
after
string
customFieldOptionIds
arrayRequired
position
string

Action Response

data
object
successful
boolean
error

Assigns an issue security scheme to a project, optionally remapping issue security levels. the task is asynchronous; track status via the ‘location’ link. admin rights required.

Action Parameters

oldToNewSecurityLevelMappings
array
projectId
stringRequired
schemeId
stringRequired

Action Response

data
object
successful
boolean
error

User data is returned with respect to privacy settings, possibly concealing the email. more info on profile visibility and required “browse users and groups” global permission is available online.

Action Parameters

accountId
string
username
string
key
string
expand
string

Action Response

data
object
successful
boolean
error

This operation adds options to select list issue fields specifically for connect apps, not for native jira fields or other methods. each field and option can have up to 10,000 options or scopes. administer jira global permission is required.

Action Parameters

fieldKey
stringRequired
config__attributes
array
config__scope__global__attributes
array
config__scope__projects
array
config__scope__projects2
array
properties
object
value
stringRequired

Action Response

data
object
successful
boolean
error

Permissions needed to update workflows: “administer jira” for all/global workflows, and “administer projects” for project-specific workflows.

Action Parameters

expand
string
statuses
arrayRequired
workflows
arrayRequired

Action Response

data
object
successful
boolean
error

The service provides a paginated list of issue security levels for classic projects, with inclusive filtering by security scheme or level ids. jira administration permission is required.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
id
array
schemeId
array
onlyDefault
boolean

Action Response

data
object
successful
boolean
error

Creates a filter. the filter is shared according to the default share scope. the filter is not selected as a favorite. permissions required: permission to access jira.

Action Parameters

expand
string
overrideSharePermissions
boolean
description
string
approximateLastUsed
string
editPermissions
array
favourite
boolean
favouritedCount
integer
id
string
jql
string
name
stringRequired
owner__accountId
string
owner__accountType
string
owner__active
boolean
owner__applicationRoles__items
array
owner__applicationRoles__max__results
integer
owner__applicationRoles__size
integer
owner__avatarUrls__16x16
string
owner__avatarUrls__24x24
string
owner__avatarUrls__32x32
string
owner__avatarUrls__48x48
string
owner__displayName
string
owner__emailAddress
string
owner__expand
string
owner__groups__items
array
owner__groups__max__results
integer
owner__groups__size
integer
owner__key
string
owner__locale
string
owner__name
string
owner__self
string
owner__timeZone
string
searchUrl
string
self
string
sharePermissions
array
sharedUsers__end__index
integer
sharedUsers__items
array
sharedUsers__max__results
integer
sharedUsers__size
integer
sharedUsers__start__index
integer
subscriptions__end__index
integer
subscriptions__items
array
subscriptions__max__results
integer
subscriptions__size
integer
subscriptions__start__index
integer
viewUrl
string

Action Response

data
object
successful
boolean
error

Deletes an issue type, substituting all instances with an alternative issue type. requires ‘administer jira’ permission. alternative types can be found at the provided resources.

Action Parameters

id
stringRequired
alternativeIssueTypeId
string

Action Response

data
object
successful
boolean
error

Retrieves a paginated list of trashed custom fields matching a string in name/description. requires ‘administer jira’ permission.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
id
array
query
string
expand
string
orderBy
string

Action Response

data
object
successful
boolean
error

To delete a comment property, users need “edit all comments” to delete any property or “edit own comments” to delete their own. additionally, if a comment is restricted, the user must belong to that specific role or group.

Action Parameters

commentId
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a project version and allows substitution with another from the same project. access requires ‘administer jira’ or ‘administer projects’ permissions and can be done anonymously.

Action Parameters

id
stringRequired
customFieldReplacementList
array
moveAffectedIssuesTo
integer
moveFixIssuesTo
integer

Action Response

data
object
successful
boolean
error

Retrieve issue changelogs by their ids; accessible without login. requires ‘browse projects’ permission and, if applicable, issue-level security clearance.

Action Parameters

issueIdOrKey
stringRequired
changelogIds
arrayRequired

Action Response

data
object
successful
boolean
error

Summarize user search for those with issue browsing ability by issuekey or projectkey. limited results due to permissions; privacy settings apply. anonymous access if permitted. see docs for details.

Action Parameters

query
string
username
string
accountId
string
issueKey
string
projectKey
string
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Creates a permission grant in a permission scheme. permissions required: administer jira global permission.

Action Parameters

schemeId
integerRequired
expand
string
holder__expand
string
holder__parameter
string
holder__type
string
holder__value
string
id
integer
permission
string
self
string

Action Response

data
object
successful
boolean
error

Changes the order of issue priorities. permissions required: administer jira global permission.

Action Parameters

after
string
ids
arrayRequired
position
string

Action Response

data
object
successful
boolean
error

The service returns up to 1000 worklog details for specified ids. access requires jira permissions, and worklogs are shown if they’re public or if the user has viewing rights through a project role or group.

Action Parameters

expand
string
ids
arrayRequired

Action Response

data
object
successful
boolean
error

Retrieve a paginated list of configurations for a forge app’s custom field type, filterable by id, fieldcontextid, issueid, or project/issue type. requires jira admin global permission.

Action Parameters

fieldIdOrKey
stringRequired
id
array
fieldContextId
array
issueId
integer
projectKeyOrId
string
issueTypeId
string
startAt
integer
maxResults
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Registers a list of modules. permissions required: only connect apps can make this request.

Action Parameters

modules
arrayRequired

Action Response

data
object
successful
boolean
error

Removes issue type-workflow mapping from a jira workflow scheme. for active schemes, set updatedraftifneeded to true to create/update a draft. admin jira permissions required.

Action Parameters

id
integerRequired
issueType
stringRequired
updateDraftIfNeeded
boolean

Action Response

data
object
successful
boolean
error

The text describes a feature that changes the order of version sequences in a jira project, which is available anonymously but requires ‘browse projects’ permission for the relevant project.

Action Parameters

id
stringRequired
after
string
position
string

Action Response

data
object
successful
boolean
error

This service retrieves and highlights groups based on a search, suggesting matches while filtering unwanted ones. it sorts the results, shows totals, and allows anonymous queries with limited features.

Action Parameters

accountId
string
query
string
exclude
array
excludeId
array
maxResults
integer
caseInsensitive
boolean
userName
string

Action Response

data
object
successful
boolean
error

Summary: admins with “administer jira” global permission can remove issue types from a custom field context, making it applicable to all issue types.

Action Parameters

fieldId
stringRequired
contextId
integerRequired
issueTypeIds
arrayRequired

Action Response

data
object
successful
boolean
error

This api updates workflow schemes in company and team projects instantly; changes in issue statuses trigger issue migrations. admin permissions are required for updates.

Action Parameters

description
stringRequired
version__id
string
version__versionNumber
integer
defaultWorkflowId
string
id
stringRequired
name
stringRequired
statusMappingsByIssueTypeOverride
array
statusMappingsByWorkflows
array
workflowsForIssueTypes
array

Action Response

data
object
successful
boolean
error

Create up to 50 jira issues/subtasks, transition workflow steps, and set properties. define content via ‘update’ and ‘fields’. set ‘issuetype’ and ‘parent’ for subtasks. requires ‘browse projects’ and ‘create issues’ permissions.

Action Parameters

issueUpdates
array

Action Response

data
object
successful
boolean
error

Issue edits update properties but not transitions via update and fields, accessible by key/id. to remove parent, use update.parent.set.none. admins may override screen security; anonymous edits allowed with correct permissions.

Action Parameters

issueIdOrKey
stringRequired
notifyUsers
booleanDefaults to True
overrideScreenSecurity
boolean
overrideEditableFlag
boolean
returnIssue
boolean
expand
string
fields__summary
string
fields__assignee__accountId
string
fields__assignee__accountType
string
fields__assignee__active
boolean
fields__assignee__avatarUrls__16x16
string
fields__assignee__avatarUrls__24x24
string
fields__assignee__avatarUrls__32x32
string
fields__assignee__avatarUrls__48x48
string
fields__assignee__displayName
string
fields__assignee__emailAddress
string
fields__assignee__key
string
fields__assignee__name
string
fields__assignee__self
string
fields__assignee__timeZone
string
fields__issueType__description
string
fields__issueType__avatarId
integer
fields__issueType__entityId
string
fields__issueType__hierarchyLevel
integer
fields__issueType__iconUrl
string
fields__issueType__id
string
fields__issueType__name
string
fields__issueType__scope__project__avatarUrls__16x16
string
fields__issueType__scope__project__avatarUrls__24x24
string
fields__issueType__scope__project__avatarUrls__32x32
string
fields__issueType__scope__project__avatarUrls__48x48
string
fields__issueType__scope__project__id
string
fields__issueType__scope__project__key
string
fields__issueType__scope__project__name
string
fields__issueType__scope__project__projectCategory__description
string
fields__issueType__scope__project__projectCategory__id
string
fields__issueType__scope__project__projectCategory__name
string
fields__issueType__scope__project__projectCategory__self
string
fields__issueType__scope__project__projectTypeKey
string
fields__issueType__scope__project__self
string
fields__issueType__scope__project__simplified
boolean
fields__issueType__scope__type
string
fields__issueType__self
string
fields__issueType__subtask
boolean
fields__issuetype__description
string
fields__issuetype__avatarId
integer
fields__issuetype__entityId
string
fields__issuetype__hierarchyLevel
integer
fields__issuetype__iconUrl
string
fields__issuetype__id
string
fields__issuetype__name
string
fields__issuetype__scope__project__avatarUrls__16x16
string
fields__issuetype__scope__project__avatarUrls__24x24
string
fields__issuetype__scope__project__avatarUrls__32x32
string
fields__issuetype__scope__project__avatarUrls__48x48
string
fields__issuetype__scope__project__id
string
fields__issuetype__scope__project__key
string
fields__issuetype__scope__project__name
string
fields__issuetype__scope__project__projectCategory__description
string
fields__issuetype__scope__project__projectCategory__id
string
fields__issuetype__scope__project__projectCategory__name
string
fields__issuetype__scope__project__projectCategory__self
string
fields__issuetype__scope__project__projectTypeKey
string
fields__issuetype__scope__project__self
string
fields__issuetype__scope__project__simplified
boolean
fields__issuetype__scope__type
string
fields__issuetype__self
string
fields__issuetype__subtask
boolean
fields__priority__description
string
fields__priority__iconUrl
string
fields__priority__id
string
fields__priority__isDefault
boolean
fields__priority__name
string
fields__priority__self
string
fields__priority__statusColor
string
fields__status__description
string
fields__status__iconUrl
string
fields__status__id
string
fields__status__name
string
fields__status__scope__project__avatarUrls__16x16
string
fields__status__scope__project__avatarUrls__24x24
string
fields__status__scope__project__avatarUrls__32x32
string
fields__status__scope__project__avatarUrls__48x48
string
fields__status__scope__project__id
string
fields__status__scope__project__key
string
fields__status__scope__project__name
string
fields__status__scope__project__projectCategory__description
string
fields__status__scope__project__projectCategory__id
string
fields__status__scope__project__projectCategory__name
string
fields__status__scope__project__projectCategory__self
string
fields__status__scope__project__projectTypeKey
string
fields__status__scope__project__self
string
fields__status__scope__project__simplified
boolean
fields__status__scope__type
string
fields__status__self
string
fields__status__statusCategory__colorName
string
fields__status__statusCategory__id
integer
fields__status__statusCategory__key
string
fields__status__statusCategory__name
string
fields__status__statusCategory__self
string
fields__timetracking__originalEstimate
string
fields__timetracking__originalEstimateSeconds
integer
fields__timetracking__remainingEstimate
string
fields__timetracking__remainingEstimateSeconds
integer
fields__timetracking__timeSpent
string
fields__timetracking__timeSpentSeconds
integer
fields__project__id
string
historyMetadata__description
string
historyMetadata__activityDescription
string
historyMetadata__activityDescriptionKey
string
historyMetadata__actor__avatarUrl
string
historyMetadata__actor__displayName
string
historyMetadata__actor__displayNameKey
string
historyMetadata__actor__id
string
historyMetadata__actor__type
string
historyMetadata__actor__url
string
historyMetadata__cause__avatarUrl
string
historyMetadata__cause__displayName
string
historyMetadata__cause__displayNameKey
string
historyMetadata__cause__id
string
historyMetadata__cause__type
string
historyMetadata__cause__url
string
historyMetadata__descriptionKey
string
historyMetadata__emailDescription
string
historyMetadata__emailDescriptionKey
string
historyMetadata__extraData
object
historyMetadata__generator__avatarUrl
string
historyMetadata__generator__displayName
string
historyMetadata__generator__displayNameKey
string
historyMetadata__generator__id
string
historyMetadata__generator__type
string
historyMetadata__generator__url
string
historyMetadata__type
string
properties
array
transition__expand
string
transition__fields
object
transition__hasScreen
boolean
transition__id
string
transition__isAvailable
boolean
transition__isConditional
boolean
transition__isGlobal
boolean
transition__isInitial
boolean
transition__looped
boolean
transition__name
string
transition__to__description
string
transition__to__iconUrl
string
transition__to__id
string
transition__to__name
string
transition__to__scope__project__avatarUrls__16x16
string
transition__to__scope__project__avatarUrls__24x24
string
transition__to__scope__project__avatarUrls__32x32
string
transition__to__scope__project__avatarUrls__48x48
string
transition__to__scope__project__id
string
transition__to__scope__project__key
string
transition__to__scope__project__name
string
transition__to__scope__project__projectCategory__description
string
transition__to__scope__project__projectCategory__id
string
transition__to__scope__project__projectCategory__name
string
transition__to__scope__project__projectCategory__self
string
transition__to__scope__project__projectTypeKey
string
transition__to__scope__project__self
string
transition__to__scope__project__simplified
boolean
transition__to__scope__type
string
transition__to__self
string
transition__to__statusCategory__colorName
string
transition__to__statusCategory__id
integer
transition__to__statusCategory__key
string
transition__to__statusCategory__name
string
transition__to__statusCategory__self
string
update
object

Action Response

data
object
successful
boolean
error

Removes a notification from a notification scheme. permissions required: administer jira global permission.

Action Parameters

notificationSchemeId
stringRequired
notificationId
stringRequired

Action Response

data
object
successful
boolean
error

Adds a gadget to a dashboard. permissions required: none.

Action Parameters

dashboardId
integerRequired
title
string
color
string
ignoreUriAndModuleKeyValidation
boolean
moduleKey
string
position__The__column__position__of__the__gadget
integer
position__The__row__position__of__the__gadget
integer
uri
string

Action Response

data
object
successful
boolean
error

Summary: connect app with matching addonkey can retrieve all its properties. forge apps also have access to these properties if linked to the same app.connect.key. permissions required.

Action Parameters

addonKey
stringRequired

Action Response

data
object
successful
boolean
error

Anonymous users can delete a component if they have either “administer projects” permission for the related project or “administer jira” global permission. see provided links for details.

Action Parameters

id
stringRequired
moveIssuesTo
string

Action Response

data
object
successful
boolean
error

The service fetches issue details by id/key, allowing case-insensitive searches and direct matches without redirect. it supports anonymous access given proper browsing and viewing permissions.

Action Parameters

issueIdOrKey
stringRequired
fields
array
fieldsByKeys
boolean
expand
string
properties
array
updateHistory
boolean

Action Response

data
object
successful
boolean
error

Returns a paginated list of resolutions from company-managed projects in jira, filterable by resolution ids and default field configurations. access requires jira permissions.

Action Parameters

startAt
stringDefaults to 0
maxResults
stringDefaults to 50
id
array
onlyDefault
boolean

Action Response

data
object
successful
boolean
error

Returns data policy for the workspace.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. this operation can be accessed anonymously. permissions required: none.

Action Parameters

type
stringRequired

Action Response

data
object
successful
boolean
error

This operation allows connect apps to delete their own post functions, conditions, and validators from workflows. permissions are exclusive to connect apps.

Action Parameters

workflows
arrayRequired

Action Response

data
object
successful
boolean
error

Returns all classification levels. permissions required: none.

Action Parameters

status
array
orderBy
string

Action Response

data
object
successful
boolean
error

Provides a paginated list of custom field context to issue type mappings, ordered by context and issue type ids. available for all or specific contexts. requires jira admin global permission.

Action Parameters

fieldId
stringRequired
contextId
array
startAt
integer
maxResults
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Returns the project’s sender email address. permissions required: browse projects project permission for the project.

Action Parameters

projectId
integerRequired

Action Response

data
object
successful
boolean
error

An email notification for an issue is created and queued, requiring ‘browse projects’ permission for the project and, if set up, issue-level security permission.

Action Parameters

issueIdOrKey
stringRequired
htmlBody
string
restrict__groupIds
array
restrict__groups
array
restrict__permissions
array
subject
string
textBody
string
to__assignee
boolean
to__groupIds
array
to__groups
array
to__reporter
boolean
to__users
array
to__voters
boolean
to__watchers
boolean

Action Response

data
object
successful
boolean
error

This api returns a list of a function’s precomputations, including creation, update, and last-used timestamps, and each has a jql fragment (value). access is exclusively for apps to inspect their own functions.

Action Parameters

functionKey
array
startAt
integer
maxResults
integerDefaults to 100
orderBy
string

Action Response

data
object
successful
boolean
error

Permissions vary by context (global, project, issue, comment) in a system; project rights can change with issue data. global permissions are constant, and some operations don’t require login or permissions.

Action Parameters

projectKey
string
projectId
string
issueKey
string
issueId
string
permissions
string
projectUuid
string
projectConfigurationUuid
string
commentId
string

Action Response

data
object
successful
boolean
error

This api endpoint retrieves all property keys for a project and is accessible without login. users need ‘browse projects’ permission for access.

Action Parameters

projectIdOrKey
stringRequired

Action Response

data
object
successful
boolean
error

This operation assigns issue types to field configs in a scheme, limited to company-managed projects, and requires administer jira global permission.

Action Parameters

id
integerRequired
mappings
arrayRequired

Action Response

data
object
successful
boolean
error

Returns the workflow-issue type mappings for a workflow scheme. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
workflowName
string
returnDraftIfExists
boolean

Action Response

data
object
successful
boolean
error

This legacy api creates a jira user; if the user exists with jira access, it returns a 201 status; without access, a 400 status. admin jira permissions are required. it will be deprecated for a better option.

Action Parameters

applicationKeys
array
displayName
string
emailAddress
stringRequired
key
string
name
string
password
string
products
array
self
string

Action Response

data
object
successful
boolean
error

Deletes a custom field permanently, asynchronous operation, track status via ‘location’ link. requires ‘administer jira’ global permission. more info on deletion at atlassian documentation.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Updates the issue security scheme. permissions required: administer jira global permission.

Action Parameters

id
stringRequired
description
string
name
string

Action Response

data
object
successful
boolean
error

Retrieves attachment contents with optional byte range. use ‘get attachment thumbnail’ for images. accessible anonymously, but requires ‘browse projects’ permission and issue-level security access if set. see http range header for byte ranges.

Action Parameters

id
stringRequired
redirect
booleanDefaults to True

Action Response

data
object
successful
boolean
error

This operation retrieves select list options from an issue field, but only for those added by connect apps. it won’t work with options made directly in jira. administer jira permission is needed, but not jira permissions for the app’s field.

Action Parameters

fieldKey
stringRequired
optionId
integerRequired

Action Response

data
object
successful
boolean
error

Returns the default actors for the project role. permissions required: administer jira global permission.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

The text describes that a user can retrieve an issue security scheme and its levels if they have “administer jira” global permission or “administer projects” permission for a project using the scheme.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Stores custom data in a project property on jira using a valid json blob (up to 32,768 chars). accessible anonymously but requires ‘administer jira’ or ‘administer projects’ permissions.

Action Parameters

projectIdOrKey
stringRequired
propertyKey
stringRequired

Action Response

data
object
successful
boolean
error

Returns the workflow-issue type mappings for a workflow scheme’s draft. permissions required: administer jira global permission.

Action Parameters

id
integerRequired
workflowName
string

Action Response

data
object
successful
boolean
error

The text outlines how to get status mappings for updating workflow schemes in jira, specifying that permissions such as ‘administer jira’ and ‘administer projects’ are required for updates.

Action Parameters

defaultWorkflowId
string
id
stringRequired
workflowsForIssueTypes
arrayRequired

Action Response

data
object
successful
boolean
error

Property added to workflow transition alters behavior. details at atlassian docs. requires ‘administer jira’ global permission. more info: transition & workflow properties links.

Action Parameters

transitionId
integerRequired
key
stringRequired
workflowName
stringRequired
workflowMode
stringDefaults to live
id
string
value
stringRequired

Action Response

data
object
successful
boolean
error

Resource lists up to 1000 deleted worklog ids and timestamps after a specified date, with pagination using until and nextpage. excludes entries deleted in the last minute. jira access permission needed.

Action Parameters

since
integer

Action Response

data
object
successful
boolean
error

Get a single application property by specifying a key or an array of all editable properties. administer jira rights required. see links for property descriptions and permissions.

Action Parameters

key
string
permissionLevel
string
keyFilter
string

Action Response

data
object
successful
boolean
error

Add up to 1000 notifications to a scheme, note that emailaddress type is deprecated in cloud. administer jira global permission is required. see changelog and permissions docs for details.

Action Parameters

id
stringRequired
notificationSchemeEvents
arrayRequired

Action Response

data
object
successful
boolean
error

Draft workflow schemes allow edits to active workflow schemes. when updated, a draft is made and modified; changes are then applied to the active scheme. only one draft per active scheme is allowed. admin rights required. more info on links provided.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

The text provides a link to access paginated lists of issue type schemes and their associated classic projects in jira. admin jira global permission is required for access.

Action Parameters

startAt
integer
maxResults
integerDefaults to 50
projectId
arrayRequired

Action Response

data
object
successful
boolean
error

The function fetches various filter share permissions, including those for groups, projects, and public access, while enabling anonymous queries for user-specific and public filters.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error