v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
Release pipelines (beta)

Get release progressions for release pipeline

Get details on the progression of all releases, across all flags, for a release pipeline

get/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases

Path parameters

projectKeystring string required

The project key

The project key

pipelineKeystring string required

The pipeline key

The pipeline key

Query parameters

filterstring string

Accepts filter by status and activePhaseId. status can take a value of completed or active. activePhaseId takes a UUID and will filter results down to releases active on the specified phase. Providing status equals completed along with an activePhaseId filter will return an error as they are disjoint sets of data. The combination of status equals active and activePhaseId will return the same results as activePhaseId alone.

Accepts filter by status and activePhaseId. status can take a value of completed or active. activePhaseId takes a UUID and will filter results down to releases active on the specified phase. Providing status equals completed along with an activePhaseId filter will return an error as they are disjoint sets of data. The combination of status equals active and activePhaseId will return the same results as activePhaseId alone.

limitinteger

The maximum number of items to return. Defaults to 20.

The maximum number of items to return. Defaults to 20.

offsetinteger

Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Response

Release progression collection

activeCountinteger required

The number of active releases

completedCountinteger required

The number of completed releases

totalCountinteger required

The total number of releases for this release pipeline

_linksobject required

The location and content type of related resources

Example response

{
  "activeCount": 3,
  "completedCount": 1,
  "items": [
    {
      "flagKey": "flag-key-123abc",
      "activePhaseId": "1234a56b7c89d012345e678f"
    }
  ],
  "phases": [
    {
      "_id": "1234a56b7c89d012345e678f",
      "name": "Phase 1 - Testing",
      "releaseCount": 2
    }
  ],
  "totalCount": 8
}