openapi: 3.2.0 info: contact: email: ecosystem@atlassian.com description: Jira Cloud platform REST API documentation license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ title: Jira Cloud platform REST Plans API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans. name: Plans paths: /rest/api/3/plans/plan: get: deprecated: false description: 'Returns a paginated list of plans. **Permissions required:** *Administer Jira* global permission.' operationId: getPlans parameters: - description: Whether to include trashed plans in the results. in: query name: includeTrashed schema: default: false type: boolean - description: Whether to include archived plans in the results. in: query name: includeArchived schema: default: false type: boolean - description: The cursor to start from. If not provided, the first page will be returned. in: query name: cursor schema: default: '' type: string - description: The maximum number of plans to return per page. The maximum value is 50. The default value is 50. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"cursor":"","isLast":true,"maxResults":2,"nextPageCursor":"2","total":10,"values":[{"id":"100","issueSources":[{"type":"Project","value":10000}],"name":"Plan 1","scenarioId":"200","status":"Active"},{"id":"200","issueSources":[{"type":"Board","value":20000}],"name":"Plan 2","scenarioId":"300","status":"Trashed"}]}' schema: $ref: '#/components/schemas/PageWithCursorGetPlanResponseForPage' description: Returned if the request is successful. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get plans paginated tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE post: deprecated: false description: 'Creates a plan. **Permissions required:** *Administer Jira* global permission.' operationId: createPlan parameters: - description: Whether to accept group IDs instead of group names. Group names are deprecated. in: query name: useGroupId schema: default: false type: boolean requestBody: content: application/json: example: crossProjectReleases: - name: AB and BC merge releaseIds: - 29 - 39 customFields: - customFieldId: 2335 filter: true exclusionRules: issueIds: - 2 - 3 issueTypeIds: - 32 - 33 numberOfDaysToShowCompletedIssues: 50 releaseIds: - 42 - 43 workStatusCategoryIds: - 22 - 23 workStatusIds: - 12 - 13 issueSources: - type: Project value: 12 - type: Board value: 462 leadAccountId: abc-12-rbji name: ABC Quaterly plan permissions: - holder: type: AccountId value: 234-tgj-343 type: Edit scheduling: dependencies: Sequential endDate: type: DueDate estimation: Days inferredDates: ReleaseDates startDate: type: TargetStartDate schema: $ref: '#/components/schemas/CreatePlanRequest' required: true responses: '201': content: application/json: schema: format: int64 type: integer description: Returned if the request is successful. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is not valid. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. security: - basicAuth: [] - OAuth2: - write:jira-work summary: Create plan tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/plans/plan/{planId}: get: deprecated: false description: 'Returns a plan. **Permissions required:** *Administer Jira* global permission.' operationId: getPlan parameters: - description: The ID of the plan. in: path name: planId required: true schema: format: int64 type: integer - description: Whether to return group IDs instead of group names. Group names are deprecated. in: query name: useGroupId schema: default: false type: boolean responses: '200': content: application/json: example: '{"crossProjectReleases":[{"name":"x-plr","releaseIds":[345]}],"customFields":[{"customFieldId":34,"filter":false},{"customFieldId":39,"filter":true}],"exclusionRules":{"issueIds":[1,2],"issueTypeIds":[13,23],"numberOfDaysToShowCompletedIssues":50,"releaseIds":[14,24],"workStatusCategoryIds":[12,22],"workStatusIds":[11,21]},"id":23,"issueSources":[{"type":"Project","value":12},{"type":"Filter","value":10293}],"lastSaved":"2024-10-03T10:15:30Z","leadAccountId":"628f5e86d5ec1f006ne7363x2s","name":"Onset TBJ Plan","permissions":[{"holder":{"type":"AccountId","value":"04jekw86d5jjje006ne7363x2s"},"type":"Edit"}],"scheduling":{"dependencies":"Concurrent","endDate":{"dateCustomFieldId":1098,"type":"DateCustomField"},"estimation":"Hours","inferredDates":"ReleaseDates","startDate":{"type":"TargetStartDate"}},"status":"Active"}' schema: $ref: '#/components/schemas/GetPlanResponse' description: Returned if the request is successful. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not found. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get plan tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE put: deprecated: false description: 'Updates any of the following details of a plan using JSON Patch. * name * leadAccountId * scheduling * estimation with StoryPoints, Days or Hours as possible values * startDate * type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values * dateCustomFieldId * endDate * type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values * dateCustomFieldId * inferredDates with None, SprintDates or ReleaseDates as possible values * dependencies with Sequential or Concurrent as possible values * issueSources * type with Board, Project or Filter as possible values * value * exclusionRules * numberOfDaysToShowCompletedIssues * issueIds * workStatusIds * workStatusCategoryIds * issueTypeIds * releaseIds * crossProjectReleases * name * releaseIds * customFields * customFieldId * filter * permissions * type with View or Edit as possible values * holder * type with Group or AccountId as possible values * value **Permissions required:** *Administer Jira* global permission. *Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.*' operationId: updatePlan parameters: - description: The ID of the plan. in: path name: planId required: true schema: format: int64 type: integer - description: Whether to accept group IDs instead of group names. Group names are deprecated. in: query name: useGroupId schema: default: false type: boolean requestBody: content: application/json-patch+json: example: '[{"op": "replace", "path": "/scheduling/estimation", "value": "Days"}] ' schema: type: object required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is not valid. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not active. security: - basicAuth: [] - OAuth2: - write:jira-work summary: Update plan tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/plans/plan/{planId}/archive: put: deprecated: false description: 'Archives a plan. **Permissions required:** *Administer Jira* global permission.' operationId: archivePlan parameters: - description: The ID of the plan. in: path name: planId required: true schema: format: int64 type: integer responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not active. security: - basicAuth: [] - OAuth2: - write:jira-work summary: Archive plan tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/plans/plan/{planId}/duplicate: post: deprecated: false description: 'Duplicates a plan. **Permissions required:** *Administer Jira* global permission.' operationId: duplicatePlan parameters: - description: The ID of the plan. in: path name: planId required: true schema: format: int64 type: integer requestBody: content: application/json: example: name: Copied Plan schema: $ref: '#/components/schemas/DuplicatePlanRequest' required: true responses: '201': content: application/json: schema: format: int64 type: integer description: Returned if the request is successful. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is not valid. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan to duplicate is not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan to duplicate is not active. security: - basicAuth: [] - OAuth2: - write:jira-work summary: Duplicate plan tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/plans/plan/{planId}/trash: put: deprecated: false description: 'Moves a plan to trash. **Permissions required:** *Administer Jira* global permission.' operationId: trashPlan parameters: - description: The ID of the plan. in: path name: planId required: true schema: format: int64 type: integer responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user is not logged in. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the plan is not active. security: - basicAuth: [] - OAuth2: - write:jira-work summary: Trash plan tags: - Plans x-atlassian-data-security-policy: - app-access-rule-exempt: true x-experimental: true x-atlassian-connect-scope: INACCESSIBLE components: schemas: CreateExclusionRulesRequest: additionalProperties: false properties: issueIds: description: The IDs of the issues to exclude from the plan. items: format: int64 type: integer type: array uniqueItems: true issueTypeIds: description: The IDs of the issue types to exclude from the plan. items: format: int64 type: integer type: array uniqueItems: true numberOfDaysToShowCompletedIssues: description: Issues completed this number of days ago will be excluded from the plan. format: int32 type: integer releaseIds: description: The IDs of the releases to exclude from the plan. items: format: int64 type: integer type: array uniqueItems: true workStatusCategoryIds: description: The IDs of the work status categories to exclude from the plan. items: format: int64 type: integer type: array uniqueItems: true workStatusIds: description: The IDs of the work statuses to exclude from the plan. items: format: int64 type: integer type: array uniqueItems: true type: object PageWithCursorGetPlanResponseForPage: additionalProperties: false properties: cursor: type: string last: type: boolean nextPageCursor: type: string size: format: int32 type: integer total: format: int64 type: integer values: items: $ref: '#/components/schemas/GetPlanResponseForPage' type: array type: object GetPermissionHolderResponse: additionalProperties: false properties: type: description: The permission holder type. This is "Group" or "AccountId". enum: - Group - AccountId type: string value: description: The permission holder value. This is a group name if the type is "Group" or an account ID if the type is "AccountId". type: string required: - type - value type: object GetDateFieldResponse: additionalProperties: false properties: dateCustomFieldId: description: A date custom field ID. This is returned if the type is "DateCustomField". format: int64 type: integer type: description: The date field type. This is "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField". enum: - DueDate - TargetStartDate - TargetEndDate - DateCustomField type: string required: - type type: object GetCrossProjectReleaseResponse: additionalProperties: false properties: name: description: The cross-project release name. type: string releaseIds: description: The IDs of the releases included in the cross-project release. items: format: int64 type: integer type: array uniqueItems: true type: object CreatePlanRequest: additionalProperties: false properties: crossProjectReleases: description: The cross-project releases to include in the plan. items: $ref: '#/components/schemas/CreateCrossProjectReleaseRequest' type: array uniqueItems: true customFields: description: The custom fields for the plan. items: $ref: '#/components/schemas/CreateCustomFieldRequest' type: array uniqueItems: true exclusionRules: allOf: - $ref: '#/components/schemas/CreateExclusionRulesRequest' description: The exclusion rules for the plan. issueSources: description: The issue sources to include in the plan. items: $ref: '#/components/schemas/CreateIssueSourceRequest' type: array uniqueItems: true leadAccountId: description: The account ID of the plan lead. type: string name: description: The plan name. maxLength: 255 minLength: 1 type: string permissions: description: The permissions for the plan. items: $ref: '#/components/schemas/CreatePermissionRequest' type: array uniqueItems: true scheduling: allOf: - $ref: '#/components/schemas/CreateSchedulingRequest' description: The scheduling settings for the plan. required: - issueSources - name - scheduling type: object CreateDateFieldRequest: additionalProperties: false properties: dateCustomFieldId: description: A date custom field ID. This is required if the type is "DateCustomField". format: int64 type: integer type: description: The date field type. This must be "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField". enum: - DueDate - TargetStartDate - TargetEndDate - DateCustomField type: string required: - type type: object GetSchedulingResponse: additionalProperties: false properties: dependencies: description: The dependencies for the plan. This is "Sequential" or "Concurrent". enum: - Sequential - Concurrent type: string endDate: allOf: - $ref: '#/components/schemas/GetDateFieldResponse' description: The end date field for the plan. estimation: description: The estimation unit for the plan. This is "StoryPoints", "Days" or "Hours". enum: - StoryPoints - Days - Hours type: string inferredDates: description: The inferred dates for the plan. This is "None", "SprintDates" or "ReleaseDates". enum: - None - SprintDates - ReleaseDates type: string startDate: allOf: - $ref: '#/components/schemas/GetDateFieldResponse' description: The start date field for the plan. required: - dependencies - endDate - estimation - inferredDates - startDate type: object CreateSchedulingRequest: additionalProperties: false properties: dependencies: description: The dependencies for the plan. This must be "Sequential" or "Concurrent". enum: - Sequential - Concurrent type: string endDate: allOf: - $ref: '#/components/schemas/CreateDateFieldRequest' description: The end date field for the plan. estimation: description: The estimation unit for the plan. This must be "StoryPoints", "Days" or "Hours". enum: - StoryPoints - Days - Hours type: string inferredDates: description: The inferred dates for the plan. This must be "None", "SprintDates" or "ReleaseDates". enum: - None - SprintDates - ReleaseDates type: string startDate: allOf: - $ref: '#/components/schemas/CreateDateFieldRequest' description: The start date field for the plan. required: - estimation type: object ErrorCollection: additionalProperties: false description: Error messages from an operation. properties: errorMessages: description: The list of error messages produced by this operation. For example, "input parameter 'key' must be provided" items: type: string type: array errors: additionalProperties: type: string description: 'The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."' type: object status: format: int32 type: integer type: object DuplicatePlanRequest: additionalProperties: false properties: name: description: The plan name. type: string required: - name type: object CreateCrossProjectReleaseRequest: additionalProperties: false properties: name: description: The cross-project release name. type: string releaseIds: description: The IDs of the releases to include in the cross-project release. items: format: int64 type: integer type: array uniqueItems: true required: - name type: object GetPlanResponseForPage: additionalProperties: false properties: id: description: The plan ID. type: string issueSources: description: The issue sources included in the plan. items: $ref: '#/components/schemas/GetIssueSourceResponse' type: array uniqueItems: true name: description: The plan name. type: string scenarioId: description: Default scenario ID. type: string status: description: The plan status. This is "Active", "Trashed" or "Archived". enum: - Active - Trashed - Archived type: string required: - id - name - scenarioId - status type: object GetExclusionRulesResponse: additionalProperties: false properties: issueIds: description: The IDs of the issues excluded from the plan. items: format: int64 type: integer type: array uniqueItems: true issueTypeIds: description: The IDs of the issue types excluded from the plan. items: format: int64 type: integer type: array uniqueItems: true numberOfDaysToShowCompletedIssues: description: Issues completed this number of days ago are excluded from the plan. format: int32 type: integer releaseIds: description: The IDs of the releases excluded from the plan. items: format: int64 type: integer type: array uniqueItems: true workStatusCategoryIds: description: The IDs of the work status categories excluded from the plan. items: format: int64 type: integer type: array uniqueItems: true workStatusIds: description: The IDs of the work statuses excluded from the plan. items: format: int64 type: integer type: array uniqueItems: true required: - numberOfDaysToShowCompletedIssues type: object GetPermissionResponse: additionalProperties: false properties: holder: allOf: - $ref: '#/components/schemas/GetPermissionHolderResponse' description: The permission holder. type: description: The permission type. This is "View" or "Edit". enum: - View - Edit type: string required: - holder - type type: object CreateIssueSourceRequest: additionalProperties: false properties: type: description: The issue source type. This must be "Board", "Project" or "Filter". enum: - Board - Project - Filter type: string value: description: The issue source value. This must be a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter". format: int64 type: integer required: - type - value type: object GetIssueSourceResponse: additionalProperties: false properties: type: description: The issue source type. This is "Board", "Project" or "Filter". enum: - Board - Project - Filter - Custom type: string value: description: The issue source value. This is a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter". format: int64 type: integer required: - type - value type: object CreateCustomFieldRequest: additionalProperties: false properties: customFieldId: description: The custom field ID. format: int64 type: integer filter: description: Allows filtering issues based on their values for the custom field. type: boolean required: - customFieldId type: object GetCustomFieldResponse: additionalProperties: false properties: customFieldId: description: The custom field ID. format: int64 type: integer filter: description: Allows filtering issues based on their values for the custom field. type: boolean required: - customFieldId type: object CreatePermissionRequest: additionalProperties: false properties: holder: allOf: - $ref: '#/components/schemas/CreatePermissionHolderRequest' description: The permission holder. type: description: The permission type. This must be "View" or "Edit". enum: - View - Edit type: string required: - holder - type type: object GetPlanResponse: additionalProperties: false properties: crossProjectReleases: description: The cross-project releases included in the plan. items: $ref: '#/components/schemas/GetCrossProjectReleaseResponse' type: array customFields: description: The custom fields for the plan. items: $ref: '#/components/schemas/GetCustomFieldResponse' type: array exclusionRules: allOf: - $ref: '#/components/schemas/GetExclusionRulesResponse' description: The exclusion rules for the plan. id: description: The plan ID. format: int64 type: integer issueSources: description: The issue sources included in the plan. items: $ref: '#/components/schemas/GetIssueSourceResponse' type: array lastSaved: description: The date when the plan was last saved in UTC. type: string leadAccountId: description: The account ID of the plan lead. type: string name: description: The plan name. type: string permissions: description: The permissions for the plan. items: $ref: '#/components/schemas/GetPermissionResponse' type: array scheduling: allOf: - $ref: '#/components/schemas/GetSchedulingResponse' description: The scheduling settings for the plan. status: description: The plan status. This is "Active", "Trashed" or "Archived". enum: - Active - Trashed - Archived type: string required: - id - scheduling - status type: object CreatePermissionHolderRequest: additionalProperties: false properties: type: description: The permission holder type. This must be "Group" or "AccountId". enum: - Group - AccountId type: string value: description: The permission holder value. This must be a group name if the type is "Group" or an account ID if the type is "AccountId". type: string required: - type - value type: object securitySchemes: OAuth2: description: OAuth2 scopes for Jira flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize scopes: delete:async-task:jira: Delete asynchronous task. delete:attachment:jira: Delete issue attachments. delete:avatar:jira: Delete system and custom avatars. delete:comment.property:jira: Delete issue comment properties. delete:comment:jira: Delete issue comments. delete:dashboard.property:jira: Delete dashboard properties. delete:dashboard:jira: Delete dashboards. delete:field-configuration-scheme:jira: Delete field configuration schemes. delete:field-configuration:jira: Delete field configurations. delete:field.option:jira: Delete field options. delete:field:jira: Delete fields. delete:filter.column:jira: Delete filter columns. delete:filter:jira: Delete filters. delete:group:jira: Delete user groups. delete:issue-link-type:jira: Delete issue link types. delete:issue-link:jira: Delete issue links. delete:issue-type-scheme:jira: Delete issue type schemes. delete:issue-type-screen-scheme:jira: Delete issue type screen schemes. delete:issue-type.property:jira: Delete issue type properties. delete:issue-type:jira: Delete issue types. delete:issue-worklog.property:jira: Delete issue worklog properties. delete:issue-worklog:jira: Delete issue worklogs. delete:issue.property:jira: Delete issue properties. delete:issue.remote-link:jira: Delete issue remote links. delete:issue:jira: Delete issues. delete:permission-scheme:jira: Delete permission schemes. delete:permission:jira: Delete permissions. delete:project-category:jira: Delete project categories. delete:project-role:jira: Delete project roles. delete:project-version:jira: Delete project versions. delete:project.avatar:jira: Delete project avatars. delete:project.component:jira: Delete project components. delete:project.property:jira: Delete project properties. delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars. delete:screen-scheme:jira: Delete screen schemes. delete:screen-tab:jira: Delete screen tabs. delete:screen:jira: Delete screens. delete:screenable-field:jira: Delete screenable fields. delete:user-configuration:jira: Delete user configurations. delete:user.property:jira: Delete user properties. delete:webhook:jira: Delete webhooks. delete:workflow-scheme:jira: Delete workflow schemes. delete:workflow.property:jira: Delete workflow properties. delete:workflow:jira: Delete workflows. manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components. manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. read:app-data:jira: Read app data. read:application-role:jira: View application roles. read:attachment:jira: View issue attachments. read:audit-log:jira: View audit logs. read:avatar:jira: View system and custom avatars. read:comment.property:jira: View issue comment properties. read:comment:jira: View issue comments. read:custom-field-contextual-configuration:jira: Read custom field contextual configurations. read:dashboard.property:jira: View dashboard properties. read:dashboard:jira: View dashboards. read:email-address:jira: View email addresses of all users regardless of the user's profile visibility settings. read:field-configuration-scheme:jira: View field configuration schemes. read:field-configuration:jira: Read field configurations. read:field.default-value:jira: View field default values. read:field.option:jira: View field options. read:field.options:jira: Read field options. read:field:jira: View fields. read:filter.column:jira: View filter columns. read:filter.default-share-scope:jira: View filter default share scopes. read:filter:jira: View filters. read:group:jira: View user groups. read:instance-configuration:jira: View instance configurations. read:issue-details:jira: View issue details. read:issue-event:jira: Read issue events. read:issue-field-values:jira: View issue field valueses. read:issue-link-type:jira: View issue link types. read:issue-link:jira: View issue links. read:issue-meta:jira: View issue meta. read:issue-security-level:jira: View issue security levels. read:issue-security-scheme:jira: View issue security schemes. read:issue-status:jira: View issue statuses. read:issue-type-hierarchy:jira: Read issue type hierarchies. read:issue-type-scheme:jira: View issue type schemes. read:issue-type-screen-scheme:jira: View issue type screen schemes. read:issue-type.property:jira: View issue type properties. read:issue-type:jira: View issue types. read:issue-worklog.property:jira: View issue worklog properties. read:issue-worklog:jira: View issue worklogs. read:issue.changelog:jira: View issue changelogs. read:issue.property:jira: View issue properties. read:issue.remote-link:jira: View issue remote links. read:issue.time-tracking:jira: View issue time trackings. read:issue.transition:jira: View issue transitions. read:issue.vote:jira: View issue votes. read:issue.votes:jira: View issue voteses. read:issue.watcher:jira: View issue watchers. read:issue:jira: View issues. read:jira-expressions:jira: View jira expressions. read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars. read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). read:jql:jira: View JQL. read:label:jira: View labels. read:license:jira: View licenses. read:notification-scheme:jira: View notification schemes. read:permission-scheme:jira: View permission schemes. read:permission:jira: View permissions. read:priority:jira: View priorities. read:project-category:jira: View project categories. read:project-role:jira: View project roles. read:project-type:jira: View project types. read:project-version:jira: View project versions. read:project.avatar:jira: Read project avatars. read:project.component:jira: View project components. read:project.email:jira: View project emails. read:project.feature:jira: Read project features. read:project.property:jira: View project properties. read:project:jira: View projects. read:resolution:jira: View resolutions. read:role:jira: View roles. read:screen-field:jira: View screen fields. read:screen-scheme:jira: View screen schemes. read:screen-tab:jira: View screen tabs. read:screen:jira: View screens. read:screenable-field:jira: View screenable fields. read:status:jira: View statuses. read:user-configuration:jira: View user configurations. read:user.columns:jira: View user columnses. read:user.property:jira: View user properties. read:user:jira: View users. read:webhook:jira: View webhooks. read:workflow-scheme:jira: View workflow schemes. read:workflow.property:jira: View workflow properties. read:workflow:jira: View workflows. send:notification:jira: Send notifications. validate:jql:jira: Validate JQL. write:app-data:jira: Write app data. write:attachment:jira: Create and update issue attachments. write:avatar:jira: Create and update system and custom avatars. write:comment.property:jira: Create and update issue comment properties. write:comment:jira: Create and update issue comments. write:custom-field-contextual-configuration:jira: Save custom field contextual configurations. write:dashboard.property:jira: Create and update dashboard properties. write:dashboard:jira: Create and update dashboards. write:field-configuration-scheme:jira: Create and update field configuration schemes. write:field-configuration:jira: Save field configurations. write:field.default-value:jira: Create and update field default values. write:field.option:jira: Create and update field options. write:field:jira: Create and update fields. write:filter.column:jira: Create and update filter columns. write:filter.default-share-scope:jira: Create and update filter default share scopes. write:filter:jira: Create and update filters. write:group:jira: Create and update user groups. write:instance-configuration:jira: Create and update instance configurations. write:issue-link-type:jira: Create and update issue link types. write:issue-link:jira: Create and update issue links. write:issue-type-scheme:jira: Create and update issue type schemes. write:issue-type-screen-scheme:jira: Create and update issue type screen schemes. write:issue-type.property:jira: Create and update issue type properties. write:issue-type:jira: Create and update issue types. write:issue-worklog.property:jira: Create and update issue worklog properties. write:issue-worklog:jira: Create and update issue worklogs. write:issue.property:jira: Create and update issue properties. write:issue.remote-link:jira: Create and update issue remote links. write:issue.time-tracking:jira: Create and update issue time trackings. write:issue.vote:jira: Create and update issue votes. write:issue.watcher:jira: Create and update issue watchers. write:issue:jira: Create and update issues. write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues. write:permission-scheme:jira: Create and update permission schemes. write:permission:jira: Create and update permissions. write:project-category:jira: Create and update project categories. write:project-role:jira: Create and update project roles. write:project-version:jira: Create and update project versions. write:project.avatar:jira: Create and update project avatars. write:project.component:jira: Create and update project components. write:project.email:jira: Create and update project emails. write:project.feature:jira: Save project features. write:project.property:jira: Create and update project properties. write:project:jira: Create and update projects. write:screen-scheme:jira: Create and update screen schemes. write:screen-tab:jira: Create and update screen tabs. write:screen:jira: Create and update screens. write:screenable-field:jira: Create and update screenable fields. write:user-configuration:jira: Create and update user configurations. write:user.property:jira: Create and update user properties. write:webhook:jira: Create and update webhooks. write:workflow-scheme:jira: Create and update workflow schemes. write:workflow.property:jira: Create and update workflow properties. write:workflow:jira: Create and update workflows. tokenUrl: https://auth.atlassian.com/oauth/token type: oauth2 basicAuth: description: You can access this resource via basic auth. scheme: basic type: http externalDocs: description: Find out more about Atlassian products and services. url: http://www.atlassian.com x-atlassian-narrative: documents: - anchor: about body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses." title: About - anchor: version body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest\nversion. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and\nversion 3 of the API offer the same collection of operations. However, version 3 provides support for\nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)\n(ADF) in:\n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields\n (`textfield`) accept a string and don't handle Atlassian Document Format content.\n" title: Version - anchor: authentication body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira//rest/api/3/`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n" title: Authentication and authorization - anchor: permissions body: "### Operation permissions\n\nMost operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. There is a default group for this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the default product access group (for example, \n_jira-software-users-acmesite_) have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n\n### Anonymous access\n\nSome operations provide support for anonymous access. However, anonymous access is only available if \nthe Jira permission needed to access the object or records returned by the operation is granted to \nthe _Public_ group. See [Allowing anonymous access to your project](https://confluence.atlassian.com/x/GDxxLg) \nfor details.\n\nIf an operation is called anonymously and anonymous access is not available, the operation will return \nan error. Note that not all operations that correspond to objects that can be given public access \nprovide for anonymous access.\n" title: Permissions - anchor: expansion body: "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n \"expand\": \"widgets\", \n \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n \"widgets\": {\n \"widgets\": [],\n \"size\": 5\n }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n \"startAt\" : 0,\n \"maxResults\" : 10,\n \"total\": 200,\n \"isLast\": false,\n \"values\": [\n { /* result 0 */ },\n { /* result 1 */ },\n { /* result 2 */ }\n ]\n}\n```\n\n* `startAt` is the index of the first item returned in the page.\n* `maxResults` is the maximum number of items that a page can return. Each operation can have a different limit for\n the number of items returned, and these limits may change without notice. To find the maximum number of items \n that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.\n* `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n* `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n* `?orderBy=name` to order by `name` field ascending.\n* `?orderBy=+name` to order by `name` field ascending.\n* `?orderBy=-name` to order by `name` field descending.\n\n\n" title: Expansion, pagination, and ordering - anchor: timestamps body: 'By default, top-level timestamps (e.g. updated and created) are returned in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system default user time zone. To return date time data in the logged in user''s timezone, please refer to `renderedFields` property under the `expand` query parameter in relevant APIs. ' title: Timestamps - anchor: special-request-headers body: 'The following request and response headers define important metadata for the Jira Cloud REST API resources. - `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests. Otherwise the request is blocked by cross-site request forgery (CSRF/XSRF) protection. - `X-Force-Accept-Language` (request): controls how the standard HTTP `Accept-Language` header is processed. By default `Accept-Language` is ignored and the response is in the language configured in the user''s profile or, when no language is configured for the user, the default Jira instance language. For the response to recognize `Accept-Language` send `X-Force-Accept-Language = true` as well. If `Accept-Language` requests a language that Jira can return the response is in that language, otherwise Jira returns the response in the default language. If `Accept-Language` is not specified the response is in the default language. - `X-AAccountId` (response): This response header contains the Atlassian account ID of the authenticated user.' title: Special headers - anchor: anonymous-operations body: " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\"" title: Anonymous operations - anchor: async-operations body: "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished." title: Asynchronous operations - anchor: experimental body: "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport issues to [Developer and Marketplace support](https://developer.atlassian.com/support) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n" title: Experimental features - anchor: status-codes body: "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n \"title\": \"Error Collection\",\n \"type\": \"object\",\n \"properties\": {\n \"errorMessages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"errors\": {\n \"type\": \"object\",\n \"patternProperties\": {\n \".+\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"status\": { \n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n}\n```" title: Status codes