Atlassian Jira Cloud Platform REST API v3
The complete first-party Jira Cloud platform REST API — 617 operations across 421 paths covering issues, projects, users, workflows, fields, screens, permissions, dashboards, filters, webhooks and administration. Harvested verbatim from Atlassian's own published OpenAPI definition.
Atlassian Jira Cloud Platform REST API v3 is one of 12 APIs that Atlassian Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Issue Tracking and Project Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 617 operations across 421 paths, organized into 99 resource areas, and defines 971 schemas. It is described by OpenAPI 3.0.1, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.
Requests are made against a single base URL, https://your-domain.atlassian.net.
617 operations
421 paths
971 schemas
89 DELETE276 GET134 POST118 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Atlassian Jira Cloud Platform REST API v3 declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes.
It accepts HTTP basic authentication (basicAuth).
OAuth2— OAuth2 scopes for JirabasicAuth— You can access this resource via basic auth.
Paths & Operations 617
Across 421 paths, the API surfaces 617 operations — 89 DELETE, 276 GET, 134 POST, 118 PUT. They span 99 resource areas, including Announcement banner, Issue custom field configuration (apps), Issue custom field values (apps), Jira settings, Application roles, Issue attachments, Audit records, Avatars, and 91 more. Each is listed below with its method, path, parameters, and response codes.
Announcement banner 2
This resource represents an announcement banner. Use it to retrieve and update banner configuration.
GET
/rest/api/3/announcementBanner
Get announcement banner configuration
PUT
/rest/api/3/announcementBanner
Update announcement banner configuration
Issue custom field configuration (apps) 3
This resource represents configurations stored against a custom field context by a [Forge app](https://developer.atlassian.com/platform/forge/). Configurations are information use…
POST
/rest/api/3/app/field/context/configuration/list
Bulk get custom field configurations
GET
/rest/api/3/app/field/{fieldIdOrKey}/context/configuration
Get custom field configurations
PUT
/rest/api/3/app/field/{fieldIdOrKey}/context/configuration
Update custom field configurations
Issue custom field values (apps) 2
This resource represents the values of custom fields added by [Forge apps](https://developer.atlassian.com/platform/forge/). Use it to update the value of a custom field on issues.
POST
/rest/api/3/app/field/value
Update custom fields
PUT
/rest/api/3/app/field/{fieldIdOrKey}/value
Update custom field value
Jira settings 4
This resource represents various settings in Jira. Use it to get and update Jira settings and properties.
GET
/rest/api/3/application-properties
Get application property
GET
/rest/api/3/application-properties/advanced-settings
Get advanced settings
PUT
/rest/api/3/application-properties/{id}
Set application property
GET
/rest/api/3/configuration
Get global settings
Application roles 2
This resource represents application roles. Use it to get details of an application role or all application roles.
GET
/rest/api/3/applicationrole
Get all application roles
GET
/rest/api/3/applicationrole/{key}
Get application role
Issue attachments 8
This resource represents issue attachments and the attachment settings for Jira. Use it to get the metadata for an attachment, delete an attachment, and view the metadata for the…
GET
/rest/api/3/attachment/content/{id}
Get attachment content
GET
/rest/api/3/attachment/meta
Get Jira attachment settings
GET
/rest/api/3/attachment/thumbnail/{id}
Get attachment thumbnail
DELETE
/rest/api/3/attachment/{id}
Delete attachment
GET
/rest/api/3/attachment/{id}
Get attachment metadata
GET
/rest/api/3/attachment/{id}/expand/human
Get all metadata for an expanded attachment
GET
/rest/api/3/attachment/{id}/expand/raw
Get contents metadata for an expanded attachment
POST
/rest/api/3/issue/{issueIdOrKey}/attachments
Add attachment
Audit records 1
This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records.
GET
/rest/api/3/auditing/record
Get audit records
Avatars 7
This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project, issue type or priority and obt…
GET
/rest/api/3/avatar/{type}/system
Get system avatars by type
GET
/rest/api/3/universal_avatar/type/{type}/owner/{entityId}
Get avatars
POST
/rest/api/3/universal_avatar/type/{type}/owner/{entityId}
Load avatar
DELETE
/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}
Delete avatar
GET
/rest/api/3/universal_avatar/view/type/{type}
Get avatar image by type
GET
/rest/api/3/universal_avatar/view/type/{type}/avatar/{id}
Get avatar image by ID
GET
/rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}
Get avatar image by owner
Issue bulk operations 9
This resource represents the issue bulk operations. Use it to move multiple issues from one project to another project or edit fields of multiple issues in one go. For additional…
POST
/rest/api/3/bulk/issues/delete
Bulk delete issues
GET
/rest/api/3/bulk/issues/fields
Get bulk editable fields
POST
/rest/api/3/bulk/issues/fields
Bulk edit issues
POST
/rest/api/3/bulk/issues/move
Bulk move issues
GET
/rest/api/3/bulk/issues/transition
Get available transitions
POST
/rest/api/3/bulk/issues/transition
Bulk transition issue statuses
POST
/rest/api/3/bulk/issues/unwatch
Bulk unwatch issues
POST
/rest/api/3/bulk/issues/watch
Bulk watch issues
GET
/rest/api/3/bulk/queue/{taskId}
Get bulk issue operation progress
Issues 24
This resource represents Jira issues. Use it to: create or edit issues, individually or in bulk. retrieve metadata about the options for creating or editing issues. delete an issu…
POST
/rest/api/3/changelog/bulkfetch
Bulk fetch changelogs
GET
/rest/api/3/events
Get events
POST
/rest/api/3/issue
Create issue
POST
/rest/api/3/issue/archive
Archive issue(s) by JQL
PUT
/rest/api/3/issue/archive
Archive issue(s) by issue ID/key
POST
/rest/api/3/issue/bulk
Bulk create issue
POST
/rest/api/3/issue/bulkfetch
Bulk fetch issues
GET
/rest/api/3/issue/createmetadeprecated
Get create issue metadata
GET
/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
Get create metadata issue types for a project
GET
/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
Get create field metadata for a project and issue type id
GET
/rest/api/3/issue/limit/adf/report
Get issue adf limit report
GET
/rest/api/3/issue/limit/report
Get issue limit report
PUT
/rest/api/3/issue/unarchive
Unarchive issue(s) by issue keys/ID
DELETE
/rest/api/3/issue/{issueIdOrKey}
Delete issue
GET
/rest/api/3/issue/{issueIdOrKey}
Get issue
PUT
/rest/api/3/issue/{issueIdOrKey}
Edit issue
PUT
/rest/api/3/issue/{issueIdOrKey}/assignee
Assign issue
GET
/rest/api/3/issue/{issueIdOrKey}/changelog
Get changelogs
POST
/rest/api/3/issue/{issueIdOrKey}/changelog/list
Get changelogs by IDs
GET
/rest/api/3/issue/{issueIdOrKey}/editmeta
Get edit issue metadata
POST
/rest/api/3/issue/{issueIdOrKey}/notify
Send notification for issue
GET
/rest/api/3/issue/{issueIdOrKey}/transitions
Get transitions
POST
/rest/api/3/issue/{issueIdOrKey}/transitions
Transition issue
PUT
/rest/api/3/issues/archive/export
Export archived issue(s)
Classification levels 1
This resource represents classification levels.
GET
/rest/api/3/classification-levels
Get all classification levels
Issue comments 6
This resource represents issue comments. Use it to: get, create, update, and delete a comment from an issue. get all comments from issue. get a list of comments by comment ID.
POST
/rest/api/3/comment/list
Get comments by IDs
GET
/rest/api/3/issue/{issueIdOrKey}/comment
Get comments
POST
/rest/api/3/issue/{issueIdOrKey}/comment
Add comment
DELETE
/rest/api/3/issue/{issueIdOrKey}/comment/{id}
Delete comment
GET
/rest/api/3/issue/{issueIdOrKey}/comment/{id}
Get comment
PUT
/rest/api/3/issue/{issueIdOrKey}/comment/{id}
Update comment
Issue comment properties 4
This resource represents [issue comment](api-group-Issue-comments) properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issu…
GET
/rest/api/3/comment/{commentId}/properties
Get comment property keys
DELETE
/rest/api/3/comment/{commentId}/properties/{propertyKey}
Delete comment property
GET
/rest/api/3/comment/{commentId}/properties/{propertyKey}
Get comment property
PUT
/rest/api/3/comment/{commentId}/properties/{propertyKey}
Set comment property
Project components 8
This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component.
GET
/rest/api/3/component
Find components for projects
POST
/rest/api/3/component
Create component
DELETE
/rest/api/3/component/{id}
Delete component
GET
/rest/api/3/component/{id}
Get component
PUT
/rest/api/3/component/{id}
Update component
GET
/rest/api/3/component/{id}/relatedIssueCounts
Get component issues count
GET
/rest/api/3/project/{projectIdOrKey}/component
Get project components paginated
GET
/rest/api/3/project/{projectIdOrKey}/components
Get project components
Field schemes 15
This resource represents field schemes which are replacing field configuration schemes to control field associations. They are currently in beta and only available to customers wh…
GET
/rest/api/3/config/fieldschemes
Get field schemes
POST
/rest/api/3/config/fieldschemes
Create field scheme
DELETE
/rest/api/3/config/fieldschemes/fields
Remove fields associated with field schemes
PUT
/rest/api/3/config/fieldschemes/fields
Update fields associated with field schemes
DELETE
/rest/api/3/config/fieldschemes/fields/parameters
Remove field parameters
PUT
/rest/api/3/config/fieldschemes/fields/parameters
Update field parameters
GET
/rest/api/3/config/fieldschemes/projects
Get projects with field schemes
PUT
/rest/api/3/config/fieldschemes/projects
Associate projects to field schemes
DELETE
/rest/api/3/config/fieldschemes/{id}
Delete a field scheme
GET
/rest/api/3/config/fieldschemes/{id}
Get field scheme
PUT
/rest/api/3/config/fieldschemes/{id}
Update field scheme
POST
/rest/api/3/config/fieldschemes/{id}/clone
Clone field scheme
GET
/rest/api/3/config/fieldschemes/{id}/fields
Search field scheme fields
GET
/rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters
Get field parameters
GET
/rest/api/3/config/fieldschemes/{id}/projects
Search field scheme projects
Time tracking 5
This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time track…
GET
/rest/api/3/configuration/timetracking
Get selected time tracking provider
PUT
/rest/api/3/configuration/timetracking
Select time tracking provider
GET
/rest/api/3/configuration/timetracking/list
Get all time tracking providers
GET
/rest/api/3/configuration/timetracking/options
Get time tracking settings
PUT
/rest/api/3/configuration/timetracking/options
Set time tracking settings
Issue custom field options 7
This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types: Checkboxes. Radio Buttons.…
GET
/rest/api/3/customFieldOption/{id}
Get custom field option
GET
/rest/api/3/field/{fieldId}/context/{contextId}/option
Get custom field options (context)
POST
/rest/api/3/field/{fieldId}/context/{contextId}/option
Create custom field options (context)
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/option
Update custom field options (context)
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/option/move
Reorder custom field options (context)
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}
Delete custom field options (context)
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue
Replace custom field options
Dashboards 17
This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards.
GET
/rest/api/3/dashboard
Get all dashboards
POST
/rest/api/3/dashboard
Create dashboard
PUT
/rest/api/3/dashboard/bulk/edit
Bulk edit dashboards
GET
/rest/api/3/dashboard/gadgets
Get available gadgets
GET
/rest/api/3/dashboard/search
Search for dashboards
GET
/rest/api/3/dashboard/{dashboardId}/gadget
Get gadgets
POST
/rest/api/3/dashboard/{dashboardId}/gadget
Add gadget to dashboard
DELETE
/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
Remove gadget from dashboard
PUT
/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
Update gadget on dashboard
GET
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties
Get dashboard item property keys
DELETE
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
Delete dashboard item property
GET
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
Get dashboard item property
PUT
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
Set dashboard item property
DELETE
/rest/api/3/dashboard/{id}
Delete dashboard
GET
/rest/api/3/dashboard/{id}
Get dashboard
PUT
/rest/api/3/dashboard/{id}
Update dashboard
POST
/rest/api/3/dashboard/{id}/copy
Copy dashboard
App data policies 2
This resource represents app access rule data policies.
GET
/rest/api/3/data-policy
Get data policy for the workspace
GET
/rest/api/3/data-policy/project
Get data policy for projects
Jira expressions 3
This resource is a collection of operations for [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
POST
/rest/api/3/expression/analyse
Analyse Jira expression
POST
/rest/api/3/expression/evaldeprecated
Currently being removed. Evaluate Jira expression
POST
/rest/api/3/expression/evaluate
Evaluate Jira expression using enhanced search API
Issue fields 11
This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields.
GET
/rest/api/3/field
Get fields
POST
/rest/api/3/field
Create custom field
GET
/rest/api/3/field/search
Get fields paginated
GET
/rest/api/3/field/search/trashed
Get fields in trash paginated
PUT
/rest/api/3/field/{fieldId}
Update custom field
GET
/rest/api/3/field/{fieldId}/association/project
Get field project associations
GET
/rest/api/3/field/{fieldId}/contextsdeprecated
Get contexts for a field
DELETE
/rest/api/3/field/{id}
Delete custom field
POST
/rest/api/3/field/{id}/restore
Restore custom field from trash
POST
/rest/api/3/field/{id}/trash
Move custom field to trash
GET
/rest/api/3/projects/fields
Get fields for projects
Issue custom field associations 2
This resource represents the fields associated to project and issue type contexts. Use it to: assign custom field to projects and issue types.
DELETE
/rest/api/3/field/association
Remove associations
PUT
/rest/api/3/field/association
Create associations
Issue custom field contexts 14
This resource represents issue custom field contexts. Use it to: get, create, update, and delete custom field contexts. get context to issue types and projects mappings. get custo…
GET
/rest/api/3/field/{fieldId}/context
Get custom field contexts
POST
/rest/api/3/field/{fieldId}/context
Create custom field context
GET
/rest/api/3/field/{fieldId}/context/defaultValuedeprecated
Get custom field contexts default values
PUT
/rest/api/3/field/{fieldId}/context/defaultValuedeprecated
Set custom field contexts default values
GET
/rest/api/3/field/{fieldId}/context/defaultValues
Get default values for a custom field grouped by context and issue type
GET
/rest/api/3/field/{fieldId}/context/issuetypemapping
Get issue types for custom field context
POST
/rest/api/3/field/{fieldId}/context/mapping
Get custom field contexts for projects and issue types
GET
/rest/api/3/field/{fieldId}/context/projectmapping
Get project mappings for custom field context
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}
Delete custom field context
PUT
/rest/api/3/field/{fieldId}/context/{contextId}
Update custom field context
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/issuetype
Add issue types to context
POST
/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove
Remove issue types from context
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/project
Assign custom field context to projects
POST
/rest/api/3/field/{fieldId}/context/{contextId}/project/remove
Remove custom field context from projects
Screens 7
This resource represents the screens used to record issue details. Use it to: get details of all screens. get details of all the fields available for use on screens. create screen…
GET
/rest/api/3/field/{fieldId}/screens
Get screens for a field
GET
/rest/api/3/screens
Get screens
POST
/rest/api/3/screens
Create screen
POST
/rest/api/3/screens/addToDefault/{fieldId}
Add field to default screen
DELETE
/rest/api/3/screens/{screenId}
Delete screen
PUT
/rest/api/3/screens/{screenId}
Update screen
GET
/rest/api/3/screens/{screenId}/availableFields
Get available screen fields
Issue custom field options (apps) 8
This resource represents custom issue field select list options created by a Connect app. See [Issue custom field options](api-group-Issue-custom-field-options) to manipulate opti…
GET
/rest/api/3/field/{fieldKey}/option
Get all issue field options
POST
/rest/api/3/field/{fieldKey}/option
Create issue field option
GET
/rest/api/3/field/{fieldKey}/option/suggestions/edit
Get selectable issue field options
GET
/rest/api/3/field/{fieldKey}/option/suggestions/search
Get visible issue field options
DELETE
/rest/api/3/field/{fieldKey}/option/{optionId}
Delete issue field option
GET
/rest/api/3/field/{fieldKey}/option/{optionId}
Get issue field option
PUT
/rest/api/3/field/{fieldKey}/option/{optionId}
Update issue field option
DELETE
/rest/api/3/field/{fieldKey}/option/{optionId}/issue
Replace issue field option
Issue field configurations 15
This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes.
GET
/rest/api/3/fieldconfigurationdeprecated
Get all field configurations
POST
/rest/api/3/fieldconfigurationdeprecated
Create field configuration
DELETE
/rest/api/3/fieldconfiguration/{id}deprecated
Delete field configuration
PUT
/rest/api/3/fieldconfiguration/{id}deprecated
Update field configuration
GET
/rest/api/3/fieldconfiguration/{id}/fieldsdeprecated
Get field configuration items
PUT
/rest/api/3/fieldconfiguration/{id}/fieldsdeprecated
Update field configuration items
GET
/rest/api/3/fieldconfigurationschemedeprecated
Get all field configuration schemes
POST
/rest/api/3/fieldconfigurationschemedeprecated
Create field configuration scheme
GET
/rest/api/3/fieldconfigurationscheme/mappingdeprecated
Get field configuration issue type items
GET
/rest/api/3/fieldconfigurationscheme/projectdeprecated
Get field configuration schemes for projects
PUT
/rest/api/3/fieldconfigurationscheme/projectdeprecated
Assign field configuration scheme to project
DELETE
/rest/api/3/fieldconfigurationscheme/{id}deprecated
Delete field configuration scheme
PUT
/rest/api/3/fieldconfigurationscheme/{id}deprecated
Update field configuration scheme
PUT
/rest/api/3/fieldconfigurationscheme/{id}/mappingdeprecated
Assign issue types to field configurations
POST
/rest/api/3/fieldconfigurationscheme/{id}/mapping/deletedeprecated
Remove issue types from field configuration scheme
Filters 13
This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter…
POST
/rest/api/3/filter
Create filter
GET
/rest/api/3/filter/favourite
Get favorite filters
GET
/rest/api/3/filter/my
Get my filters
GET
/rest/api/3/filter/search
Search for filters
DELETE
/rest/api/3/filter/{id}
Delete filter
GET
/rest/api/3/filter/{id}
Get filter
PUT
/rest/api/3/filter/{id}
Update filter
DELETE
/rest/api/3/filter/{id}/columns
Reset columns
GET
/rest/api/3/filter/{id}/columns
Get columns
PUT
/rest/api/3/filter/{id}/columns
Set columns
DELETE
/rest/api/3/filter/{id}/favourite
Remove filter as favorite
PUT
/rest/api/3/filter/{id}/favourite
Add filter as favorite
PUT
/rest/api/3/filter/{id}/owner
Change filter owner
Filter sharing 6
This resource represents options for sharing [filters](api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters.
GET
/rest/api/3/filter/defaultShareScope
Get default share scope
PUT
/rest/api/3/filter/defaultShareScope
Set default share scope
GET
/rest/api/3/filter/{id}/permission
Get share permissions
POST
/rest/api/3/filter/{id}/permission
Add share permission
DELETE
/rest/api/3/filter/{id}/permission/{permissionId}
Delete share permission
GET
/rest/api/3/filter/{id}/permission/{permissionId}
Get share permission
Issue panels 1
This resource supports bulk pinning and unpinning of [issue panels](https://developer.atlassian.com/platform/forge/) that are added by a Forge app. Only Jira administrators can us…
POST
/rest/api/3/forge/panel/action/bulk/async
Bulk pin or unpin issue panel to projects
Groups 8
This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group nam…
DELETE
/rest/api/3/group
Remove group
GET
/rest/api/3/groupdeprecated
Get group
POST
/rest/api/3/group
Create group
GET
/rest/api/3/group/bulk
Bulk get groups
GET
/rest/api/3/group/member
Get users from group
DELETE
/rest/api/3/group/user
Remove user from group
POST
/rest/api/3/group/user
Add user to group
GET
/rest/api/3/groups/picker
Find groups
Group and user picker 1
This resource represents a list of users and a list of groups. Use it to obtain the details to populate user and group picker suggestions list.
GET
/rest/api/3/groupuserpicker
Find users and groups
License metrics 3
This resource represents license metrics. Use it to get available metrics for Jira licences.
GET
/rest/api/3/instance/license
Get license
GET
/rest/api/3/license/approximateLicenseCount
Get approximate license count
GET
/rest/api/3/license/approximateLicenseCount/product/{applicationKey}
Get approximate application license count
Issue search 7
This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker.
GET
/rest/api/3/issue/picker
Get issue picker suggestions
POST
/rest/api/3/jql/match
Check issues against JQL
GET
/rest/api/3/searchdeprecated
Currently being removed. Search for issues using JQL (GET)
POST
/rest/api/3/searchdeprecated
Currently being removed. Search for issues using JQL (POST)
POST
/rest/api/3/search/approximate-count
Count issues using JQL
GET
/rest/api/3/search/jql
Search for issues using JQL enhanced search (GET)
POST
/rest/api/3/search/jql
Search for issues using JQL enhanced search (POST)
Issue properties 8
This resource represents [issue](api-group-Issues) properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as…
POST
/rest/api/3/issue/properties
Bulk set issues properties by list
POST
/rest/api/3/issue/properties/multi
Bulk set issue properties by issue
DELETE
/rest/api/3/issue/properties/{propertyKey}
Bulk delete issue property
PUT
/rest/api/3/issue/properties/{propertyKey}
Bulk set issue property
GET
/rest/api/3/issue/{issueIdOrKey}/properties
Get issue property keys
DELETE
/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}
Delete issue property
GET
/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}
Get issue property
PUT
/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}
Set issue property
Issue watchers 4
This resource represents users watching an issue. Use it to get details of users watching an issue as well as start and stop a user watching an issue.
POST
/rest/api/3/issue/watching
Get is watching issue bulk
DELETE
/rest/api/3/issue/{issueIdOrKey}/watchers
Delete watcher
GET
/rest/api/3/issue/{issueIdOrKey}/watchers
Get issue watchers
POST
/rest/api/3/issue/{issueIdOrKey}/watchers
Add watcher
Issue remote links 6
This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or gl…
DELETE
/rest/api/3/issue/{issueIdOrKey}/remotelink
Delete remote issue link by global ID
GET
/rest/api/3/issue/{issueIdOrKey}/remotelink
Get remote issue links
POST
/rest/api/3/issue/{issueIdOrKey}/remotelink
Create or update remote issue link
DELETE
/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}
Delete remote issue link by ID
GET
/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}
Get remote issue link by ID
PUT
/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}
Update remote issue link by ID
Issue votes 3
This resource represents votes cast by users on an issue. Use it to get details of votes on an issue as well as cast and withdrawal votes.
DELETE
/rest/api/3/issue/{issueIdOrKey}/votes
Delete vote
GET
/rest/api/3/issue/{issueIdOrKey}/votes
Get votes
POST
/rest/api/3/issue/{issueIdOrKey}/votes
Add vote
Issue worklogs 10
This resource represents issue worklogs. Use it to: get, create, update, and delete worklogs. obtain lists of updated or deleted worklogs.
DELETE
/rest/api/3/issue/{issueIdOrKey}/worklog
Bulk delete worklogs
GET
/rest/api/3/issue/{issueIdOrKey}/worklog
Get issue worklogs
POST
/rest/api/3/issue/{issueIdOrKey}/worklog
Add worklog
POST
/rest/api/3/issue/{issueIdOrKey}/worklog/move
Bulk move worklogs
DELETE
/rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Delete worklog
GET
/rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Get worklog
PUT
/rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Update worklog
GET
/rest/api/3/worklog/deleted
Get IDs of deleted worklogs
POST
/rest/api/3/worklog/list
Get worklogs
GET
/rest/api/3/worklog/updated
Get IDs of updated worklogs
Issue worklog properties 4
This resource represents [issue worklog](api-group-Issue-worklogs) properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete i…
GET
/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties
Get worklog property keys
DELETE
/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}
Delete worklog property
GET
/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}
Get worklog property
PUT
/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}
Set worklog property
Issue links 3
This resource represents links between issues. Use it to get, create, and delete links between issues. To use it, the site must have [issue linking](https://confluence.atlassian.c…
POST
/rest/api/3/issueLink
Create issue link
DELETE
/rest/api/3/issueLink/{linkId}
Delete issue link
GET
/rest/api/3/issueLink/{linkId}
Get issue link
Issue link types 5
This resource represents [issue link](api-group-Issue-links) types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types. To use…
GET
/rest/api/3/issueLinkType
Get issue link types
POST
/rest/api/3/issueLinkType
Create issue link type
DELETE
/rest/api/3/issueLinkType/{issueLinkTypeId}
Delete issue link type
GET
/rest/api/3/issueLinkType/{issueLinkTypeId}
Get issue link type
PUT
/rest/api/3/issueLinkType/{issueLinkTypeId}
Update issue link type
Issue security schemes 16
This resource represents issue security schemes. Use it to get an issue security scheme or a list of issue security schemes. Issue security schemes control which users or groups o…
GET
/rest/api/3/issuesecurityschemes
Get issue security schemes
POST
/rest/api/3/issuesecurityschemes
Create issue security scheme
GET
/rest/api/3/issuesecurityschemes/level
Get issue security levels
PUT
/rest/api/3/issuesecurityschemes/level/default
Set default issue security levels
GET
/rest/api/3/issuesecurityschemes/level/member
Get issue security level members
GET
/rest/api/3/issuesecurityschemes/project
Get projects using issue security schemes
PUT
/rest/api/3/issuesecurityschemes/project
Associate security scheme to project
GET
/rest/api/3/issuesecurityschemes/search
Search issue security schemes
GET
/rest/api/3/issuesecurityschemes/{id}
Get issue security scheme
PUT
/rest/api/3/issuesecurityschemes/{id}
Update issue security scheme
DELETE
/rest/api/3/issuesecurityschemes/{schemeId}
Delete issue security scheme
PUT
/rest/api/3/issuesecurityschemes/{schemeId}/level
Add issue security levels
DELETE
/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
Remove issue security level
PUT
/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
Update issue security level
PUT
/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member
Add issue security level members
DELETE
/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}
Remove member from issue security level
Issue security level 2
This resource represents issue security levels. Use it to obtain the details of any issue security level. For more information about issue security levels, see [Configuring issue-…
GET
/rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members
Get issue security level members by issue security scheme
GET
/rest/api/3/securitylevel/{id}
Get issue security level
Issue types 8
This resource represents issues types. Use it to: get, create, update, and delete issue types. get all issue types for a user. get alternative issue types. set an avatar for an is…
GET
/rest/api/3/issuetype
Get all issue types for user
POST
/rest/api/3/issuetype
Create issue type
GET
/rest/api/3/issuetype/project
Get issue types for project
DELETE
/rest/api/3/issuetype/{id}
Delete issue type
GET
/rest/api/3/issuetype/{id}
Get issue type
PUT
/rest/api/3/issuetype/{id}
Update issue type
GET
/rest/api/3/issuetype/{id}/alternatives
Get alternative issue types
POST
/rest/api/3/issuetype/{id}/avatar2
Load issue type avatar
Issue type properties 4
This resource represents [issue type](api-group-Issue-types) properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type…
GET
/rest/api/3/issuetype/{issueTypeId}/properties
Get issue type property keys
DELETE
/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}
Delete issue type property
GET
/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}
Get issue type property
PUT
/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}
Set issue type property
Issue type schemes 10
This resource represents issue type schemes in classic projects. Use it to: get issue type schemes and a list of the projects that use them. associate issue type schemes with proj…
GET
/rest/api/3/issuetypescheme
Get all issue type schemes
POST
/rest/api/3/issuetypescheme
Create issue type scheme
GET
/rest/api/3/issuetypescheme/mapping
Get issue type scheme items
GET
/rest/api/3/issuetypescheme/project
Get issue type schemes for projects
PUT
/rest/api/3/issuetypescheme/project
Assign issue type scheme to project
DELETE
/rest/api/3/issuetypescheme/{issueTypeSchemeId}
Delete issue type scheme
PUT
/rest/api/3/issuetypescheme/{issueTypeSchemeId}
Update issue type scheme
PUT
/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype
Add issue types to issue type scheme
PUT
/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move
Change order of issue types
DELETE
/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}
Remove issue type from issue type scheme
Issue type screen schemes 11
This resource represents issue type screen schemes. Use it to: get issue type screen schemes and a list of the projects that use them. create issue type screen schemes. update iss…
GET
/rest/api/3/issuetypescreenscheme
Get issue type screen schemes
POST
/rest/api/3/issuetypescreenscheme
Create issue type screen scheme
GET
/rest/api/3/issuetypescreenscheme/mapping
Get issue type screen scheme items
GET
/rest/api/3/issuetypescreenscheme/project
Get issue type screen schemes for projects
PUT
/rest/api/3/issuetypescreenscheme/project
Assign issue type screen scheme to project
DELETE
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}
Delete issue type screen scheme
PUT
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}
Update issue type screen scheme
PUT
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping
Append mappings to issue type screen scheme
PUT
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default
Update issue type screen scheme default screen scheme
POST
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove
Remove mappings from issue type screen scheme
GET
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project
Get issue type screen scheme projects
JQL 6
This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom…
GET
/rest/api/3/jql/autocompletedata
Get field reference data (GET)
POST
/rest/api/3/jql/autocompletedata
Get field reference data (POST)
GET
/rest/api/3/jql/autocompletedata/suggestions
Get field auto complete suggestions
POST
/rest/api/3/jql/parse
Parse JQL query
POST
/rest/api/3/jql/pdcleaner
Convert user identifiers to account IDs in JQL queries
POST
/rest/api/3/jql/sanitize
Sanitize JQL queries
JQL functions (apps) 3
This resource represents JQL function's precomputations. Precomputation is a mapping between custom function call and JQL fragment returned by this function. Use it to get and upd…
GET
/rest/api/3/jql/function/computation
Get precomputations (apps)
POST
/rest/api/3/jql/function/computation
Update precomputations (apps)
POST
/rest/api/3/jql/function/computation/search
Get precomputations by ID (apps)
Labels 1
This resource represents available labels. Use it to get available labels for the global label field.
GET
/rest/api/3/label
Get all labels
Permissions 4
This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.
GET
/rest/api/3/mypermissions
Get my permissions
GET
/rest/api/3/permissions
Get all permissions
POST
/rest/api/3/permissions/check
Get bulk permissions
POST
/rest/api/3/permissions/project
Get permitted projects
Myself 6
This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, an…
DELETE
/rest/api/3/mypreferences
Delete preference
GET
/rest/api/3/mypreferences
Get preference
PUT
/rest/api/3/mypreferences
Set preference
GET
/rest/api/3/mypreferences/locale
Get locale
PUT
/rest/api/3/mypreferences/localedeprecated
Set locale
GET
/rest/api/3/myself
Get current user
Issue notification schemes 8
This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme a…
GET
/rest/api/3/notificationscheme
Get notification schemes paginated
POST
/rest/api/3/notificationscheme
Create notification scheme
GET
/rest/api/3/notificationscheme/project
Get projects using notification schemes paginated
GET
/rest/api/3/notificationscheme/{id}
Get notification scheme
PUT
/rest/api/3/notificationscheme/{id}
Update notification scheme
PUT
/rest/api/3/notificationscheme/{id}/notification
Add notifications to notification scheme
DELETE
/rest/api/3/notificationscheme/{notificationSchemeId}
Delete notification scheme
DELETE
/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}
Remove notification from notification scheme
Permission schemes 9
This resource represents permission schemes. Use it to get, create, update, and delete permission schemes as well as get, create, update, and delete details of the permissions gra…
GET
/rest/api/3/permissionscheme
Get all permission schemes
POST
/rest/api/3/permissionscheme
Create permission scheme
DELETE
/rest/api/3/permissionscheme/{schemeId}
Delete permission scheme
GET
/rest/api/3/permissionscheme/{schemeId}
Get permission scheme
PUT
/rest/api/3/permissionscheme/{schemeId}
Update permission scheme
GET
/rest/api/3/permissionscheme/{schemeId}/permission
Get permission scheme grants
POST
/rest/api/3/permissionscheme/{schemeId}/permission
Create permission grant
DELETE
/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}
Delete permission scheme grant
GET
/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}
Get permission scheme grant
Plans 7
This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans.
GET
/rest/api/3/plans/plan
Get plans paginated
POST
/rest/api/3/plans/plan
Create plan
GET
/rest/api/3/plans/plan/{planId}
Get plan
PUT
/rest/api/3/plans/plan/{planId}
Update plan
PUT
/rest/api/3/plans/plan/{planId}/archive
Archive plan
POST
/rest/api/3/plans/plan/{planId}/duplicate
Duplicate plan
PUT
/rest/api/3/plans/plan/{planId}/trash
Trash plan
Teams in plan 9
This resource represents planning settings for plan-only and Atlassian teams in a plan. Use it to get, create, update and delete planning settings.
GET
/rest/api/3/plans/plan/{planId}/team
Get teams in plan paginated
POST
/rest/api/3/plans/plan/{planId}/team/atlassian
Add Atlassian team to plan
DELETE
/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Remove Atlassian team from plan
GET
/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Get Atlassian team in plan
PUT
/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Update Atlassian team in plan
POST
/rest/api/3/plans/plan/{planId}/team/planonly
Create plan-only team
DELETE
/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Delete plan-only team
GET
/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Get plan-only team
PUT
/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Update plan-only team
Issue priorities 8
This resource represents issue priorities. Use it to get, create and update issue priorities and details for individual issue priorities.
GET
/rest/api/3/prioritydeprecated
Get priorities
POST
/rest/api/3/priority
Create priority
PUT
/rest/api/3/priority/default
Set default priority
PUT
/rest/api/3/priority/move
Move priorities
GET
/rest/api/3/priority/search
Search priorities
DELETE
/rest/api/3/priority/{id}
Delete priority
GET
/rest/api/3/priority/{id}
Get priority
PUT
/rest/api/3/priority/{id}
Update priority
Priority schemes 8
This resource represents issue priority schemes. Use it to get priority schemes and related information, and to create, update and delete priority schemes.
GET
/rest/api/3/priorityscheme
Get priority schemes
POST
/rest/api/3/priorityscheme
Create priority scheme
POST
/rest/api/3/priorityscheme/mappings
Suggested priorities for mappings
GET
/rest/api/3/priorityscheme/priorities/available
Get available priorities by priority scheme
DELETE
/rest/api/3/priorityscheme/{schemeId}
Delete priority scheme
PUT
/rest/api/3/priorityscheme/{schemeId}
Update priority scheme
GET
/rest/api/3/priorityscheme/{schemeId}/priorities
Get priorities by priority scheme
GET
/rest/api/3/priorityscheme/{schemeId}/projects
Get projects by priority scheme
Projects 13
This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a pro…
GET
/rest/api/3/projectdeprecated
Get all projects
POST
/rest/api/3/project
Create project
GET
/rest/api/3/project/recent
Get recent projects
GET
/rest/api/3/project/search
Get projects paginated
DELETE
/rest/api/3/project/{projectIdOrKey}
Delete project
GET
/rest/api/3/project/{projectIdOrKey}
Get project
PUT
/rest/api/3/project/{projectIdOrKey}
Update project
POST
/rest/api/3/project/{projectIdOrKey}/archive
Archive project
POST
/rest/api/3/project/{projectIdOrKey}/delete
Delete project asynchronously
POST
/rest/api/3/project/{projectIdOrKey}/restore
Restore deleted or archived project
GET
/rest/api/3/project/{projectIdOrKey}/statuses
Get all statuses for project
GET
/rest/api/3/project/{projectId}/hierarchy
Get project issue type hierarchy
GET
/rest/api/3/project/{projectKeyOrId}/notificationscheme
Get project notification scheme
Project templates 5
This resource represents project templates. Use it to create a new project from a custom template.
POST
/rest/api/3/project-template
Create custom project
PUT
/rest/api/3/project-template/edit-template
Edit a custom project template
GET
/rest/api/3/project-template/live-template
Gets a custom project template
DELETE
/rest/api/3/project-template/remove-template
Deletes a custom project template
POST
/rest/api/3/project-template/save-template
Save a custom project template
Project types 4
This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type.
GET
/rest/api/3/project/type
Get all project types
GET
/rest/api/3/project/type/accessible
Get licensed project types
GET
/rest/api/3/project/type/{projectTypeKey}
Get project type by key
GET
/rest/api/3/project/type/{projectTypeKey}/accessible
Get accessible project type by key
Project avatars 4
This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars.
PUT
/rest/api/3/project/{projectIdOrKey}/avatar
Set project avatar
DELETE
/rest/api/3/project/{projectIdOrKey}/avatar/{id}
Delete project avatar
POST
/rest/api/3/project/{projectIdOrKey}/avatar2
Load project avatar
GET
/rest/api/3/project/{projectIdOrKey}/avatars
Get all project avatars
Project classification levels 4
This resource represents classification levels used in a project. Use it to view and manage classification levels in your projects.
GET
/rest/api/3/project/{projectIdOrKey}/classification-config
Get the classification configuration for a project
DELETE
/rest/api/3/project/{projectIdOrKey}/classification-level/default
Remove the default data classification level from a project
GET
/rest/api/3/project/{projectIdOrKey}/classification-level/default
Get the default data classification level of a project
PUT
/rest/api/3/project/{projectIdOrKey}/classification-level/default
Update the default data classification level of a project
Project features 2
This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for J…
GET
/rest/api/3/project/{projectIdOrKey}/features
Get project features
PUT
/rest/api/3/project/{projectIdOrKey}/features/{featureKey}
Set project feature state
Project properties 4
This resource represents [project](api-group-Projects) properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties a…
GET
/rest/api/3/project/{projectIdOrKey}/properties
Get project property keys
DELETE
/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}
Delete project property
GET
/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}
Get project property
PUT
/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}
Set project property
Project roles 9
This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.
GET
/rest/api/3/project/{projectIdOrKey}/role
Get project roles for project
GET
/rest/api/3/project/{projectIdOrKey}/role/{id}
Get project role for project
GET
/rest/api/3/project/{projectIdOrKey}/roledetails
Get project role details
GET
/rest/api/3/role
Get all project roles
POST
/rest/api/3/role
Create project role
DELETE
/rest/api/3/role/{id}
Delete project role
GET
/rest/api/3/role/{id}
Get project role by ID
POST
/rest/api/3/role/{id}
Partial update project role
PUT
/rest/api/3/role/{id}
Fully update project role
Project role actors 6
This resource represents the users assigned to [project roles](api-group-Issue-comments). Use it to get, add, and remove default users from project roles. Also use it to add and r…
DELETE
/rest/api/3/project/{projectIdOrKey}/role/{id}
Delete actors from project role
POST
/rest/api/3/project/{projectIdOrKey}/role/{id}
Add actors to project role
PUT
/rest/api/3/project/{projectIdOrKey}/role/{id}
Set actors for project role
DELETE
/rest/api/3/role/{id}/actors
Delete default actors from project role
GET
/rest/api/3/role/{id}/actors
Get default actors for project role
POST
/rest/api/3/role/{id}/actors
Add default actors to project role
Project versions 15
This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by v…
GET
/rest/api/3/project/{projectIdOrKey}/version
Get project versions paginated
GET
/rest/api/3/project/{projectIdOrKey}/versions
Get project versions
POST
/rest/api/3/version
Create version
DELETE
/rest/api/3/version/{id}deprecated
Delete version
GET
/rest/api/3/version/{id}
Get version
PUT
/rest/api/3/version/{id}
Update version
PUT
/rest/api/3/version/{id}/mergeto/{moveIssuesTo}
Merge versions
POST
/rest/api/3/version/{id}/move
Move version
GET
/rest/api/3/version/{id}/relatedIssueCounts
Get version's related issues count
GET
/rest/api/3/version/{id}/relatedwork
Get related work
POST
/rest/api/3/version/{id}/relatedwork
Create related work
PUT
/rest/api/3/version/{id}/relatedwork
Update related work
POST
/rest/api/3/version/{id}/removeAndSwap
Delete and replace version
GET
/rest/api/3/version/{id}/unresolvedIssueCount
Get version's unresolved issues count
DELETE
/rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}
Delete related work
Project email 2
This resource represents the email address used to send a project's notifications. Use it to get and set the [project's sender email address](https://confluence.atlassian.com/x/do…
GET
/rest/api/3/project/{projectId}/email
Get project's sender email
PUT
/rest/api/3/project/{projectId}/email
Set project's sender email
Project permission schemes 4
This resource represents permission schemes for a project. Use this resource to: get details of a project's issue security levels available to the calling user. get the permission…
GET
/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme
Get project issue security scheme
GET
/rest/api/3/project/{projectKeyOrId}/permissionscheme
Get assigned permission scheme
PUT
/rest/api/3/project/{projectKeyOrId}/permissionscheme
Assign permission scheme
GET
/rest/api/3/project/{projectKeyOrId}/securitylevel
Get project issue security levels
Project categories 5
This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual c…
GET
/rest/api/3/projectCategory
Get all project categories
POST
/rest/api/3/projectCategory
Create project category
DELETE
/rest/api/3/projectCategory/{id}
Delete project category
GET
/rest/api/3/projectCategory/{id}
Get project category by ID
PUT
/rest/api/3/projectCategory/{id}
Update project category
Project key and name validation 3
This resource provides validation for project keys and names.
GET
/rest/api/3/projectvalidate/key
Validate project key
GET
/rest/api/3/projectvalidate/validProjectKey
Get valid project key
GET
/rest/api/3/projectvalidate/validProjectName
Get valid project name
Issue redaction 2
This resource represents Issue Redaction. Provides APIs to redact issue data.
POST
/rest/api/3/redact
Redact
GET
/rest/api/3/redact/status/{jobId}
Get redaction status
Issue resolutions 8
This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values.
GET
/rest/api/3/resolutiondeprecated
Get resolutions
POST
/rest/api/3/resolution
Create resolution
PUT
/rest/api/3/resolution/default
Set default resolution
PUT
/rest/api/3/resolution/move
Move resolutions
GET
/rest/api/3/resolution/search
Search resolutions
DELETE
/rest/api/3/resolution/{id}
Delete resolution
GET
/rest/api/3/resolution/{id}
Get resolution
PUT
/rest/api/3/resolution/{id}
Update resolution
Screen tabs 6
This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs.
GET
/rest/api/3/screens/tabs
Get bulk screen tabs
GET
/rest/api/3/screens/{screenId}/tabs
Get all screen tabs
POST
/rest/api/3/screens/{screenId}/tabs
Create screen tab
DELETE
/rest/api/3/screens/{screenId}/tabs/{tabId}
Delete screen tab
PUT
/rest/api/3/screens/{screenId}/tabs/{tabId}
Update screen tab
POST
/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}
Move screen tab
Screen tab fields 4
This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs.
GET
/rest/api/3/screens/{screenId}/tabs/{tabId}/fields
Get all screen tab fields
POST
/rest/api/3/screens/{screenId}/tabs/{tabId}/fields
Add screen tab field
DELETE
/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}
Remove screen tab field
POST
/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move
Move screen tab field
Screen schemes 4
This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes.
GET
/rest/api/3/screenscheme
Get screen schemes
POST
/rest/api/3/screenscheme
Create screen scheme
DELETE
/rest/api/3/screenscheme/{screenSchemeId}
Delete screen scheme
PUT
/rest/api/3/screenscheme/{screenSchemeId}
Update screen scheme
Server info 1
This resource provides information about the Jira instance.
GET
/rest/api/3/serverInfo
Get Jira instance info
Issue navigator settings 2
This resource represents issue navigator settings. Use it to get and set issue navigator default columns.
GET
/rest/api/3/settings/columns
Get issue navigator default columns
PUT
/rest/api/3/settings/columns
Set issue navigator default columns
Workflow statuses 2
This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status.
GET
/rest/api/3/status
Get all statuses
GET
/rest/api/3/status/{idOrName}
Get status
Workflow status categories 2
This resource represents status categories. Use it to obtain a list of all status categories and the details of a category. Status categories provided a mechanism for categorizing…
GET
/rest/api/3/statuscategory
Get all status categories
GET
/rest/api/3/statuscategory/{idOrKey}
Get status category
Status 9
This resource represents statuses. Use it to search, get, create, delete, and change statuses.
DELETE
/rest/api/3/statuses
Bulk delete Statuses
GET
/rest/api/3/statuses
Bulk get statuses
POST
/rest/api/3/statuses
Bulk create statuses
PUT
/rest/api/3/statuses
Bulk update statuses
GET
/rest/api/3/statuses/byNames
Bulk get statuses by name
GET
/rest/api/3/statuses/search
Search statuses paginated
GET
/rest/api/3/statuses/{statusId}/project/{projectId}/issueTypeUsages
Get issue type usages by status and project
GET
/rest/api/3/statuses/{statusId}/projectUsages
Get project usages by status
GET
/rest/api/3/statuses/{statusId}/workflowUsages
Get workflow usages by status
Tasks 2
This resource represents a [long-running asynchronous tasks](async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task.
GET
/rest/api/3/task/{taskId}
Get task
POST
/rest/api/3/task/{taskId}/cancel
Cancel task
UI modifications (apps) 4
UI modifications is a feature available for Forge apps only. It enables Forge apps to control how selected Jira and Jira Service Management fields behave on the following views: J…
GET
/rest/api/3/uiModifications
Get UI modifications
POST
/rest/api/3/uiModifications
Create UI modification
DELETE
/rest/api/3/uiModifications/{uiModificationId}
Delete UI modification
PUT
/rest/api/3/uiModifications/{uiModificationId}
Update UI modification
Users 13
This resource represent users. Use it to: get, get a list of, create, and delete users. get, set, and reset a user's default issue table columns. get a list of the groups the user…
DELETE
/rest/api/3/user
Delete user
GET
/rest/api/3/user
Get user
POST
/rest/api/3/user
Create user
GET
/rest/api/3/user/bulk
Bulk get users
GET
/rest/api/3/user/bulk/migration
Get account IDs for users
DELETE
/rest/api/3/user/columns
Reset user default columns
GET
/rest/api/3/user/columns
Get user default columns
PUT
/rest/api/3/user/columns
Set user default columns
GET
/rest/api/3/user/email
Get user email
GET
/rest/api/3/user/email/bulk
Get user email bulk
GET
/rest/api/3/user/groups
Get user groups
GET
/rest/api/3/users
Get all users default
GET
/rest/api/3/users/search
Get all users
User search 8
This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user…
GET
/rest/api/3/user/assignable/multiProjectSearch
Find users assignable to projects
GET
/rest/api/3/user/assignable/search
Find users assignable to issues
GET
/rest/api/3/user/permission/search
Find users with permissions
GET
/rest/api/3/user/picker
Find users for picker
GET
/rest/api/3/user/search
Find users
GET
/rest/api/3/user/search/query
Find users by query
GET
/rest/api/3/user/search/query/key
Find user keys by query
GET
/rest/api/3/user/viewissue/search
Find users with browse permission
User properties 4
This resource represents [user](api-group-Users) properties and provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a…
GET
/rest/api/3/user/properties
Get user property keys
DELETE
/rest/api/3/user/properties/{propertyKey}
Delete user property
GET
/rest/api/3/user/properties/{propertyKey}
Get user property
PUT
/rest/api/3/user/properties/{propertyKey}
Set user property
Webhooks 5
This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register…
DELETE
/rest/api/3/webhook
Delete webhooks by ID
GET
/rest/api/3/webhook
Get dynamic webhooks for app
POST
/rest/api/3/webhook
Register dynamic webhooks
GET
/rest/api/3/webhook/failed
Get failed webhooks
PUT
/rest/api/3/webhook/refresh
Extend webhook life
Workflows 16
This resource represents workflows. Use it to: Get workflows Create workflows Update workflows Delete inactive workflows Get workflow capabilities
POST
/rest/api/3/workflow/history
Read workflow version from history
POST
/rest/api/3/workflow/history/list
List workflow history entries
GET
/rest/api/3/workflow/searchdeprecated
Get workflows paginated
DELETE
/rest/api/3/workflow/{entityId}
Delete inactive workflow
GET
/rest/api/3/workflow/{workflowId}/project/{projectId}/issueTypeUsages
Get issue types in a project that are using a given workflow
GET
/rest/api/3/workflow/{workflowId}/projectUsages
Get projects using a given workflow
GET
/rest/api/3/workflow/{workflowId}/workflowSchemes
Get workflow schemes which are using a given workflow
POST
/rest/api/3/workflows
Bulk get workflows
GET
/rest/api/3/workflows/capabilities
Get available workflow capabilities
POST
/rest/api/3/workflows/create
Bulk create workflows
POST
/rest/api/3/workflows/create/validation
Validate create workflows
GET
/rest/api/3/workflows/defaultEditor
Get the user's default workflow editor
POST
/rest/api/3/workflows/preview
Preview workflow
GET
/rest/api/3/workflows/search
Search workflows
POST
/rest/api/3/workflows/update
Bulk update workflows
POST
/rest/api/3/workflows/update/validation
Validate update workflows
Workflow transition rules 3
This resource represents workflow transition rules. Workflow transition rules define a Connect or a Forge app routine, such as a [workflow post functions](https://developer.atlass…
GET
/rest/api/3/workflow/rule/config
Get workflow transition rule configurations
PUT
/rest/api/3/workflow/rule/config
Update workflow transition rule configurations
PUT
/rest/api/3/workflow/rule/config/delete
Delete workflow transition rule configurations
Workflow schemes 19
This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types. A workflow scheme maps issue types to workflows.…
GET
/rest/api/3/workflowscheme
Get all workflow schemes
POST
/rest/api/3/workflowscheme
Create workflow scheme
POST
/rest/api/3/workflowscheme/project/switch
Switch workflow scheme for project
POST
/rest/api/3/workflowscheme/read
Bulk get workflow schemes
POST
/rest/api/3/workflowscheme/update
Update workflow scheme
POST
/rest/api/3/workflowscheme/update/mappings
Get required status mappings for workflow scheme update
DELETE
/rest/api/3/workflowscheme/{id}
Delete workflow scheme
GET
/rest/api/3/workflowscheme/{id}
Get workflow scheme
PUT
/rest/api/3/workflowscheme/{id}
Classic update workflow scheme
DELETE
/rest/api/3/workflowscheme/{id}/default
Delete default workflow
GET
/rest/api/3/workflowscheme/{id}/default
Get default workflow
PUT
/rest/api/3/workflowscheme/{id}/default
Update default workflow
DELETE
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Delete workflow for issue type in workflow scheme
GET
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Get workflow for issue type in workflow scheme
PUT
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Set workflow for issue type in workflow scheme
DELETE
/rest/api/3/workflowscheme/{id}/workflow
Delete issue types for workflow in workflow scheme
GET
/rest/api/3/workflowscheme/{id}/workflow
Get issue types for workflows in workflow scheme
PUT
/rest/api/3/workflowscheme/{id}/workflow
Set issue types for workflow in workflow scheme
GET
/rest/api/3/workflowscheme/{workflowSchemeId}/projectUsages
Get projects which are using a given workflow scheme
Workflow scheme project associations 2
This resource represents the associations between workflow schemes and projects. For more information, see [Managing your workflows](https://confluence.atlassian.com/x/q4hKLg).
GET
/rest/api/3/workflowscheme/project
Get workflow scheme project associations
PUT
/rest/api/3/workflowscheme/project
Assign workflow scheme to project
Workflow scheme drafts 14
This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes. A workflow scheme maps issue types to workflows. A workflow scheme can be associated…
POST
/rest/api/3/workflowscheme/{id}/createdraft
Create draft workflow scheme
DELETE
/rest/api/3/workflowscheme/{id}/draft
Delete draft workflow scheme
GET
/rest/api/3/workflowscheme/{id}/draft
Get draft workflow scheme
PUT
/rest/api/3/workflowscheme/{id}/draft
Update draft workflow scheme
DELETE
/rest/api/3/workflowscheme/{id}/draft/default
Delete draft default workflow
GET
/rest/api/3/workflowscheme/{id}/draft/default
Get draft default workflow
PUT
/rest/api/3/workflowscheme/{id}/draft/default
Update draft default workflow
DELETE
/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}
Delete workflow for issue type in draft workflow scheme
GET
/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}
Get workflow for issue type in draft workflow scheme
PUT
/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}
Set workflow for issue type in draft workflow scheme
POST
/rest/api/3/workflowscheme/{id}/draft/publish
Publish draft workflow scheme
DELETE
/rest/api/3/workflowscheme/{id}/draft/workflow
Delete issue types for workflow in draft workflow scheme
GET
/rest/api/3/workflowscheme/{id}/draft/workflow
Get issue types for workflows in draft workflow scheme
PUT
/rest/api/3/workflowscheme/{id}/draft/workflow
Set issue types for workflow in workflow scheme
App properties 8
This resource represents app properties. Use it to store arbitrary data for your [Connect app](https://developer.atlassian.com/cloud/jira/platform/index/connect-apps).
GET
/rest/atlassian-connect/1/addons/{addonKey}/properties
Get app properties
DELETE
/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
Delete app property
GET
/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
Get app property
PUT
/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
Set app property
GET
/rest/forge/1/app/properties
Get app property keys (Forge)
DELETE
/rest/forge/1/app/properties/{propertyKey}
Delete app property (Forge)
GET
/rest/forge/1/app/properties/{propertyKey}
Get app property (Forge)
PUT
/rest/forge/1/app/properties/{propertyKey}
Set app property (Forge)
Dynamic modules 3
This resource represents [modules registered dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/) by [Connect apps](https://developer.atlassian.com/c…
DELETE
/rest/atlassian-connect/1/app/module/dynamic
Remove modules
GET
/rest/atlassian-connect/1/app/module/dynamic
Get modules
POST
/rest/atlassian-connect/1/app/module/dynamic
Register modules
App migration 3
This resource supports [app migrations](https://developer.atlassian.com/platform/app-migration/). Use it to: - [to request migrated workflow rules details](https://developer.atlas…
PUT
/rest/atlassian-connect/1/migration/field
Bulk update custom field value
PUT
/rest/atlassian-connect/1/migration/properties/{entityType}
Bulk update entity properties
POST
/rest/atlassian-connect/1/migration/workflow/rule/search
Get workflow transition rule configurations
Migration of Connect modules to Forge 2
This resource supports the migration of some Connect modules to their equivalent Forge modules.
GET
/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task
Get Connect issue field migration task
POST
/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task
Submit Connect issue field migration task
Service Registry 1
This resource represents a service registry. Use it to retrieve attributes related to a [service registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is…
GET
/rest/atlassian-connect/1/service-registry
Retrieve the attributes of service registries
Operations 1
POST
/rest/internal/api/latest/worklog/bulk
Get worklogs by issue id and worklog id
Schemas 971
The contract defines 971 schemas that model the data the API accepts and returns. The most detailed are JsonNode (36 properties), Project (34 properties), JiraIssueFields (23 properties), Version (19 properties). Each schema is shown below with its type and property counts.
ActorInputBean
object
3 properties
ActorsMap
object
3 properties
AddAtlassianTeamRequest
object
5 properties
2 required
AddFieldBean
object
1 property
1 required
AddGroupBean
object
1 property
1 required
AddNotificationsDetails
object
Details of notifications which should be added to the notification scheme.
1 property
1 required
AddSecuritySchemeLevelsRequestBean
object
1 property
AnnouncementBannerConfiguration
object
Announcement banner configuration.
5 properties
AnnouncementBannerConfigurationUpdate
object
Configuration of the announcement banner.
4 properties
AppWorkflowTransitionRule
object
A workflow transition rule.
4 properties
3 required
Application
object
The application the linked item is in.
2 properties
ApplicationProperty
object
Details of an application property.
9 properties
ApplicationRole
object
Details of an application role.
14 properties
ApprovalConfiguration
object
The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals.
8 properties
6 required
ApprovalConfigurationPreview
object
Approval configuration.
3 properties
ArchiveIssueAsyncRequest
object
1 property
ArchivedIssuesFilterRequest
object
Details of a filter for exporting archived issues.
5 properties
AssociateFieldConfigurationsWithIssueTypesRequest
object
Details of a field configuration to issue type mappings.
1 property
1 required
AssociateSecuritySchemeWithProjectDetails
object
Issue security scheme, project, and remapping details.
3 properties
2 required
AssociatedItemBean
object
Details of an item associated with the changed record.
5 properties
AssociationContextObject
object
Field association for example PROJECT\ID.
2 properties
1 required
Attachment
object
Details about an attachment.
9 properties
AttachmentArchive
object
4 properties
AttachmentArchiveEntry
object
5 properties
AttachmentArchiveImpl
object
2 properties
AttachmentArchiveItemReadable
object
Metadata for an item in an attachment archive.
5 properties
AttachmentArchiveMetadataReadable
object
Metadata for an archive (for example a zip) and its contents.
5 properties
AttachmentMetadata
object
Metadata for an issue attachment.
10 properties
AttachmentSettings
object
Details of the instance's attachment settings.
2 properties
AuditRecordBean
object
An audit record.
11 properties
AuditRecords
object
Container for a list of audit records.
4 properties
AutoCompleteSuggestion
object
A field auto-complete suggestion.
2 properties
AutoCompleteSuggestions
object
The results from a JQL query.
1 property
AvailableDashboardGadget
object
The details of the available dashboard gadget.
3 properties
1 required
AvailableDashboardGadgetsResponse
object
The list of available gadgets.
1 property
1 required
AvailableWorkflowConnectRule
object
The Connect provided ecosystem rules available.
9 properties
AvailableWorkflowForgeRule
object
The Forge provided ecosystem rules available.
5 properties
AvailableWorkflowSystemRule
object
The Atlassian provided system rules available.
7 properties
7 required
AvailableWorkflowTriggerTypes
object
The list of available trigger types.
3 properties
AvailableWorkflowTriggers
object
The trigger rules available.
2 properties
2 required
Avatar
object
Details of an avatar.
7 properties
1 required
AvatarUrlsBean
object
4 properties
Avatars
object
Details about system and custom avatars.
2 properties
BoardColumnPayload
object
The payload for creating a board column
4 properties
BoardFeaturePayload
object
The payload for setting a board feature
2 properties
BoardFeaturesPayload
object
Configuration of features for one or more boards. Replaces the deprecated features field on BoardPayload
1 property
BoardPayload
object
The payload for creating a board
13 properties
BoardsPayload
object
1 property
BulkChangeOwnerDetails
object
Details for changing owners of shareable entities
2 properties
2 required
BulkChangelogRequestBean
object
Request bean for bulk changelog retrieval
4 properties
1 required
BulkChangelogResponseBean
object
A page of changelogs which is designed to handle multiple issues
2 properties
BulkContextualConfiguration
object
Details of the contextual configuration for a custom field.
5 properties
3 required
BulkCustomFieldOptionCreateRequest
object
Details of the options to create for a custom field.
1 property
BulkCustomFieldOptionUpdateRequest
object
Details of the options to update for a custom field.
1 property
BulkEditActionError
object
Errors of bulk edit action.
2 properties
2 required
BulkEditGetFields
object
Bulk Edit Get Fields Response.
3 properties
BulkEditShareableEntityRequest
object
Details of a request to bulk edit shareable entity.
5 properties
2 required
BulkEditShareableEntityResponse
object
Details of a request to bulk edit shareable entity.
2 properties
1 required
BulkFetchIssueRequestBean
object
5 properties
1 required
BulkIssueIsWatching
object
A container for the watch status of a list of issues.
1 property
BulkIssuePropertyUpdateRequest
object
Bulk issue property update request details.
3 properties
BulkIssueResults
object
The list of requested issues & fields.
2 properties
BulkOperationErrorResponse
object
1 property
BulkOperationErrorResult
object
3 properties
BulkOperationProgress
object
11 properties
BulkPermissionGrants
object
Details of global and project permissions granted to the user.
2 properties
2 required
BulkPermissionsRequestBean
object
Details of global permissions to look up and project permissions with associated projects and issues to look up.
3 properties
BulkProjectPermissionGrants
object
List of project permissions and the projects and issues those permissions grant access to.
3 properties
3 required
BulkProjectPermissions
object
Details of project permissions and associated issues and projects to look up.
3 properties
1 required
BulkRedactionRequest
object
1 property
BulkRedactionResponse
object
1 property
1 required
BulkTransitionGetAvailableTransitions
object
Bulk Transition Get Available Transitions Response.
3 properties
BulkTransitionSubmitInput
object
2 properties
2 required
BulkWorklogKeyRequestBean
object
1 property
BulkWorklogKeyResponseBean
object
1 property
CardLayout
object
Card layout configuration.
1 property
CardLayoutField
object
Card layout settings of the board
4 properties
ChangeDetails
object
A change item.
7 properties
ChangeFilterOwner
object
The account ID of the new owner.
1 property
1 required
ChangedValueBean
object
Details of names changed in the record event.
3 properties
ChangedWorklog
object
Details of a changed worklog.
3 properties
ChangedWorklogs
object
List of changed worklogs.
6 properties
Changelog
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
ColumnItem
object
Details of an issue navigator column item.
2 properties
ColumnRequestBody
object
1 property
Comment
object
A comment.
12 properties
ComponentIssuesCount
object
Count of issues assigned to a component.
2 properties
ComponentJsonBean
object
6 properties
ComponentWithIssueCount
object
Details about a component with a count of the issues it contains.
13 properties
CompoundClause
object
A JQL query clause that consists of nested clauses. For example, (labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is…
2 properties
2 required
ConditionGroupConfiguration
object
The conditions group associated with the transition.
3 properties
ConditionGroupPayload
object
The payload for creating a condition group in a workflow
3 properties
ConditionGroupUpdate
object
The conditions group associated with the transition.
3 properties
1 required
Configuration
object
Details about the configuration of Jira.
8 properties
ConfigurationsListParameters
object
List of custom fields identifiers which will be used to filter configurations
1 property
1 required
ConnectCustomFieldValue
object
A list of custom field details.
8 properties
3 required
ConnectCustomFieldValues
object
Details of updates for a custom field.
1 property
ConnectModule
object
A [Connect module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the [app descriptor](https://developer.atl…
ConnectModules
object
1 property
1 required
ConnectWorkflowTransitionRule
object
A workflow transition rule.
4 properties
3 required
ContainerForProjectFeatures
object
The list of features on a project.
1 property
ContainerForRegisteredWebhooks
object
Container for a list of registered webhooks. Webhook details are returned in the same order as the request.
1 property
ContainerForWebhookIDs
object
Container for a list of webhook IDs.
1 property
1 required
ContainerOfWorkflowSchemeAssociations
object
A container for a list of workflow schemes together with the projects they are associated with.
1 property
1 required
ContentItem
object
Represents the content to redact
3 properties
3 required
Context
object
A context.
3 properties
ContextDefaultValues
object
Default values grouped by custom field context.
2 properties
1 required
ContextForProjectAndIssueType
object
The project and issue type mapping with a matching custom field context.
3 properties
3 required
ContextualConfiguration
object
Details of the contextual configuration for a custom field.
4 properties
2 required
ConvertedJQLQueries
object
The converted JQL queries.
2 properties
CreateCrossProjectReleaseRequest
object
2 properties
1 required
CreateCustomFieldContext
object
The details of a created custom field context.
5 properties
1 required
CreateCustomFieldRequest
object
2 properties
1 required
CreateDateFieldRequest
object
2 properties
1 required
CreateExclusionRulesRequest
object
6 properties
CreateFieldAssociationSchemeLinksBean
object
2 properties
CreateFieldAssociationSchemeRequest
object
Request object for creating a new field association scheme.
2 properties
1 required
CreateFieldAssociationSchemeResponse
object
Response object after successfully creating a new field association scheme.
4 properties
CreateIssueSecuritySchemeDetails
object
Issue security scheme and it's details
3 properties
1 required
CreateIssueSourceRequest
object
2 properties
2 required
CreateNotificationSchemeDetails
object
Details of an notification scheme.
3 properties
1 required
CreatePermissionHolderRequest
object
2 properties
2 required
CreatePermissionRequest
object
2 properties
2 required
CreatePlanOnlyTeamRequest
object
6 properties
2 required
CreatePlanRequest
object
8 properties
3 required
CreatePriorityDetails
object
Details of an issue priority.
5 properties
2 required
CreatePrioritySchemeDetails
object
Details of a new priority scheme
6 properties
3 required
CreateProjectDetails
object
Details about the project.
19 properties
2 required
CreateResolutionDetails
object
Details of an issue resolution.
2 properties
1 required
CreateSchedulingRequest
object
5 properties
1 required
CreateUiModificationDetails
object
The details of a UI modification.
4 properties
1 required
CreateUpdateRoleRequestBean
object
2 properties
CreatedIssue
object
Details about a created issue or subtask.
5 properties
CreatedIssues
object
Details about the issues created and the errors for requests that failed.
2 properties
CustomContextVariable
object
1 property
1 required
CustomFieldConfigurations
object
Details of configurations for a custom field.
1 property
1 required
CustomFieldContext
object
The details of a custom field context.
5 properties
5 required
CustomFieldContextDefaultValue
object
CustomFieldContextDefaultValueCascadingOption
object
The default value for a cascading select custom field.
4 properties
3 required
CustomFieldContextDefaultValueDate
object
The default value for a Date custom field.
4 properties
2 required
CustomFieldContextDefaultValueDateTime
object
The default value for a date time custom field.
4 properties
2 required
CustomFieldContextDefaultValueFloat
object
Default value for a float (number) custom field.
3 properties
3 required
CustomFieldContextDefaultValueForgeDateTimeField
object
The default value for a Forge date time custom field.
4 properties
2 required
CustomFieldContextDefaultValueForgeGroupField
object
The default value for a Forge group custom field.
3 properties
3 required
CustomFieldContextDefaultValueForgeMultiGroupField
object
The default value for a Forge collection of groups custom field.
3 properties
3 required
CustomFieldContextDefaultValueForgeMultiStringField
object
The default text for a Forge collection of strings custom field.
3 properties
2 required
CustomFieldContextDefaultValueForgeMultiUserField
object
Defaults for a Forge collection of users custom field.
3 properties
3 required
CustomFieldContextDefaultValueForgeNumberField
object
Default value for a Forge number custom field.
3 properties
3 required
CustomFieldContextDefaultValueForgeObjectField
object
The default value for a Forge object custom field.
3 properties
2 required
CustomFieldContextDefaultValueForgeStringField
object
The default text for a Forge string custom field.
3 properties
2 required
CustomFieldContextDefaultValueForgeUserField
object
Defaults for a Forge user custom field.
4 properties
4 required
CustomFieldContextDefaultValueLabels
object
Default value for a labels custom field.
3 properties
3 required
CustomFieldContextDefaultValueMultiUserPicker
object
The default value for a User Picker (multiple) custom field.
3 properties
3 required
CustomFieldContextDefaultValueMultipleGroupPicker
object
The default value for a multiple group picker custom field.
3 properties
3 required
CustomFieldContextDefaultValueMultipleOption
object
The default value for a multi-select custom field.
3 properties
3 required
CustomFieldContextDefaultValueMultipleVersionPicker
object
The default value for a multiple version picker custom field.
4 properties
3 required
CustomFieldContextDefaultValueProject
object
The default value for a project custom field.
3 properties
3 required
CustomFieldContextDefaultValueReadOnly
object
The default text for a read only custom field.
3 properties
2 required
CustomFieldContextDefaultValueSingleGroupPicker
object
The default value for a group picker custom field.
3 properties
3 required
CustomFieldContextDefaultValueSingleOption
object
The default value for a single select custom field.
3 properties
3 required
CustomFieldContextDefaultValueSingleVersionPicker
object
The default value for a version picker custom field.
4 properties
3 required
CustomFieldContextDefaultValueTextArea
object
The default text for a text area custom field.
3 properties
2 required
CustomFieldContextDefaultValueTextField
object
The default text for a text custom field.
3 properties
2 required
CustomFieldContextDefaultValueURL
object
The default value for a URL custom field.
3 properties
3 required
CustomFieldContextDefaultValueUpdate
object
Default values to update.
1 property
CustomFieldContextOption
object
Details of the custom field options for a context.
4 properties
3 required
CustomFieldContextProjectMapping
object
Details of a context to project association.
3 properties
1 required
CustomFieldContextSingleUserPickerDefaults
object
Defaults for a User Picker (single) custom field.
4 properties
4 required
CustomFieldContextUpdateDetails
object
Details of a custom field context.
2 properties
CustomFieldCreatedContextOptionsList
object
A list of custom field options for a context.
1 property
CustomFieldDefinitionJsonBean
object
4 properties
2 required
CustomFieldOption
object
Details of a custom option for a field.
2 properties
CustomFieldOptionCreate
object
Details of a custom field option to create.
3 properties
1 required
CustomFieldOptionUpdate
object
Details of a custom field option for a context.
3 properties
1 required
CustomFieldPayload
object
Defines the payload for the custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/\api-rest-api-3-fi…
7 properties
CustomFieldReplacement
object
Details about the replacement for a deleted version.
2 properties
CustomFieldUpdatedContextOptionsList
object
A list of custom field options for a context.
1 property
CustomFieldValueUpdate
object
A list of issue IDs and the value to update a custom field to.
2 properties
2 required
CustomFieldValueUpdateDetails
object
Details of updates for a custom field.
1 property
CustomTemplateOptions
object
2 properties
CustomTemplateRequestDTO
object
The specific request object for creating a project with template.
11 properties
CustomTemplatesProjectDetails
object
Project Details
12 properties
Dashboard
object
Details of a dashboard.
14 properties
DashboardDetails
object
Details of a dashboard.
4 properties
3 required
DashboardGadget
object
Details of a gadget.
6 properties
4 required
DashboardGadgetPosition
object
Details of a gadget position.
2 properties
2 required
DashboardGadgetResponse
object
The list of gadgets on the dashboard.
1 property
1 required
DashboardGadgetSettings
object
Details of the settings for a dashboard gadget.
6 properties
DashboardGadgetUpdateRequest
object
The details of the gadget to update.
3 properties
DataClassificationLevelsBean
object
The data classification.
1 property
DataClassificationTagBean
object
The data classification.
8 properties
2 required
DateRangeFilterRequest
object
List issues archived within a specified date range.
2 properties
2 required
DefaultLevelValue
object
Details of scheme and new default level.
2 properties
2 required
DefaultShareScope
object
Details of the scope of the default sharing for new filters and dashboards.
1 property
1 required
DefaultWorkflow
object
Details about the default workflow.
2 properties
1 required
DefaultWorkflowEditorResponse
object
1 property
DeleteAndReplaceVersionBean
object
3 properties
DeleteFieldAssociationSchemeResponse
object
Response object after successfully deleting a field association scheme.
2 properties
DetailedErrorCollection
object
3 properties
DocumentVersion
object
The current version details of this workflow scheme.
2 properties
DuplicatePlanRequest
object
1 property
1 required
EditTemplateRequest
object
Request to edit a custom template
4 properties
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
EntityPropertyDetails
object
3 properties
3 required
Error
object
3 properties
ErrorCollection
object
Error messages from an operation.
3 properties
ErrorCollections
object
ErrorMessage
object
1 property
Errors
object
5 properties
EventNotification
object
Details about a notification associated with an event.
10 properties
ExpandPrioritySchemeBean
object
A priority scheme with less fields to be used in for an API expand response.
3 properties
ExpandPrioritySchemePage
object
3 properties
ExportArchivedIssuesTaskProgressResponse
object
The response for status request for a running/completed export task.
6 properties
FailedWebhook
object
Details about a failed webhook.
4 properties
3 required
FailedWebhooks
object
A page of failed webhooks.
3 properties
2 required
Field
object
Details of a field.
16 properties
3 required
FieldAssociationItemPayload
object
Defines the payload for the field association scheme.
6 properties
FieldAssociationParameters
object
3 properties
1 required
FieldAssociationSchemeFieldSearchResult
object
Field association scheme field search results.
5 properties
FieldAssociationSchemeLinks
object
2 properties
FieldAssociationSchemeLinksBean
object
2 properties
FieldAssociationSchemeMatchedFilters
object
Matched filters for field association scheme search.
2 properties
FieldAssociationSchemeProjectSearchResult
object
Project search results for field association scheme.
5 properties
FieldAssociationsRequest
object
Details of field associations with projects.
2 properties
2 required
FieldCapabilityPayload
object
Defines the payload for the fields, screens, screen schemes, issue type screen schemes, field layouts, and field layout schemes
8 properties
FieldChangedClause
object
A clause that asserts whether a field was changed. For example, status CHANGED AFTER startOfMonth(-1M).See [CHANGED](https://confluence.atlassian.com/x/dgiiLQA…
3 properties
3 required
FieldConfiguration
object
Details of a field configuration.
4 properties
3 required
FieldConfigurationDetails
object
Details of a field configuration.
2 properties
1 required
FieldConfigurationIssueTypeItem
object
The field configuration for an issue type.
3 properties
3 required
FieldConfigurationItem
object
A field within a field configuration.
5 properties
1 required
FieldConfigurationItemsDetails
object
Details of field configuration items.
1 property
1 required
FieldConfigurationScheme
object
Details of a field configuration scheme.
3 properties
2 required
FieldConfigurationSchemeProjectAssociation
object
Associated field configuration scheme and project.
2 properties
1 required
FieldConfigurationSchemeProjects
object
Project list with assigned field configuration schema.
2 properties
1 required
FieldConfigurationToIssueTypeMapping
object
The field configuration to issue type mapping.
2 properties
2 required
FieldCreateMetadata
object
The metadata describing an issue field for createmeta.
11 properties
6 required
FieldDetails
object
Details about a field.
10 properties
FieldIdIdentifier
object
FieldIdentifierObject
object
Identifier for a field for example FIELD\ID.
2 properties
1 required
FieldLastUsed
object
Information about the most recent use of a field.
2 properties
FieldLayoutConfiguration
object
Defines the payload for the field layout configuration. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\a…
3 properties
FieldLayoutPayload
object
Defines the payload for the field layouts. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\api-group-issu…
4 properties
FieldLayoutSchemePayload
object
Deprecated use [fieldAssociationScheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/api-group-field-schemes) instead De…
5 properties
FieldMetadata
object
The metadata describing an issue field.
10 properties
5 required
FieldProjectAssociation
object
List of project associations.
1 property
FieldReferenceData
object
Details of a field that can be used in advanced searches.
10 properties
FieldSchemePayload
object
Defines the payload to configure the field scheme for a project. See [Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-fiel…
5 properties
FieldSchemeToFieldsPartialFailure
object
Partial failure result when updating field scheme to fields associations.
5 properties
4 required
FieldSchemeToFieldsResponse
object
Response for updating field associations.
1 property
1 required
FieldSchemeToProjectsPartialFailure
object
Partial failure result when updating field scheme to projects associations.
4 properties
3 required
FieldSchemeToProjectsRequest
object
Request for associating field schemes to projects.
1 property
1 required
FieldSchemeToProjectsResponse
object
Response for updating field scheme to projects associations.
1 property
1 required
FieldUpdateOperation
object
Details of an operation to perform on a field.
5 properties
FieldValueClause
object
A clause that asserts the current value of a field. For example, summary ~ test.
3 properties
3 required
FieldWasClause
object
A clause that asserts a previous value of a field. For example, status WAS "Resolved" BY currentUser() BEFORE "2019/02/02". See [WAS](https://confluence.atlass…
4 properties
4 required
Fields
object
Key fields from the linked issue.
7 properties
FieldsSchemeItemParameter
object
The default parameters to apply to the field across all work types in the specified schemes, may be null if only work type-specific updates are needed
3 properties
FieldsSchemeItemWorkTypeParameter
object
The list of work type-specific parameter overrides, may be empty if only default parameters are being updated
4 properties
Filter
object
Details about a filter.
15 properties
1 required
FilterDetails
object
Details of a filter.
15 properties
1 required
FilterSubscription
object
Details of a user or group subscribing to a filter.
3 properties
FilterSubscriptionsList
object
A paginated list of subscriptions to a filter.
5 properties
ForgePanelProjectPinAsyncResponse
object
1 property
ForgePanelProjectPinRequest
object
2 properties
2 required
FoundGroup
object
A group found in a search.
7 properties
FoundGroups
object
The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.
3 properties
FoundUsers
object
The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.
3 properties
FoundUsersAndGroups
object
List of users and groups found in a search.
2 properties
FromLayoutPayload
object
The payload for the layout details for the start end of a transition
3 properties
FunctionOperand
object
An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functio…
3 properties
2 required
FunctionReferenceData
object
Details of functions that can be used in advanced searches.
5 properties
GetAtlassianTeamResponse
object
5 properties
2 required
GetCrossProjectReleaseResponse
object
2 properties
GetCustomFieldResponse
object
2 properties
1 required
GetDateFieldResponse
object
2 properties
1 required
GetExclusionRulesResponse
object
6 properties
1 required
GetFieldAssociationParametersResponse
object
Response object for getting field association parameters.
3 properties
1 required
GetFieldAssociationSchemeByIdResponse
object
Response object for getting a field association scheme by ID.
6 properties
GetFieldAssociationSchemeResponse
object
Response object for getting a field association scheme.
7 properties
GetIssueSourceResponse
object
2 properties
2 required
GetPermissionHolderResponse
object
2 properties
2 required
GetPermissionResponse
object
2 properties
2 required
GetPlanOnlyTeamResponse
object
7 properties
3 required
GetPlanResponse
object
11 properties
3 required
GetPlanResponseForPage
object
5 properties
4 required
GetProjectsWithFieldSchemesResponse
object
Response item returned from get projects with field schemes.
2 properties
GetSchedulingResponse
object
5 properties
5 required
GetTeamResponseForPage
object
3 properties
2 required
GlobalScopeBean
object
1 property
Group
object
5 properties
GroupDetails
object
Details about a group.
2 properties
GroupLabel
object
A group label.
3 properties
GroupName
object
Details about a group.
3 properties
HealthCheckResult
object
Jira instance health check results. Deprecated and no longer returned.
3 properties
Hierarchy
object
The project issue type hierarchy.
2 properties
HistoryMetadata
object
Details of issue history metadata.
11 properties
HistoryMetadataParticipant
object
Details of user or system associated with a issue history metadata item.
6 properties
Icon
object
An icon. If no icon is defined: for a status icon, no status icon displays in Jira. for the remote object icon, the default link icon displays in Jira.
3 properties
IconBean
object
An icon.
3 properties
IdBean
object
1 property
1 required
IdOrKeyBean
object
2 properties
IncludedFields
object
3 properties
InputStreamSource
object
1 property
IssueArchivalSyncRequest
object
List of Issue Ids Or Keys that are to be archived or unarchived
1 property
IssueArchivalSyncResponse
object
Number of archived/unarchived issues and list of errors that occurred during the action, if any.
2 properties
IssueBean
object
Details about an issue.
15 properties
IssueBulkDeletePayload
object
Issue Bulk Delete Payload
2 properties
1 required
IssueBulkEditField
object
9 properties
IssueBulkEditPayload
object
Issue Bulk Edit Payload
4 properties
3 required
IssueBulkMovePayload
object
Issue Bulk Move Payload
2 properties
1 required
IssueBulkOperationsFieldOption
object
IssueBulkTransitionForWorkflow
object
3 properties
IssueBulkTransitionPayload
object
Issue Bulk Transition Payload
2 properties
1 required
IssueBulkWatchOrUnwatchPayload
object
Issue Bulk Watch Or Unwatch Payload
1 property
1 required
IssueChangeLog
object
List of changelogs that belong to single issue
2 properties
IssueChangelogIds
object
A list of changelog IDs.
1 property
1 required
IssueCommentListRequestBean
object
1 property
1 required
IssueContextVariable
object
An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-referenceissue) specified by ID or key. All the fields of the issue object…
3 properties
1 required
IssueCreateMetadata
object
The wrapper for the issue creation metadata for a list of projects.
2 properties
IssueEntityProperties
object
Lists of issues and entity properties. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more informatio…
2 properties
IssueEntityPropertiesForMultiUpdate
object
An issue ID with entity property values. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more informat…
2 properties
IssueError
object
Describes the error that occurred when retrieving data for a particular issue.
2 properties
IssueEvent
object
Details about an issue event.
2 properties
IssueFieldOption
object
Details of the options for a select list issue field.
4 properties
2 required
IssueFieldOptionConfiguration
object
Details of the projects the option is available in.
2 properties
IssueFieldOptionCreateBean
object
3 properties
1 required
IssueFieldOptionScopeBean
object
3 properties
IssueFilterForBulkPropertyDelete
object
Bulk operation filter details.
2 properties
IssueFilterForBulkPropertySet
object
Bulk operation filter details.
3 properties
IssueLayoutItemPayload
object
Defines the payload to configure the issue layout item for a project.
4 properties
IssueLayoutPayload
object
Defines the payload to configure the issue layouts for a project.
4 properties
IssueLimitReportResponseBean
object
4 properties
IssueLink
object
Details of a link between issues.
5 properties
3 required
IssueLinkType
object
This object is used as follows: In the [ issueLink](api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find…
5 properties
IssueLinkTypes
object
A list of issue link type beans.
1 property
IssueList
object
A list of issue IDs.
1 property
1 required
IssueMatches
object
A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.
1 property
1 required
IssueMatchesForJQL
object
A list of the issues matched to a JQL query or details of errors encountered during matching.
2 properties
2 required
IssuePickerSuggestions
object
A list of issues suggested for use in auto-completion.
1 property
IssuePickerSuggestionsIssueType
object
A type of issue suggested for use in auto-completion.
5 properties
IssueSecurityLevelMember
object
Issue security level member.
3 properties
3 required
IssueSecuritySchemeToProjectMapping
object
Details about an project using security scheme mapping.
2 properties
IssueTransition
object
Details of an issue transition.
11 properties
IssueTransitionStatus
object
2 properties
IssueTypeCreateBean
object
4 properties
1 required
IssueTypeDefaultValue
object
A default value associated with an issue type within a context.
3 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
IssueTypeHierarchyPayload
object
The payload for creating an issue type hierarchy
4 properties
IssueTypeIds
object
The list of issue type IDs.
1 property
1 required
IssueTypeIdsToRemove
object
The list of issue type IDs to be removed from the field configuration scheme.
1 property
1 required
IssueTypeInfo
object
Details of an issue type.
3 properties
IssueTypeIssueCreateMetadata
object
Details of the issue creation metadata for an issue type.
12 properties
IssueTypePayload
object
The payload for creating an issue type
6 properties
IssueTypeProjectCreatePayload
object
The payload for creating issue types in a project
3 properties
IssueTypeScheme
object
Details of an issue type scheme.
5 properties
2 required
IssueTypeSchemeDetails
object
Details of an issue type scheme and its associated issue types.
4 properties
2 required
IssueTypeSchemeID
object
The ID of an issue type scheme.
1 property
1 required
IssueTypeSchemeMapping
object
Issue type scheme item.
2 properties
2 required
IssueTypeSchemePayload
object
The payload for creating issue type schemes
5 properties
IssueTypeSchemeProjectAssociation
object
Details of the association between an issue type scheme and project.
2 properties
2 required
IssueTypeSchemeProjects
object
Issue type scheme with a list of the projects that use it.
2 properties
2 required
IssueTypeSchemeUpdateDetails
object
Details of the name, description, and default issue type for an issue type scheme.
3 properties
IssueTypeScreenScheme
object
Details of an issue type screen scheme.
3 properties
2 required
IssueTypeScreenSchemeDetails
object
The details of an issue type screen scheme.
3 properties
2 required
IssueTypeScreenSchemeId
object
The ID of an issue type screen scheme.
1 property
1 required
IssueTypeScreenSchemeItem
object
The screen scheme for an issue type.
3 properties
3 required
IssueTypeScreenSchemeMapping
object
The IDs of the screen schemes for the issue type IDs.
2 properties
2 required
IssueTypeScreenSchemeMappingDetails
object
A list of issue type screen scheme mappings.
1 property
1 required
IssueTypeScreenSchemePayload
object
Defines the payload for the issue type screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/\api…
5 properties
IssueTypeScreenSchemeProjectAssociation
object
Associated issue type screen scheme and project.
2 properties
IssueTypeScreenSchemeUpdateDetails
object
Details of an issue type screen scheme.
2 properties
IssueTypeScreenSchemesProjects
object
Issue type screen scheme with a list of the projects that use it.
2 properties
2 required
IssueTypeToContextMapping
object
Mapping of an issue type to a context.
3 properties
1 required
IssueTypeUpdateBean
object
3 properties
IssueTypeWithStatus
object
Status details for an issue type.
5 properties
5 required
IssueTypeWorkflowMapping
object
Details about the mapping between an issue type and a workflow.
3 properties
IssueTypesWorkflowMapping
object
Details about the mapping between issue types and a workflow.
4 properties
IssueUpdateDetails
object
Details of an issue update request.
5 properties
IssueUpdateMetadata
object
A list of editable field details.
1 property
IssuesAndJQLQueries
object
List of issues and JQL queries.
2 properties
2 required
IssuesJqlMetaDataBean
object
The description of the page of issues loaded by the provided JQL query.
5 properties
4 required
IssuesMetaBean
object
Meta data describing the issues context variable.
1 property
IssuesUpdateBean
object
1 property
JExpEvaluateIssuesJqlMetaDataBean
object
The description of the page of issues loaded by the provided JQL query.This bean will be replacing IssuesJqlMetaDataBean bean as part of new evaluate endpoint
2 properties
1 required
JExpEvaluateIssuesMetaBean
object
Meta data describing the issues context variable.This bean will be replacing IssuesMetaBean bean as part of new evaluate endpoint
1 property
JExpEvaluateJiraExpressionResultBean
object
The result of evaluating a Jira expression.This bean will be replacing JiraExpressionResultBean bean as part of new evaluate endpoint
2 properties
1 required
JExpEvaluateMetaDataBean
object
Contains information about the expression evaluation. This bean will be replacing JiraExpressionEvaluationMetaDataBean bean as part of new evaluate endpoint
2 properties
JQLCountRequestBean
object
1 property
JQLCountResultsBean
object
1 property
JQLPersonalDataMigrationRequest
object
The JQL queries to be converted.
1 property
JQLQueryWithUnknownUsers
object
JQL queries that contained users that could not be found
2 properties
JQLReferenceData
object
Lists of JQL reference data.
3 properties
JexpEvaluateCtxIssues
object
The JQL specifying the issues available in the evaluated Jira expression under the issues context variable. This bean will be replacing JexpIssues bean as part…
1 property
JexpEvaluateCtxJqlIssues
object
The JQL specifying the issues available in the evaluated Jira expression under the issues context variable. Not all issues returned by the JQL query are loaded…
3 properties
JexpIssues
object
The JQL specifying the issues available in the evaluated Jira expression under the issues context variable.
1 property
JexpJqlIssues
object
The JQL specifying the issues available in the evaluated Jira expression under the issues context variable. Not all issues returned by the JQL query are loaded…
4 properties
JiraCascadingSelectField
object
3 properties
2 required
JiraColorField
object
2 properties
2 required
JiraColorInput
object
1 property
1 required
JiraComponentField
object
1 property
1 required
JiraDateField
object
2 properties
1 required
JiraDateInput
object
1 property
1 required
JiraDateTimeField
object
2 properties
2 required
JiraDateTimeInput
object
1 property
1 required
JiraDurationField
object
1 property
1 required
JiraExpressionAnalysis
object
Details about the analysed Jira expression.
5 properties
2 required
JiraExpressionComplexity
object
Details about the complexity of the analysed Jira expression.
2 properties
1 required
JiraExpressionEvalContextBean
object
8 properties
JiraExpressionEvalRequestBean
object
2 properties
1 required
JiraExpressionEvaluateContextBean
object
8 properties
JiraExpressionEvaluateRequestBean
object
The request to evaluate a Jira expression. This bean will be replacing JiraExpressionEvaluateRequest as part of new evaluate endpoint
2 properties
1 required
JiraExpressionEvaluationMetaDataBean
object
2 properties
JiraExpressionForAnalysis
object
Details of Jira expressions for analysis.
2 properties
1 required
JiraExpressionResult
object
The result of evaluating a Jira expression.
2 properties
1 required
JiraExpressionValidationError
object
Details about syntax and type errors. The error details apply to the entire expression, unless the object includes: line and column expression
5 properties
2 required
JiraExpressionsAnalysis
object
Details about the analysed Jira expression.
1 property
1 required
JiraExpressionsComplexityBean
object
4 properties
4 required
JiraExpressionsComplexityValueBean
object
2 properties
2 required
JiraGroupInput
object
1 property
1 required
JiraIssueFields
object
23 properties
JiraIssueTypeField
object
1 property
1 required
JiraLabelPropertiesInputJackson1
object
2 properties
JiraLabelsField
object
4 properties
3 required
JiraLabelsInput
object
1 property
1 required
JiraMultiSelectComponentField
object
3 properties
3 required
JiraMultipleGroupPickerField
object
2 properties
2 required
JiraMultipleSelectField
object
2 properties
2 required
JiraMultipleSelectUserPickerField
object
2 properties
1 required
JiraMultipleVersionPickerField
object
3 properties
3 required
JiraNumberField
object
2 properties
1 required
JiraPriorityField
object
1 property
1 required
JiraRichTextField
object
2 properties
2 required
JiraRichTextInput
object
1 property
JiraSelectedOptionField
object
1 property
JiraSingleGroupPickerField
object
2 properties
2 required
JiraSingleLineTextField
object
2 properties
2 required
JiraSingleSelectField
object
Add or clear a single select field: To add, specify the option with an optionId. To clear, pass an option with optionId as -1.
2 properties
2 required
JiraSingleSelectUserPickerField
object
2 properties
1 required
JiraSingleVersionPickerField
object
2 properties
2 required
JiraStatus
object
Details of a status.
5 properties
JiraStatusInput
object
1 property
1 required
JiraTimeTrackingField
object
1 property
1 required
JiraUrlField
object
2 properties
2 required
JiraUserField
object
1 property
1 required
JiraVersionField
object
1 property
JiraWorkflow
object
Details of a workflow.
13 properties
JiraWorkflowPreviewStatus
object
Details of a status.
7 properties
JiraWorkflowStatus
object
Details of a status.
6 properties
JqlFunctionPrecomputationBean
object
Jql function precomputation.
11 properties
JqlFunctionPrecomputationGetByIdRequest
object
Request to fetch precomputations by ID.
1 property
JqlFunctionPrecomputationGetByIdResponse
object
Get precomputations by ID response.
2 properties
JqlFunctionPrecomputationUpdateBean
object
Precomputation id and its new value.
3 properties
1 required
JqlFunctionPrecomputationUpdateErrorResponse
object
Error response returned updating JQL Function precomputations fails.
2 properties
JqlFunctionPrecomputationUpdateRequestBean
object
List of pairs (id and value) for precomputation updates.
1 property
JqlFunctionPrecomputationUpdateResponse
object
Result of updating JQL Function precomputations.
1 property
JqlQueriesToParse
object
A list of JQL queries to parse.
1 property
1 required
JqlQueriesToSanitize
object
The list of JQL queries to sanitize for the given account IDs.
1 property
1 required
JqlQuery
object
A parsed JQL query.
2 properties
JqlQueryClause
object
A JQL query clause.
JqlQueryClauseOperand
object
Details of an operand in a JQL clause.
JqlQueryClauseTimePredicate
object
A time predicate for a temporal JQL clause.
2 properties
2 required
JqlQueryField
object
A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL qu…
3 properties
1 required
JqlQueryFieldEntityProperty
object
Details of an entity property.
4 properties
3 required
JqlQueryOrderByClause
object
Details of the order-by JQL clause.
1 property
1 required
JqlQueryOrderByClauseElement
object
An element of the order-by JQL clause.
2 properties
1 required
JqlQueryToSanitize
object
The JQL query to sanitize for the account ID. If the account ID is null, sanitizing is performed for an anonymous user.
2 properties
1 required
JqlQueryUnitaryOperand
object
An operand that can be part of a list operand.
JsonContextVariable
object
A JSON object with custom content.
2 properties
1 required
JsonNode
object
36 properties
JsonTypeBean
object
The schema of a field.
6 properties
1 required
KeywordOperand
object
An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-refe…
1 property
1 required
LegacyJackson1ListAttachment
array
LegacyJackson1ListColumnItem
array
LegacyJackson1ListIssueEvent
array
LegacyJackson1ListIssueTypeWithStatus
array
LegacyJackson1ListProject
array
LegacyJackson1ListProjectComponent
array
LegacyJackson1ListProjectRoleDetails
array
LegacyJackson1ListProjectType
array
LegacyJackson1ListUserMigrationBean
array
LegacyJackson1ListVersion
array
LegacyJackson1ListWorklog
array
License
object
Details about a license for the Jira instance.
1 property
1 required
LicenseMetric
object
A metric that provides insight into the active licence details
2 properties
LicensedApplication
object
Details about a licensed Jira application.
2 properties
2 required
LimitExceededResponseBean
object
7 properties
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
LinkIssueRequestJsonBean
object
4 properties
3 required
LinkedIssue
object
The ID or key of a linked issue.
4 properties
ListOperand
object
An operand that is a list of values.
2 properties
1 required
ListWrapperCallbackApplicationRole
object
ListWrapperCallbackGroupName
object
Locale
object
Details of a locale.
1 property
MandatoryFieldValue
object
List of string of inputs
3 properties
1 required
MandatoryFieldValueForADF
object
An object notation input
3 properties
2 required
MappingsByIssueTypeOverride
object
The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses…
2 properties
MappingsByWorkflow
object
The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has.…
3 properties
3 required
MinimalFieldSchemeToFieldsPartialFailure
object
Minimal partial failure result when updating field scheme to fields associations.
4 properties
3 required
MinimalFieldSchemeToFieldsResponse
object
Minimal response for updating field scheme to fields associations.
1 property
1 required
MoveFieldBean
object
2 properties
MultiIssueEntityProperties
object
A list of issues and their respective properties to set or update. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-prop…
1 property
MultipartFile
object
8 properties
MultipleCustomFieldValuesUpdate
object
A custom field and its new value with a list of issue to update.
3 properties
3 required
MultipleCustomFieldValuesUpdateDetails
object
List of updates for a custom fields.
1 property
NestedResponse
object
3 properties
NewUserDetails
object
The user details.
8 properties
2 required
NonWorkingDay
object
2 properties
Notification
object
Details about a notification.
5 properties
NotificationEvent
object
Details about a notification event.
4 properties
NotificationRecipients
object
Details of the users and groups to receive the notification.
7 properties
NotificationRecipientsRestrictions
object
Details of the group membership or permissions needed to receive the notification.
3 properties
NotificationScheme
object
Details about a notification scheme.
8 properties
NotificationSchemeAndProjectMappingJsonBean
object
2 properties
NotificationSchemeEvent
object
Details about a notification scheme event.
2 properties
NotificationSchemeEventDetails
object
Details of a notification scheme event.
2 properties
2 required
NotificationSchemeEventIDPayload
object
The event ID to use for reference in the payload
1 property
NotificationSchemeEventPayload
object
The payload for creating a notification scheme event. Defines which notifications should be sent for a specific event
2 properties
NotificationSchemeEventTypeId
object
The ID of an event that is being mapped to notifications.
1 property
1 required
NotificationSchemeId
object
The ID of a notification scheme.
1 property
1 required
NotificationSchemeNotificationDetails
object
Details of a notification within a notification scheme.
2 properties
1 required
NotificationSchemeNotificationDetailsPayload
object
The configuration for notification recipents
2 properties
NotificationSchemePayload
object
The payload for creating a notification scheme. The user has to supply the ID for the default notification scheme. For CMP this is provided in the project payl…
5 properties
OldToNewSecurityLevelMappingsBean
object
2 properties
2 required
OperationMessage
object
2 properties
2 required
Operations
object
Details of the operations that can be performed on the issue.
1 property
OrderOfCustomFieldOptions
object
An ordered list of custom field option IDs and information on where to move them.
3 properties
1 required
OrderOfIssueTypes
object
An ordered list of issue type IDs and information about where to move them.
3 properties
1 required
PageBean2ComponentJsonBean
object
A page of items.
7 properties
PageBean2FieldAssociationSchemeFieldSearchResult
object
A page of items.
7 properties
PageBean2FieldAssociationSchemeProjectSearchResult
object
A page of items.
7 properties
PageBean2GetFieldAssociationSchemeResponse
object
A page of items.
7 properties
PageBean2GetProjectsWithFieldSchemesResponse
object
A page of items.
7 properties
PageBean2JqlFunctionPrecomputationBean
object
A page of items.
7 properties
PageBean2ProjectFieldBean
object
A page of items.
7 properties
PageBeanBulkContextualConfiguration
object
A page of items.
7 properties
PageBeanChangelog
object
A page of items.
7 properties
PageBeanComment
object
A page of items.
7 properties
PageBeanComponentWithIssueCount
object
A page of items.
7 properties
PageBeanContext
object
A page of items.
7 properties
PageBeanContextDefaultValues
object
A page of items.
7 properties
PageBeanContextForProjectAndIssueType
object
A page of items.
7 properties
PageBeanContextualConfiguration
object
A page of items.
7 properties
PageBeanCustomFieldContext
object
A page of items.
7 properties
PageBeanCustomFieldContextDefaultValue
object
A page of items.
7 properties
PageBeanCustomFieldContextOption
object
A page of items.
7 properties
PageBeanCustomFieldContextProjectMapping
object
A page of items.
7 properties
PageBeanDashboard
object
A page of items.
7 properties
PageBeanField
object
A page of items.
7 properties
PageBeanFieldConfigurationDetails
object
A page of items.
7 properties
PageBeanFieldConfigurationIssueTypeItem
object
A page of items.
7 properties
PageBeanFieldConfigurationItem
object
A page of items.
7 properties
PageBeanFieldConfigurationScheme
object
A page of items.
7 properties
PageBeanFieldConfigurationSchemeProjects
object
A page of items.
7 properties
PageBeanFieldProjectAssociation
object
A page of items.
7 properties
PageBeanFilterDetails
object
A page of items.
7 properties
PageBeanGroupDetails
object
A page of items.
7 properties
PageBeanIssueFieldOption
object
A page of items.
7 properties
PageBeanIssueSecurityLevelMember
object
A page of items.
7 properties
PageBeanIssueSecuritySchemeToProjectMapping
object
A page of items.
7 properties
PageBeanIssueTypeScheme
object
A page of items.
7 properties
PageBeanIssueTypeSchemeMapping
object
A page of items.
7 properties
PageBeanIssueTypeSchemeProjects
object
A page of items.
7 properties
PageBeanIssueTypeScreenScheme
object
A page of items.
7 properties
PageBeanIssueTypeScreenSchemeItem
object
A page of items.
7 properties
PageBeanIssueTypeScreenSchemesProjects
object
A page of items.
7 properties
PageBeanIssueTypeToContextMapping
object
A page of items.
7 properties
PageBeanNotificationScheme
object
A page of items.
7 properties
PageBeanNotificationSchemeAndProjectMappingJsonBean
object
A page of items.
7 properties
PageBeanPriority
object
A page of items.
7 properties
PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects
object
A page of items.
7 properties
PageBeanPriorityWithSequence
object
A page of items.
7 properties
PageBeanProject
object
A page of items.
7 properties
PageBeanProjectDetails
object
A page of items.
7 properties
PageBeanResolutionJsonBean
object
A page of items.
7 properties
PageBeanScreen
object
A page of items.
7 properties
PageBeanScreenScheme
object
A page of items.
7 properties
PageBeanScreenWithTab
object
A page of items.
7 properties
PageBeanSecurityLevel
object
A page of items.
7 properties
PageBeanSecurityLevelMember
object
A page of items.
7 properties
PageBeanSecuritySchemeWithProjects
object
A page of items.
7 properties
PageBeanString
object
A page of items.
7 properties
PageBeanUiModificationDetails
object
A page of items.
7 properties
PageBeanUser
object
A page of items.
7 properties
PageBeanUserDetails
object
A page of items.
7 properties
PageBeanUserKey
object
A page of items.
7 properties
PageBeanVersion
object
A page of items.
7 properties
PageBeanWebhook
object
A page of items.
7 properties
PageBeanWorkflow
object
A page of items.
7 properties
PageBeanWorkflowScheme
object
A page of items.
7 properties
PageBeanWorkflowTransitionRules
object
A page of items.
7 properties
PageOfChangelogs
object
A page of changelogs.
4 properties
PageOfComments
object
A page of comments.
4 properties
PageOfCreateMetaIssueTypeWithField
object
A page of CreateMetaIssueType with Field.
5 properties
PageOfCreateMetaIssueTypes
object
A page of CreateMetaIssueTypes.
5 properties
PageOfDashboards
object
A page containing dashboard details.
6 properties
PageOfStatuses
object
7 properties
PageOfWorklogs
object
Paginated list of worklog details
4 properties
PageWithCursorGetPlanResponseForPage
object
6 properties
PageWithCursorGetTeamResponseForPage
object
6 properties
PagedListUserDetailsApplicationUser
object
A paged list. To access additional details append [start-index:end-index] to the expand request. For example, ?expand=sharedUsers[10:40] returns a list startin…
5 properties
PaginatedResponseComment
object
4 properties
PaginatedResponseFieldCreateMetadata
object
4 properties
PaginatedResponseIssueTypeIssueCreateMetadata
object
4 properties
ParameterRemovalDetails
object
3 properties
ParsedJqlQueries
object
A list of parsed JQL queries.
1 property
1 required
ParsedJqlQuery
object
Details of a parsed JQL query.
4 properties
1 required
PermissionDetails
object
Details for permissions of shareable entities
2 properties
2 required
PermissionGrant
object
Details about a permission granted to a user or group.
4 properties
PermissionGrantDTO
object
List of permission grants
8 properties
PermissionGrants
object
List of permission grants.
2 properties
PermissionHolder
object
Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/holder-object) in Get all permiss…
4 properties
1 required
PermissionPayloadDTO
object
The payload to create a permission scheme
6 properties
PermissionScheme
object
Details of a permission scheme.
7 properties
1 required
PermissionSchemes
object
List of all permission schemes.
1 property
Permissions
object
Details about permissions.
1 property
PermissionsKeysBean
object
1 property
1 required
PermittedProjects
object
A list of projects in which a user is granted permissions.
1 property
PreviewConditionGroupConfiguration
object
Condition group configuration for workflow transitions.
3 properties
PreviewRuleConfiguration
object
Rule configuration for workflow transitions.
3 properties
PreviewTrigger
object
Trigger configuration for workflow transitions.
2 properties
Priority
object
An issue priority.
9 properties
PriorityId
object
The ID of an issue priority.
1 property
1 required
PriorityMapping
object
Mapping of issue priorities for changes in priority schemes.
2 properties
PrioritySchemeChangesWithoutMappings
object
1 property
1 required
PrioritySchemeId
object
The ID of a priority scheme.
2 properties
PrioritySchemeWithPaginatedPrioritiesAndProjects
object
A priority scheme with paginated priorities and projects.
9 properties
2 required
PriorityWithSequence
object
An issue priority with sequence information.
8 properties
Project
object
Details about a project.
34 properties
ProjectAndIssueTypePair
object
A project and issueType ID pair that identifies a status mapping.
2 properties
2 required
ProjectArchetype
object
3 properties
ProjectAvatars
object
List of project avatars.
2 properties
ProjectCategory
object
A project category.
4 properties
ProjectComponent
object
Details about a project component.
16 properties
ProjectCreateResourceIdentifier
object
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard fo…
6 properties
ProjectCustomTemplateCreateRequestDTO
object
Request to create a project using a custom template
2 properties
ProjectDataPolicies
object
Details about data policies for a list of projects.
1 property
ProjectDataPolicy
object
Details about data policy.
1 property
ProjectDetails
object
Details about a project.
8 properties
ProjectEmailAddress
object
A project's sender email address.
2 properties
ProjectFeature
object
Details of a project feature.
8 properties
ProjectFeatureState
object
Details of the feature state.
1 property
ProjectFieldBean
object
5 properties
ProjectId
object
Project ID details.
1 property
1 required
ProjectIdAssociationContext
object
ProjectIdentifierBean
object
The identifiers for a project.
2 properties
ProjectIdentifiers
object
Identifiers for a project.
3 properties
3 required
ProjectIds
object
A list of project IDs.
1 property
1 required
ProjectInsight
object
Additional details about a project.
2 properties
ProjectIssueCreateMetadata
object
Details of the issue creation metadata for a project.
7 properties
ProjectIssueSecurityLevels
object
List of issue level security items in a project.
1 property
1 required
ProjectIssueTypeHierarchy
object
The hierarchy of issue types within a project.
2 properties
ProjectIssueTypeMapping
object
The project and issue type mapping.
2 properties
2 required
ProjectIssueTypeMappings
object
The project and issue type mappings.
1 property
1 required
ProjectIssueTypeQueryContext
object
Project and issue type context for workflow queries made using issue types.
2 properties
ProjectIssueTypesHierarchyLevel
object
Details of an issue type hierarchy level.
4 properties
ProjectLandingPageInfo
object
11 properties
ProjectPayload
object
The payload for creating a project
9 properties
ProjectPermissions
object
Permissions which a user has on a project.
1 property
ProjectPinAction
object
The list of projects to pin or unpin the issue panel to or from.
2 properties
2 required
ProjectRole
object
Details about the roles in a project.
11 properties
ProjectRoleActorsUpdateBean
object
2 properties
ProjectRoleDetails
object
Details about a project role.
10 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
ProjectRoleUser
object
Details of the user associated with the role.
1 property
ProjectScopeBean
object
2 properties
ProjectTemplateKey
object
2 properties
ProjectTemplateModel
object
9 properties
ProjectType
object
Details about a project type.
5 properties
ProjectUsage
object
The project.
1 property
ProjectUsagePage
object
A page of projects.
2 properties
ProjectWithDataPolicy
object
Details about data policies for a project.
2 properties
PropertyKey
object
Property key details.
2 properties
PropertyKeys
object
List of property keys.
1 property
PublishDraftWorkflowScheme
object
Details about the status mappings for publishing a draft workflow scheme.
1 property
PublishedWorkflowId
object
Properties that identify a published workflow.
2 properties
1 required
QuickFilterPayload
object
The payload for defining quick filters
3 properties
RedactionJobStatusResponse
object
2 properties
RedactionPosition
object
Represents the position of the redaction
4 properties
3 required
RegisteredWebhook
object
ID of a registered webhook or error messages explaining why a webhook wasn't registered.
2 properties
RemoteIssueLink
object
Details of an issue remote link.
6 properties
RemoteIssueLinkIdentifies
object
Details of the identifiers for a created or updated remote issue link.
2 properties
RemoteIssueLinkRequest
object
Details of a remote issue link.
4 properties
1 required
RemoteObject
object
The linked item.
5 properties
2 required
RemoveFieldAssociationsRequestItem
object
Request item for removing field associations.
1 property
1 required
RemoveFieldParametersResult
object
Result of remove field parameters operation.
1 property
RemoveFieldParametersResultError
object
Error during remove field parameters operation.
2 properties
RemoveOptionFromIssuesResult
object
3 properties
ReorderIssuePriorities
object
Change the order of issue priorities.
3 properties
1 required
ReorderIssueResolutionsRequest
object
Change the order of issue resolutions.
3 properties
1 required
RequiredMappingByIssueType
object
The list of required status mappings by issue type.
2 properties
RequiredMappingByWorkflows
object
The list of required status mappings by workflow.
3 properties
Resolution
object
Details of an issue resolution.
4 properties
ResolutionId
object
The ID of an issue resolution.
1 property
1 required
ResolutionJsonBean
object
6 properties
Resource
object
9 properties
RestrictedPermission
object
Details of the permission.
2 properties
RichText
object
4 properties
RoleActor
object
Details about a user assigned to a project role.
7 properties
RolePayload
object
The payload used to create a project role. It is optional for CMP projects, as a default role actor will be provided. TMP will add new role actors to the table.
6 properties
RolesCapabilityPayload
object
2 properties
RuleConfiguration
object
A rule configuration.
3 properties
1 required
RulePayload
object
The payload for creating rules in a workflow
2 properties
SanitizedJqlQueries
object
The sanitized JQL queries for the given account IDs.
1 property
SanitizedJqlQuery
object
Details of the sanitized JQL query.
4 properties
SaveProjectTemplateRequest
object
The request details to generate template from a project
3 properties
SaveTemplateRequest
object
Request to save a custom template
3 properties
SaveTemplateResponse
object
1 property
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
ScopePayload
object
The payload for creating a scope. Defines if a project is team-managed project or company-managed project
1 property
Screen
object
A screen.
4 properties
ScreenDetails
object
Details of a screen.
2 properties
1 required
ScreenPayload
object
Defines the payload for the field screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/\api-rest-api-3-screens-post
4 properties
ScreenScheme
object
A screen scheme.
5 properties
ScreenSchemeDetails
object
Details of a screen scheme.
3 properties
2 required
ScreenSchemeId
object
The ID of a screen scheme.
1 property
1 required
ScreenSchemePayload
object
Defines the payload for the screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/\api-rest-api-3-screensche…
5 properties
ScreenTypes
object
The IDs of the screens for the screen types of the screen scheme.
4 properties
1 required
ScreenWithTab
object
A screen with tab details.
5 properties
ScreenableField
object
A screen tab field.
2 properties
ScreenableTab
object
A screen tab.
2 properties
1 required
SearchAndReconcileRequestBean
object
9 properties
SearchAndReconcileResults
object
The result of a JQL search with issues reconsilation.
6 properties
SearchAutoCompleteFilter
object
Details of how to filter and list search auto complete information.
2 properties
SearchRequestBean
object
8 properties
SearchResultFieldParameters
object
3 properties
SearchResultWorkTypeParameters
object
4 properties
SearchResults
object
The result of a JQL search.
8 properties
SearchWarning
object
Experimental. A warning returned alongside successful search results.
3 properties
SearchWarningLimitDetails
object
Experimental. Structured details about a JQL clause exceeding its argument limit.
4 properties
SecurityLevel
object
Details of an issue level security item.
6 properties
SecurityLevelMember
object
Issue security level member.
5 properties
4 required
SecurityLevelMemberPayload
object
The payload for creating a security level member. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
2 properties
SecurityLevelPayload
object
The payload for creating a security level. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
5 properties
SecurityScheme
object
Details about a security scheme.
6 properties
SecuritySchemeId
object
The ID of the issue security scheme.
1 property
1 required
SecuritySchemeLevelBean
object
4 properties
1 required
SecuritySchemeLevelMemberBean
object
2 properties
1 required
SecuritySchemeMembersRequest
object
Details of issue security scheme level new members.
1 property
1 required
SecuritySchemePayload
object
The payload for creating a security scheme. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
4 properties
SecuritySchemeWithProjects
object
Details about an issue security scheme.
6 properties
3 required
SecuritySchemes
object
List of security schemes.
1 property
ServerInformation
object
Details about the Jira instance.
14 properties
ServiceManagementNavigationInfo
object
3 properties
ServiceRegistry
object
6 properties
ServiceRegistryTier
object
5 properties
SetDefaultLevelsRequest
object
Details of new default levels.
1 property
1 required
SetDefaultPriorityRequest
object
The new default issue priority.
1 property
1 required
SetDefaultResolutionRequest
object
The new default issue resolution.
1 property
1 required
SharePermission
object
Details of a share permission for the filter.
6 properties
1 required
SharePermissionInputBean
object
7 properties
1 required
SimpleApplicationPropertyBean
object
2 properties
SimpleErrorCollection
object
3 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
SimpleListWrapperApplicationRole
object
5 properties
SimpleListWrapperGroupName
object
5 properties
SimplifiedHierarchyLevel
object
9 properties
SimplifiedIssueTransition
object
3 properties
SingleRedactionRequest
object
4 properties
4 required
SingleRedactionResponse
object
Result for requested redactions
2 properties
2 required
SoftwareNavigationInfo
object
4 properties
Status
object
The status of the item.
2 properties
StatusCategory
object
A status category.
5 properties
StatusCreate
object
Details of the status being created.
3 properties
2 required
StatusCreateRequest
object
Details of the statuses being created and their scope.
2 properties
2 required
StatusDetails
object
A status.
7 properties
StatusLayoutUpdate
object
The statuses associated with this workflow.
4 properties
2 required
StatusMapping
object
Details about the mapping from a status to a new status for an issue type.
3 properties
3 required
StatusMappingDTO
object
The mapping of old to new status ID for a specific project and issue type.
3 properties
3 required
StatusMetadata
object
The details of the statuses in the associated workflows.
3 properties
StatusMigration
object
The mapping of old to new status ID.
2 properties
2 required
StatusPayload
object
The payload for creating a status
6 properties
StatusProjectIssueTypeUsage
object
The list of issue types.
1 property
StatusProjectIssueTypeUsageDTO
object
The issue types using this status in a project.
3 properties
StatusProjectIssueTypeUsagePage
object
A page of issue types.
2 properties
StatusProjectUsage
object
The project.
1 property
StatusProjectUsageDTO
object
The projects using this status.
2 properties
StatusProjectUsagePage
object
A page of projects.
2 properties
StatusScope
object
The scope of the status.
2 properties
1 required
StatusUpdate
object
Details of the status being updated.
4 properties
3 required
StatusUpdateRequest
object
The list of statuses that will be updated.
1 property
1 required
StatusWorkflowUsageDTO
object
Workflows using the status.
2 properties
StatusWorkflowUsagePage
object
A page of workflows.
2 properties
StatusWorkflowUsageWorkflow
object
The worflow.
1 property
StatusesPerWorkflow
object
The statuses associated with each workflow.
3 properties
StreamingResponseBody
object
StringList
object
SubmittedBulkOperation
object
1 property
SuccessOrErrorResults
object
5 properties
SuggestedIssue
object
An issue suggested for use in the issue picker auto-completion.
6 properties
SuggestedMappingsForPrioritiesRequestBean
object
Details of changes to a priority scheme's priorities that require suggested priority mappings.
2 properties
SuggestedMappingsForProjectsRequestBean
object
Details of changes to a priority scheme's projects that require suggested priority mappings.
1 property
SuggestedMappingsRequestBean
object
Details of changes to a priority scheme that require suggested priority mappings.
5 properties
SwimlanePayload
object
The payload for custom swimlanes
3 properties
SwimlanesPayload
object
The payload for customising a swimlanes on a board
3 properties
SystemAvatars
object
List of system avatars.
1 property
TabPayload
object
Defines the payload for the tabs of the screen. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/\api-rest-api-3-scr…
2 properties
TaskProgress
object
Details about a task.
13 properties
7 required
TaskProgressBeanJsonNode
object
Details about a task.
13 properties
8 required
TaskProgressBeanObject
object
Details about a task.
13 properties
8 required
TaskProgressBeanRemoveOptionFromIssuesResult
object
Details about a task.
13 properties
8 required
TimeTrackingConfiguration
object
Details of the time tracking configuration.
4 properties
4 required
TimeTrackingDetails
object
Time tracking details.
6 properties
TimeTrackingProvider
object
Details about the time tracking provider.
3 properties
1 required
ToLayoutPayload
object
The payload for the layout details for the destination end of a transition
2 properties
Transition
object
Details of a workflow transition.
9 properties
6 required
TransitionLink
object
Link information for workflow transitions.
3 properties
TransitionPayload
object
The payload for creating a transition in a workflow. Can be DIRECTED, GLOBAL, SELF-LOOPED, GLOBAL LOOPED
13 properties
TransitionPreview
object
Details about a workflow transition in preview context.
12 properties
TransitionScreenDetails
object
The details of a transition screen.
2 properties
1 required
TransitionUpdateDTO
object
The transition update data.
13 properties
Transitions
object
List of issue transitions.
2 properties
UiModificationContextDetails
object
The details of a UI modification's context, which define where to activate the UI modification.
7 properties
UiModificationDetails
object
The details of a UI modification.
6 properties
3 required
UiModificationIdentifiers
object
Identifiers for a UI modification.
2 properties
2 required
UnrestrictedUserEmail
object
2 properties
UpdateCustomFieldDetails
object
Details of a custom field.
3 properties
UpdateDefaultProjectClassificationBean
object
The request for updating the default project classification level.
1 property
1 required
UpdateDefaultScreenScheme
object
The ID of a screen scheme.
1 property
1 required
UpdateFieldAssociationSchemeLinksBean
object
2 properties
UpdateFieldAssociationSchemeRequest
object
Request object for updating an existing field association scheme.
2 properties
UpdateFieldAssociationSchemeResponse
object
Response object after successfully updating an existing field association scheme.
4 properties
UpdateFieldAssociationsRequestItem
object
Represents an association between a field and its operations.
2 properties
1 required
UpdateFieldConfigurationSchemeDetails
object
The details of the field configuration scheme.
2 properties
1 required
UpdateFieldSchemeParametersPartialFailure
object
Result of updating field scheme parameters for a specific field, scheme, and optional work type.
5 properties
3 required
UpdateFieldSchemeParametersRequest
object
Request bean for updating field scheme parameters across multiple schemes and work types.
3 properties
UpdateFieldSchemeParametersResponse
object
Response bean for field scheme parameter update operations.
1 property
1 required
UpdateIssueSecurityLevelDetails
object
Details of issue security scheme level.
2 properties
UpdateIssueSecuritySchemeRequestBean
object
2 properties
UpdateNotificationSchemeDetails
object
Details of a notification scheme.
2 properties
UpdatePrioritiesInSchemeRequestBean
object
Update priorities in a scheme
2 properties
UpdatePriorityDetails
object
Details of an issue priority.
5 properties
UpdatePrioritySchemeRequestBean
object
Details of a priority scheme.
6 properties
UpdatePrioritySchemeResponseBean
object
Details of the updated priority scheme.
2 properties
UpdateProjectDetails
object
Details about the project.
13 properties
UpdateProjectsInSchemeRequestBean
object
Update projects in a scheme
2 properties
UpdateResolutionDetails
object
Details of an issue resolution.
2 properties
1 required
UpdateScreenDetails
object
Details of a screen.
2 properties
UpdateScreenSchemeDetails
object
Details of a screen scheme.
3 properties
UpdateScreenTypes
object
The IDs of the screens for the screen types of the screen scheme.
4 properties
UpdateUiModificationDetails
object
The details of a UI modification.
4 properties
UpdateUserToGroupBean
object
2 properties
UpdatedProjectCategory
object
A project category.
4 properties
User
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
16 properties
UserBean
object
7 properties
UserBeanAvatarUrls
object
4 properties
UserColumnRequestBody
object
1 property
UserContextVariable
object
A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-referenceuser) specified as an Atlassian account ID.
2 properties
2 required
UserDetails
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties
UserFilter
object
Filter for a User Picker (single) custom field.
3 properties
1 required
UserKey
object
List of user account IDs.
2 properties
UserList
object
A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.
5 properties
UserMigrationBean
object
3 properties
UserPermission
object
Details of a permission and its availability to a user.
7 properties
UserPickerUser
object
A user found in a search.
7 properties
ValidationOptionsForCreate
object
The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results.
1 property
ValidationOptionsForUpdate
object
The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results.
1 property
ValueOperand
object
An operand that is a user-provided value.
2 properties
1 required
Version
object
Details about a project version.
19 properties
VersionApprover
object
Contains details about a version approver.
4 properties
VersionIssueCounts
object
Various counts of issues within a version.
5 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
VersionMoveBean
object
2 properties
VersionRelatedWork
object
Associated related work to a version
5 properties
1 required
VersionUnresolvedIssuesCount
object
Count of a version's unresolved issues.
3 properties
VersionUsageInCustomField
object
List of custom fields using the version.
3 properties
Visibility
object
The group or role to which this item is visible.
3 properties
Votes
object
The details of votes on an issue.
4 properties
WarningCollection
object
1 property
Watchers
object
The details of watchers on an issue.
4 properties
Webhook
object
A webhook.
7 properties
4 required
WebhookDetails
object
A list of webhooks.
4 properties
2 required
WebhookRegistrationDetails
object
Details of webhooks to register.
2 properties
2 required
WebhooksExpirationDate
object
The date the refreshed webhooks expire.
1 property
1 required
WorkManagementNavigationInfo
object
1 property
WorkTypeParameters
object
4 properties
2 required
Workflow
object
Details about a workflow.
11 properties
2 required
WorkflowAssociationStatusMapping
object
2 properties
WorkflowCapabilities
object
6 properties
WorkflowCapabilityPayload
object
The payload for creating a workflows. See https://www.atlassian.com/software/jira/guides/workflows/overview\what-is-a-jira-workflow
3 properties
WorkflowCompoundCondition
object
A compound workflow transition rule condition. This object returns nodeType as compound.
3 properties
3 required
WorkflowCondition
object
The workflow transition rule conditions tree.
WorkflowCreate
object
The details of the workflows to create.
6 properties
3 required
WorkflowCreateRequest
object
The create workflows payload.
3 properties
WorkflowCreateResponse
object
Details of the created workflows and statuses.
2 properties
WorkflowCreateValidateRequest
object
2 properties
1 required
WorkflowDocumentDTO
object
The workflow stored for the specified version.
12 properties
WorkflowDocumentStatusDTO
object
The statuses stored for the specified version.
6 properties
WorkflowDocumentVersionBean
object
The version details of the workflow.
2 properties
WorkflowElementReference
object
A reference to the location of the error. This will be null if the error does not refer to a specific element.
5 properties
WorkflowHistoryItemDTO
object
A single entry in the WorkflowHistoryPage.
4 properties
WorkflowHistoryListRequest
object
A request to read all the workflow history entries for a specific workflow.
1 property
WorkflowHistoryListResponseDTO
object
A list of workflow history entries.
1 property
WorkflowHistoryReadRequest
object
A request to read a specific workflow version from history.
2 properties
WorkflowHistoryReadResponseDTO
object
The specified workflow version read from history.
2 properties
WorkflowId
object
Properties that identify a workflow.
2 properties
1 required
WorkflowLayout
object
The starting point for the statuses in the workflow.
2 properties
WorkflowMetadataAndIssueTypeRestModel
object
The workflow metadata and issue type IDs which use this workflow.
2 properties
2 required
WorkflowMetadataRestModel
object
Workflow metadata and usage detail.
4 properties
4 required
WorkflowOperations
object
Operations allowed on a workflow
2 properties
2 required
WorkflowPayload
object
The payload for creating workflow, see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\api-rest-api-3-workflows-create-post
8 properties
WorkflowPreview
object
Details of a workflow.
10 properties
WorkflowPreviewLayout
object
Layout coordinates for workflow elements.
2 properties
WorkflowPreviewRequest
object
The details of the preview workflow request.
4 properties
1 required
WorkflowPreviewResponse
object
The preview workflow response containing workflows and statuses.
2 properties
WorkflowPreviewScope
object
The scope of the workflow.
2 properties
WorkflowPreviewStatus
object
Details about a workflow status in preview context.
4 properties
WorkflowProjectIdScope
object
Project ID details.
1 property
WorkflowProjectIssueTypeUsage
object
The issue type.
1 property
WorkflowProjectIssueTypeUsageDTO
object
Issue types associated with the workflow for a project.
3 properties
WorkflowProjectIssueTypeUsagePage
object
A page of issue types.
2 properties
WorkflowProjectUsageDTO
object
Projects using the workflow.
2 properties
WorkflowReadRequest
object
3 properties
WorkflowReadResponse
object
Details of workflows and related statuses.
2 properties
WorkflowReferenceStatus
object
The statuses referenced in the workflow.
5 properties
WorkflowRuleConfiguration
object
The configuration of the rule.
3 properties
1 required
WorkflowRules
object
A collection of transition rules.
3 properties
WorkflowRulesSearch
object
Details of the workflow and its transition rules.
3 properties
2 required
WorkflowRulesSearchDetails
object
Details of workflow transition rules.
3 properties
WorkflowScheme
object
Details about a workflow scheme.
13 properties
WorkflowSchemeAssociation
object
The explicit association between issue types and a workflow in a workflow scheme.
2 properties
2 required
WorkflowSchemeAssociations
object
A workflow scheme along with a list of projects that use it.
2 properties
2 required
WorkflowSchemeIdName
object
The ID and the name of the workflow scheme.
2 properties
2 required
WorkflowSchemePayload
object
The payload for creating a workflow scheme. See https://www.atlassian.com/software/jira/guides/workflows/overview\what-is-a-jira-workflow-scheme
6 properties
WorkflowSchemeProjectAssociation
object
An associated workflow scheme and project.
2 properties
1 required
WorkflowSchemeProjectSwitchBean
object
Request to switch a project's workflow scheme
3 properties
WorkflowSchemeProjectUsageDTO
object
Projects using the workflow scheme.
2 properties
WorkflowSchemeReadRequest
object
The workflow scheme read request body.
2 properties
WorkflowSchemeReadResponse
object
8 properties
5 required
WorkflowSchemeUpdateRequest
object
The update workflow scheme payload.
8 properties
4 required
WorkflowSchemeUpdateRequiredMappingsRequest
object
The request payload to get the required mappings for updating a workflow scheme.
3 properties
2 required
WorkflowSchemeUpdateRequiredMappingsResponse
object
4 properties
WorkflowSchemeUsage
object
The worflow scheme.
1 property
WorkflowSchemeUsageDTO
object
Workflow schemes using the workflow.
2 properties
WorkflowSchemeUsagePage
object
A page of workflow schemes.
2 properties
WorkflowScope
object
The scope of the workflow.
2 properties
WorkflowSearchResponse
object
Page of items, including workflows and related statuses.
8 properties
WorkflowSimpleCondition
object
A workflow transition rule condition. This object returns nodeType as simple.
3 properties
2 required
WorkflowStatus
object
Details of a workflow status.
3 properties
2 required
WorkflowStatusLayout
object
The x and y location of the status in the workflow.
2 properties
WorkflowStatusLayoutPayload
object
The layout of the workflow status.
2 properties
WorkflowStatusPayload
object
The statuses to be used in the workflow
3 properties
WorkflowStatusUpdate
object
Details of the status being updated.
5 properties
3 required
WorkflowTransition
object
A workflow transition.
2 properties
2 required
WorkflowTransitionLinks
object
The statuses the transition can start from, and the mapping of ports between the statuses.
3 properties
WorkflowTransitionRule
object
A workflow transition rule.
2 properties
1 required
WorkflowTransitionRules
object
A workflow with transition rules.
4 properties
1 required
WorkflowTransitionRulesDetails
object
Details about a workflow configuration update request.
2 properties
2 required
WorkflowTransitionRulesUpdate
object
Details about a workflow configuration update request.
1 property
1 required
WorkflowTransitionRulesUpdateErrorDetails
object
Details of any errors encountered while updating workflow transition rules for a workflow.
3 properties
3 required
WorkflowTransitionRulesUpdateErrors
object
Details of any errors encountered while updating workflow transition rules.
1 property
1 required
WorkflowTransitions
object
The transitions of the workflow.
13 properties
WorkflowTrigger
object
The trigger configuration associated with a workflow.
3 properties
2 required
WorkflowUpdate
object
The details of the workflows to update.
9 properties
4 required
WorkflowUpdateRequest
object
The update workflows payload.
2 properties
WorkflowUpdateResponse
object
3 properties
WorkflowUpdateValidateRequestBean
object
2 properties
1 required
WorkflowValidationError
object
The details about a workflow validation error.
6 properties
WorkflowValidationErrorList
object
1 property
WorkflowsWithTransitionRulesDetails
object
Details of workflows and their transition rules to delete.
1 property
1 required
WorkingDaysConfig
object
Working days configuration
10 properties
Worklog
object
Details of a worklog.
13 properties
WorklogCompositeKey
object
2 properties
WorklogIdsRequestBean
object
1 property
1 required
WorklogKeyResult
object
2 properties
WorklogsMoveRequestBean
object
2 properties
WorkspaceDataPolicy
object
Details about data policy.
1 property
fields
object
Can contain multiple field values of following types depending on type key
3 properties
targetClassification
object
Classification mapping for classifications in source issues to respective target classification.
3 properties
1 required
targetMandatoryFields
object
Field mapping for mandatory fields in target
1 property
1 required
targetStatus
object
Status mapping for statuses in source workflow to respective target status in target workflow.
1 property
1 required
targetToSourcesMapping
object
An object representing the mapping of issues and data related to destination entities, like fields and statuses, that are required during a bulk move.
8 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Atlassian Jira 11
Other APIs Atlassian Jira publishes across the network.
Atlassian Jira Fields API
Atlassian Jira Issue Comments API
Atlassian Jira Issue Search API
Atlassian Jira Issue Transitions API
Atlassian Jira Issue Worklogs API
Atlassian Jira Issues API
Atlassian Jira Projects API
Atlassian Jira Users API
Jira Software Cloud API
Jira Service Management REST API
Atlassian Remote MCP Server
#Issue Tracking#Project Management
Where this information came from
This is an independent, third-party profile of Atlassian Jira Cloud Platform REST API v3, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.