---
title: "Get a release"
method: GET
path: "/api/projects/{projectId}/releases/{releaseId}"
tags: ["Release"]
---

# Get a release

`GET /api/projects/{projectId}/releases/{releaseId}`

Retrieve a single release by ID, optionally including diff information compared to a previous release.

## Path parameters

- `projectId` string, uuid, required
- `releaseId` string, uuid, required

## Query parameters

- `previousReleaseId` string, uuid

## Response `200`

Release details with files

- object — Release details with files
  - `id` string, uuid, required — Release unique identifier
  - `createdAt` string, required — Release creation timestamp
  - `deletedAt` string, nullable — Release deletion timestamp
  - `name` string, nullable — Release name
  - `description` string, nullable — Release description
  - `version` number, nullable — Legacy numeric version
  - `semanticVersion` string, nullable — Semantic version (e.g., 1.0.0)
  - `status` 'draft' | 'published' | 'completed' — Release status
  - `projectId` string, uuid, required — Project ID the release belongs to
  - `createdById` string, uuid, nullable — ID of the user who created the release
  - `commitId` string, uuid, nullable — Associated commit ID
  - `meta` object, nullable — Release storage metadata
    - `bucket` string — Storage bucket name
    - `key` string — Storage object key
  - `files` object[] — List of files in the release
    - `id` string, uuid, required — File unique identifier
    - `name` string, nullable — File name
    - `path` string, required — File path within the release
    - `contentType` string, nullable — MIME type of the file
    - `contentHash` string, nullable — MD5 hash of the file content
    - `releaseId` string, uuid, required — ID of the release this file belongs to
    - `versionId` string, uuid, nullable — Document version ID
    - `createdAt` string, nullable — File creation timestamp
    - `diffStatus` 'added' | 'modified' | 'removed' | 'unchanged' — Diff status when comparing releases
    - `previousReleaseId` string, uuid — Previous release ID for modified files
    - `previousId` string, uuid — Previous file ID for modified files
  - `createdBy` object, nullable — User who created the release
    - `id` string, uuid, required — User unique identifier
    - `email` string, email, required — User email address
    - `firstName` string, nullable, required — User first name
    - `lastName` string, nullable, required — User last name
    - `type` string, nullable, required — User type
    - `status` string, nullable, required — User status
  - `changeRequests` object[] — Pending change requests
    - `id` string, uuid, required — Change request unique identifier
    - `status` string, required — Change request status
    - `environment` object, nullable — Environment details
      - `id` string, uuid, required — Environment unique identifier
      - `name` string, required — Environment name

---

[API](https://skmtc.dev/gorules/apis/gorules-agent-api.md) · [All operations](https://skmtc.dev/gorules/apis/gorules-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gorules/gorules-agent-api/revisions/52c0773fcd80/schema)
