---
title: "Get plan"
method: GET
path: "/rest/api/2/plans/plan/{planId}"
tags: ["Plans"]
---

# Get plan

`GET /rest/api/2/plans/plan/{planId}`

Returns a plan.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

## Path parameters

- `planId` integer, required

## Query parameters

- `useGroupId` boolean

## Response `200`

Returned if the request is successful.

- GetPlanResponse
  - `crossProjectReleases` GetCrossProjectReleaseResponse[] — The cross-project releases included in the plan.
    - `name` string — The cross-project release name.
    - `releaseIds` integer[] — The IDs of the releases included in the cross-project release.
  - `customFields` GetCustomFieldResponse[] — The custom fields for the plan.
    - `customFieldId` integer, required — The custom field ID.
    - `filter` boolean — Allows filtering issues based on their values for the custom field.
  - `exclusionRules` GetExclusionRulesResponse
    - `issueIds` integer[] — The IDs of the issues excluded from the plan.
    - `issueTypeIds` integer[] — The IDs of the issue types excluded from the plan.
    - `numberOfDaysToShowCompletedIssues` integer, required — Issues completed this number of days ago are excluded from the plan.
    - `releaseIds` integer[] — The IDs of the releases excluded from the plan.
    - `workStatusCategoryIds` integer[] — The IDs of the work status categories excluded from the plan.
    - `workStatusIds` integer[] — The IDs of the work statuses excluded from the plan.
  - `id` integer, required — The plan ID.
  - `issueSources` GetIssueSourceResponse[] — The issue sources included in the plan.
    - `type` 'Board' | 'Project' | 'Filter' | 'Custom', required — The issue source type. This is "Board", "Project" or "Filter".
    - `value` integer, required — The issue source value. This is a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter".
  - `lastSaved` string — The date when the plan was last saved in UTC.
  - `leadAccountId` string — The account ID of the plan lead.
  - `name` string — The plan name.
  - `permissions` GetPermissionResponse[] — The permissions for the plan.
    - `holder` GetPermissionHolderResponse, required
      - `type` 'Group' | 'AccountId', required — The permission holder type. This is "Group" or "AccountId".
      - `value` string, required — The permission holder value. This is a group name if the type is "Group" or an account ID if the type is "AccountId".
    - `type` 'View' | 'Edit', required — The permission type. This is "View" or "Edit".
  - `scheduling` GetSchedulingResponse, required
    - `dependencies` 'Sequential' | 'Concurrent', required — The dependencies for the plan. This is "Sequential" or "Concurrent".
    - `endDate` GetDateFieldResponse, required
      - `dateCustomFieldId` integer — A date custom field ID. This is returned if the type is "DateCustomField".
      - `type` 'DueDate' | 'TargetStartDate' | 'TargetEndDate' | 'DateCustomField', required — The date field type. This is "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField".
    - `estimation` 'StoryPoints' | 'Days' | 'Hours', required — The estimation unit for the plan. This is "StoryPoints", "Days" or "Hours".
    - `inferredDates` 'None' | 'SprintDates' | 'ReleaseDates', required — The inferred dates for the plan. This is "None", "SprintDates" or "ReleaseDates".
    - `startDate` GetDateFieldResponse, required
      - `dateCustomFieldId` integer — A date custom field ID. This is returned if the type is "DateCustomField".
      - `type` 'DueDate' | 'TargetStartDate' | 'TargetEndDate' | 'DateCustomField', required — The date field type. This is "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField".
  - `status` 'Active' | 'Trashed' | 'Archived', required — The plan status. This is "Active", "Trashed" or "Archived".

## Other responses

- `401` — Returned if the user is not logged in.
- `403` — Returned if the site has no premium edition of Jira or if the user does not have the Administer Jira global permission.
- `404` — Returned if the plan is not found.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)