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

# Get workflow

> Retrieves the full workflow definition including nodes, edges, and configuration



## OpenAPI

````yaml workflow-api/workflow-api.yaml get /workflows/{workflow_id}
openapi: 3.0.0
info:
  title: Workflow API
  version: 1.0.0
  description: API for managing workflows and their metadata
servers:
  - url: https://api.cloudcruise.com
    description: CloudCruise Platform Production API Server
security:
  - AuthScheme: []
paths:
  /workflows/{workflow_id}:
    get:
      summary: Get workflow
      description: >-
        Retrieves the full workflow definition including nodes, edges, and
        configuration
      operationId: getWorkflow
      parameters:
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the workflow
        - name: cc-key
          in: header
          required: false
          schema:
            type: string
          description: CloudCruise API key for authentication
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowFull'
        '401':
          description: Unauthorized - Invalid or missing authentication
        '404':
          description: Workflow not found
        '500':
          description: Internal server error
components:
  schemas:
    WorkflowFull:
      type: object
      description: Full workflow definition including nodes and edges
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the workflow
        name:
          type: string
          description: Name of the workflow
        description:
          type: string
          nullable: true
          description: Description of the workflow
        created_at:
          type: string
          format: date-time
          description: Timestamp when the workflow was created
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the workflow was last updated
        workspace_id:
          type: string
          format: uuid
          description: ID of the workspace this workflow belongs to
        created_by:
          type: string
          format: uuid
          description: ID of the user who created the workflow
        version_number:
          type: integer
          description: Current version number of the workflow
        version_id:
          type: string
          format: uuid
          description: ID of the current workflow version
        nodes:
          type: array
          description: Array of workflow step nodes
          items:
            type: object
        edges:
          type: object
          description: Map of edges connecting workflow nodes
          additionalProperties:
            type: object
        input_schema:
          type: object
          nullable: true
          description: JSON schema defining the workflow's input variables
        vault_schema:
          type: object
          nullable: true
          description: Schema defining vault credentials and their configuration
        enable_popup_handling:
          type: boolean
          description: Whether popup handling is enabled for this workflow
        enable_xpath_recovery:
          type: boolean
          description: Whether XPath recovery is enabled for this workflow
        enable_node_description_enrichment:
          type: boolean
          description: >-
            Whether node descriptions are auto-enriched for reliability
            improvements
        enable_error_code_generation:
          type: boolean
          description: Whether error code generation is enabled for this workflow
        enable_service_unavailable_recovery:
          type: boolean
          description: Whether service unavailable recovery is enabled for this workflow
        enable_incorrect_form_input_recovery:
          type: boolean
          description: Whether incorrect form input recovery is enabled
        enable_password_update_recovery:
          type: boolean
          description: >-
            Whether password update recovery is enabled. When a site forces a
            password change, the Maintenance Agent classifies the error and
            sends a notification.
        enable_tfa_setup_recovery:
          type: boolean
          description: >-
            Whether automatic TFA setup recovery is enabled. When a site
            requires two-factor authentication setup during login, the
            Maintenance Agent can autonomously complete the enrollment and
            update the vault credential.
        enable_action_timing_recovery:
          type: boolean
          description: Whether action timing recovery is enabled
        origin_catalog_workflow_id:
          type: string
          format: uuid
          nullable: true
          description: ID of the catalog workflow this was forked from (if applicable)
        origin_catalog_version_number:
          type: integer
          nullable: true
          description: Version number of the catalog workflow this was forked from
        origin_catalog_workflow_version_id:
          type: string
          format: uuid
          nullable: true
          description: Specific origin catalog workflow version ID used as the base
        origin_base_version_number:
          type: integer
          nullable: true
          description: Base version number used when deriving from a catalog workflow
        track_updates_from_catalog:
          type: boolean
          description: Whether to track updates from the origin catalog workflow
        enable_network_listener:
          type: boolean
          description: >-
            Whether network listener capture is enabled for this workflow
            version
        skip_udp_proxying:
          type: boolean
          description: Whether UDP proxying is skipped for this workflow version
      required:
        - id
        - name
        - created_at
        - updated_at
        - workspace_id
        - created_by
        - nodes
        - edges
  securitySchemes:
    AuthScheme:
      type: apiKey
      name: cc-key
      in: header
      description: >-
        API key-based authentication. Provide your CloudCruise API key in the
        cc-key header.

````