How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Plans API

This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans.

Jira Plans API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 7 operations across 5 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

7 operations 5 paths 22 schemas 2 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Plans API 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 Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 2 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

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
getPlans 4 params → 200401403
POST
/rest/api/3/plans/plan
Create plan
createPlan 1 param body → 201400401403
GET
/rest/api/3/plans/plan/{planId}
Get plan
getPlan 2 params → 200401403404
PUT
/rest/api/3/plans/plan/{planId}
Update plan
updatePlan 2 params body → 204400401403404409
PUT
/rest/api/3/plans/plan/{planId}/archive
Archive plan
archivePlan 1 param → 204401403404409
POST
/rest/api/3/plans/plan/{planId}/duplicate
Duplicate plan
duplicatePlan 1 param body → 201400401403404409
PUT
/rest/api/3/plans/plan/{planId}/trash
Trash plan
trashPlan 1 param → 204401403404409

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are GetPlanResponse (11 properties), CreatePlanRequest (8 properties), PageWithCursorGetPlanResponseForPage (6 properties), GetExclusionRulesResponse (6 properties). Each schema is shown below with its type and property counts.

GetIssueSourceResponse
object
2 properties 2 required
CreateIssueSourceRequest
object
2 properties 2 required
GetPermissionResponse
object
2 properties 2 required
ErrorCollection
object
Error messages from an operation.
3 properties
GetDateFieldResponse
object
2 properties 1 required
CreatePlanRequest
object
8 properties 3 required
GetSchedulingResponse
object
5 properties 5 required
GetCrossProjectReleaseResponse
object
2 properties
CreateSchedulingRequest
object
5 properties 1 required
DuplicatePlanRequest
object
1 property 1 required
CreateCustomFieldRequest
object
2 properties 1 required
GetCustomFieldResponse
object
2 properties 1 required
CreateCrossProjectReleaseRequest
object
2 properties 1 required
CreateExclusionRulesRequest
object
6 properties
CreatePermissionRequest
object
2 properties 2 required
PageWithCursorGetPlanResponseForPage
object
6 properties
CreateDateFieldRequest
object
2 properties 1 required
CreatePermissionHolderRequest
object
2 properties 2 required
GetExclusionRulesResponse
object
6 properties 1 required
GetPermissionHolderResponse
object
2 properties 2 required
GetPlanResponse
object
11 properties 3 required
GetPlanResponseForPage
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-plans-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Plans API, 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.