Get project versions paginated

GET

/rest/api/3/project/{projectIdOrKey}/version

Project versions

Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/project//version'

Response Example

200 - Success

{
  "self": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2",
  "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2",
  "maxResults": 2,
  "startAt": 0,
  "total": 7,
  "isLast": false,
  "values": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
      "id": "10000",
      "description": "An excellent version",
      "name": "New Version 1",
      "archived": false,
      "released": true,
      "releaseDate": "2010-07-06",
      "overdue": true,
      "userReleaseDate": "6/Jul/2010",
      "projectId": 10000
    },
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/version/10010",
      "id": "10010",
      "description": "Minor Bugfix version",
      "name": "Next Version",
      "archived": false,
      "released": false,
      "overdue": false,
      "projectId": 10000,
      "issuesStatusForFixVersion": {
        "unmapped": 0,
        "toDo": 10,
        "inProgress": 20,
        "done": 100
      }
    }
  ]
}

Request

Path Params

projectIdOrKey

string

required

The project ID or project key (case sensitive).

Query Params

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

orderBy

string

optional

Order the results by a field:

description Sorts by version description.

name Sorts by version name.

releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last.

sequence Sorts by the order of appearance in the user interface.

startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.

query

string

optional

Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).

status

string

optional

A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.

expand

string

optional

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

issuesstatus Returns the number of issues in each status category for each version.

operations Returns actions that can be performed on the specified version.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (Version) {17}]

read-onlyoptional

The list of items.

archived

boolean

optional

Indicates that the version is archived. Optional when creating or updating a version.

description

string

optional

The description of the version. Optional when creating or updating a version.

expand

string

optional

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

operations Returns the list of operations available for this version.

issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.

Optional for create and update.

string

read-onlyoptional

The ID of the version.

issuesStatusForFixVersion

object

read-onlyoptional

If the expand option issuesstatus is used, returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.

moveUnfixedIssuesTo

string <uri>

optional

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name

string

optional

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

operations

array[object (SimpleLink) {7}]

read-onlyoptional

If the expand option operations is used, returns the list of operations available for this version.

overdue

boolean

read-onlyoptional

Indicates that the version is overdue.

project

string

optional

Deprecated. Use projectId.

projectId

integer <int64>

optional

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

releaseDate

string <date>

optional

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

released

boolean

optional

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

self

string <uri>

read-onlyoptional

The URL of the version.

startDate

string <date>

optional

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate

string

read-onlyoptional

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDate

string

read-onlyoptional

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

🟠404Returned if the project is not found or the user does not have permission to view it.

Modified at 2023-07-13 03:27:27

Delete default actors from project role

Get project versions