Skip to main content
GET
/
api
/
projects
/
{projectId}
/
releases
List releases
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/releases \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedAt": "<string>",
      "name": "<string>",
      "description": "<string>",
      "version": 123,
      "semanticVersion": "<string>",
      "status": "draft",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "meta": {
        "bucket": "<string>",
        "key": "<string>"
      },
      "changeRequests": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "environment": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        }
      ]
    }
  ],
  "paginate": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project unique identifier

Query Parameters

Search query to filter releases by version or name

status
enum<string> | null

Filter releases by status

Available options:
draft,
published,
completed,
page
number
default:1

Current page

perPage
number
default:10

Number of items per page

Response

200 - application/json

Paginated list of releases

Paginated list of releases

results
object[]
required

List of releases

paginate
object
required

Pagination metadata