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 Teams in plan API

This resource represents planning settings for plan-only and Atlassian teams in a plan. Use it to get, create, update and delete planning settings.

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

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

This API exposes 9 operations across 5 paths, and defines 7 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.

9 operations 5 paths 7 schemas 2 DELETE3 GET2 POST2 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 Teams in plan 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 9

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

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
getTeams 3 params → 200401403404
POST
/rest/api/3/plans/plan/{planId}/team/atlassian
Add Atlassian team to plan
addAtlassianTeam 1 param body → 204400401403404409
DELETE
/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Remove Atlassian team from plan
removeAtlassianTeam 2 params → 204401403404409
GET
/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Get Atlassian team in plan
getAtlassianTeam 2 params → 200401403404409
PUT
/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Update Atlassian team in plan
updateAtlassianTeam 2 params body → 204400401403404409
POST
/rest/api/3/plans/plan/{planId}/team/planonly
Create plan-only team
createPlanOnlyTeam 1 param body → 201400401403404409
DELETE
/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Delete plan-only team
deletePlanOnlyTeam 2 params → 204401403404409
GET
/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Get plan-only team
getPlanOnlyTeam 2 params → 200401403404409
PUT
/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Update plan-only team
updatePlanOnlyTeam 2 params body → 204400401403404409

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GetPlanOnlyTeamResponse (7 properties), CreatePlanOnlyTeamRequest (6 properties), PageWithCursorGetTeamResponseForPage (6 properties), AddAtlassianTeamRequest (5 properties). Each schema is shown below with its type and property counts.

PageWithCursorGetTeamResponseForPage
object
6 properties
GetPlanOnlyTeamResponse
object
7 properties 3 required
CreatePlanOnlyTeamRequest
object
6 properties 2 required
GetAtlassianTeamResponse
object
5 properties 2 required
AddAtlassianTeamRequest
object
5 properties 2 required
GetTeamResponseForPage
object
3 properties 2 required
ErrorCollection
object
Error messages from an operation.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-teams-in-plan-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 Teams in plan 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.