Project versions

Get project versions paginated

Changed on

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.

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/version
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work
    • or none

Path parameters

projectIdOrKeystring required

The project ID or project key (case sensitive).

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

orderBy'description' | '-description' | '+description' | 'name' | '-name' | '+name' | 'releaseDate' | '-releaseDate' | '+releaseDate' | 'sequence' | '-sequence' | '+sequence' | 'startDate' | '-startDate' | '+startDate'

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.
querystring

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

statusstring

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.

expandstring

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.
  • driver Returns the Atlassian account ID of the version driver.
  • approvers Returns a list containing the approvers for this version.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

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

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes