Plans

Get plans paginated

Returns a paginated list of plans.

Permissions required: Administer Jira global permission.

get/rest/api/2/plans/plan

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/plans/plan
  • 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)

Query parameters

includeTrashedboolean

Whether to include trashed plans in the results.

includeArchivedboolean

Whether to include archived plans in the results.

cursorstring

The cursor to start from. If not provided, the first page will be returned.

maxResultsinteger

The maximum number of plans to return per page. The maximum value is 50. The default value is 50.

Response

Returned if the request is successful.

cursorstring
lastboolean
nextPageCursorstring
sizeinteger
totalinteger

Changes

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