> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gorules.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a release

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



## OpenAPI

````yaml /openapi/brms.json get /api/projects/{projectId}/releases/{releaseId}
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/releases/{releaseId}:
    get:
      tags:
        - Release
      summary: Get a release
      description: >-
        Retrieve a single release by ID, optionally including diff information
        compared to a previous release.
      operationId: getRelease
      parameters:
        - schema:
            type: string
            format: uuid
          in: query
          name: previousReleaseId
          description: Previous release ID for computing file diffs
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project unique identifier
        - schema:
            type: string
            format: uuid
          in: path
          name: releaseId
          required: true
          description: Release unique identifier
      responses:
        '200':
          description: Release details with files
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Release unique identifier
                  createdAt:
                    type: string
                    description: Release creation timestamp
                  deletedAt:
                    type: string
                    nullable: true
                    description: Release deletion timestamp
                  name:
                    type: string
                    nullable: true
                    description: Release name
                  description:
                    type: string
                    nullable: true
                    description: Release description
                  version:
                    type: number
                    nullable: true
                    description: Legacy numeric version
                  semanticVersion:
                    type: string
                    nullable: true
                    description: Semantic version (e.g., 1.0.0)
                  status:
                    type: string
                    enum:
                      - draft
                      - published
                      - completed
                    description: Release status
                  projectId:
                    type: string
                    format: uuid
                    description: Project ID the release belongs to
                  createdById:
                    type: string
                    nullable: true
                    format: uuid
                    description: ID of the user who created the release
                  commitId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Associated commit ID
                  meta:
                    type: object
                    nullable: true
                    properties:
                      bucket:
                        type: string
                        description: Storage bucket name
                      key:
                        type: string
                        description: Storage object key
                    description: Release storage metadata
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: File unique identifier
                        name:
                          type: string
                          nullable: true
                          description: File name
                        path:
                          type: string
                          description: File path within the release
                        contentType:
                          type: string
                          nullable: true
                          description: MIME type of the file
                        contentHash:
                          type: string
                          nullable: true
                          description: MD5 hash of the file content
                        releaseId:
                          type: string
                          format: uuid
                          description: ID of the release this file belongs to
                        versionId:
                          type: string
                          nullable: true
                          format: uuid
                          description: Document version ID
                        createdAt:
                          type: string
                          nullable: true
                          description: File creation timestamp
                        diffStatus:
                          type: string
                          enum:
                            - added
                            - modified
                            - removed
                            - unchanged
                          description: Diff status when comparing releases
                        previousReleaseId:
                          type: string
                          format: uuid
                          description: Previous release ID for modified files
                        previousId:
                          type: string
                          format: uuid
                          description: Previous file ID for modified files
                      required:
                        - id
                        - path
                        - releaseId
                      description: Release file information
                    description: List of files in the release
                  createdBy:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: User unique identifier
                      email:
                        type: string
                        format: email
                        description: User email address
                      firstName:
                        type: string
                        nullable: true
                        description: User first name
                      lastName:
                        type: string
                        nullable: true
                        description: User last name
                      type:
                        type: string
                        nullable: true
                        description: User type
                      status:
                        type: string
                        nullable: true
                        description: User status
                    required:
                      - id
                      - email
                      - firstName
                      - lastName
                      - type
                      - status
                    description: User who created the release
                  changeRequests:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Change request unique identifier
                        status:
                          type: string
                          description: Change request status
                        environment:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Environment unique identifier
                            name:
                              type: string
                              description: Environment name
                          required:
                            - id
                            - name
                          description: Environment details
                      required:
                        - id
                        - status
                      description: Pending change request for the release
                    description: Pending change requests
                required:
                  - id
                  - createdAt
                  - projectId
                description: Release details with files
      security:
        - personalAccessToken: []
        - internalAuth: []
components:
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      description: Personal access token is obtained through your profile
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````