Plans

Get plan

Returns a plan.

Permissions required: Administer Jira global permission.

get/rest/api/2/plans/plan/{planId}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/plans/plan/{planId}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)

Path parameters

planIdinteger required

The ID of the plan.

Query parameters

useGroupIdboolean

Whether to return group IDs instead of group names. Group names are deprecated.

Response

Returned if the request is successful.

idinteger required

The plan ID.

lastSavedstring

The date when the plan was last saved in UTC.

leadAccountIdstring

The account ID of the plan lead.

namestring

The plan name.

status'Active' | 'Trashed' | 'Archived' required

The plan status. This is "Active", "Trashed" or "Archived".

Changes

No recorded changes to this operation across all 26 revisions of this API.