GET /rest/api/2/project/{projectIdOrKey}/version

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.

Servers

Path parameters

Name Type Required Description
projectIdOrKey String Yes

The project ID or project key (case sensitive).

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

query String No

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

maxResults Integer No

The maximum number of items to return per page.

Default value: 50

orderBy String No

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.

Possible values:

  • "sequence"
  • "startDate"
  • "+startDate"
  • "-description"
  • "description"
  • "-releaseDate"
  • "+sequence"
  • "-sequence"
  • "releaseDate"
  • "name"
  • "-name"
  • "+releaseDate"
  • "+description"
  • "+name"
  • "-startDate"
expand String No

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.
status String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.