> ## 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 deployment workflow run

> Retrieve a single deployment workflow run by ID, including all associated jobs.



## OpenAPI

````yaml /openapi/brms.json get /api/projects/{projectId}/runs/{runId}
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}/runs/{runId}:
    get:
      tags:
        - Deployment workflows
      summary: Get deployment workflow run
      description: >-
        Retrieve a single deployment workflow run by ID, including all
        associated jobs.
      operationId: getDeploymentWorkflowRun
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project unique identifier
        - schema:
            type: string
            format: uuid
          in: path
          name: runId
          required: true
          description: Deployment workflow run unique identifier
      responses:
        '200':
          description: Deployment workflow run with jobs
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Workflow run unique identifier
                  name:
                    type: string
                    nullable: true
                    description: Workflow run name
                  status:
                    type: string
                    enum:
                      - in_progress
                      - completed
                      - cancelled
                      - waiting
                      - failure
                    description: Current status of the workflow run
                  runVersion:
                    type: string
                    nullable: true
                    enum:
                      - v2
                      - null
                    description: Workflow run version
                  releaseId:
                    type: string
                    format: uuid
                    description: Associated release ID
                  release:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Release unique identifier
                      name:
                        type: string
                        nullable: true
                        description: Release name
                      version:
                        type: string
                        nullable: true
                        description: Release version
                    required:
                      - id
                      - name
                      - version
                    description: Associated release
                  projectId:
                    type: string
                    format: uuid
                    description: Project ID
                  createdById:
                    type: string
                    format: uuid
                    description: ID of user who created the run
                  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
                    required:
                      - id
                      - email
                      - firstName
                      - lastName
                    description: User who created the run
                  createdAt:
                    type: string
                    description: Timestamp when the run was created
                  completedAt:
                    type: string
                    nullable: true
                    description: Timestamp when the run was completed
                  cancelledById:
                    type: string
                    nullable: true
                    format: uuid
                    description: ID of user who cancelled the run
                  cancelledBy:
                    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
                    required:
                      - id
                      - email
                      - firstName
                      - lastName
                    description: User who cancelled the run
                  cancelledComment:
                    type: string
                    nullable: true
                    description: Cancellation reason
                  jobs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Job unique identifier
                        status:
                          type: string
                          enum:
                            - not_started
                            - in_progress
                            - waiting
                            - failure
                            - rejected
                            - completed
                          description: Current status of the job
                        order:
                          type: number
                          description: Order of the job in the workflow
                        environmentId:
                          type: string
                          nullable: true
                          format: uuid
                          description: Associated environment ID
                        environment:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Environment unique identifier
                            name:
                              type: string
                              description: Environment name
                            key:
                              type: string
                              nullable: true
                              description: Environment key
                          required:
                            - id
                            - name
                            - key
                          description: Associated environment
                        projectId:
                          type: string
                          format: uuid
                          description: Project ID
                        deploymentWorkflowRunId:
                          type: string
                          format: uuid
                          description: Parent workflow run ID
                        reviewedAt:
                          type: string
                          nullable: true
                          description: Timestamp when the job was reviewed
                        reviewedBy:
                          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
                          required:
                            - id
                            - email
                            - firstName
                            - lastName
                          description: User who reviewed the job
                        reviewedComment:
                          type: string
                          nullable: true
                          description: Review comment
                        reviewedConclusion:
                          type: string
                          nullable: true
                          enum:
                            - approved
                            - rejected
                            - null
                          description: Review conclusion (approved or rejected)
                        previousRelease:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Release unique identifier
                            name:
                              type: string
                              nullable: true
                              description: Release name
                            version:
                              type: string
                              nullable: true
                              description: Release version
                          required:
                            - id
                            - name
                            - version
                          description: Previous release before deployment
                        previousReleaseId:
                          type: string
                          nullable: true
                          format: uuid
                          description: Previous release ID
                        event:
                          type: string
                          nullable: true
                          description: Event type
                        data:
                          nullable: true
                          description: Additional job data
                        createdAt:
                          type: string
                          description: Timestamp when the job was created
                      required:
                        - id
                        - status
                        - order
                        - environmentId
                        - projectId
                        - deploymentWorkflowRunId
                        - createdAt
                    description: List of jobs in the workflow run
                required:
                  - id
                  - name
                  - status
                  - releaseId
                  - projectId
                  - createdById
                  - createdAt
                  - jobs
                description: Deployment workflow run with jobs
      deprecated: true
      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

````