provider Plans GET /rest/api/3/plans/plan
@utdk/jira /rest/api/3/plans/plan
Get plans paginated
Returns a [paginated](#pagination) list of plans. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
includeTrashed query
Whether to include trashed plans in the results.
boolean
includeArchived query
Whether to include archived plans in the results.
boolean
cursor query
The cursor to start from. If not provided, the first page will be returned.
string
maxResults query
The maximum number of plans to return per page. The maximum value is 50. The default value is 50.
integer

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getplans
GET/rest/api/3/plans/plan
Returns a [paginated](#pagination) list of plans. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Whether to include trashed plans in the results.

Whether to include archived plans in the results.

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getplans({
  "includeTrashed": false,
  "includeArchived": false,
  "maxResults": 50
})