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

# Get Workflow

> Return a single workflow with its triggers, actions, folder, and configuration.



## OpenAPI

````yaml GET /workflow/{workflow_id}/
openapi: 3.1.0
info:
  title: Outbox AI API
  description: API for managing AI agents (chatbots and voicebots) on the Outbox platform
  version: 1.0.0
servers:
  - url: https://api.getoutbox.ai
security: []
paths:
  /workflow/{workflow_id}/:
    get:
      tags:
        - workflow
      summary: Get Workflow
      description: >-
        Return a single workflow with its triggers, actions, folder, and
        configuration.
      operationId: workflow_retrieve_2
      parameters:
        - in: path
          name: workflow_id
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
          description: ''
        '404':
          description: Workflow not found.
      security:
        - jwtAuth: []
components:
  schemas:
    Workflow:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
        active:
          type: boolean
        timezone:
          type: string
          description: Timezone for workflow scheduling (e.g., America/New_York)
          maxLength: 64
        phone_number:
          type: string
          description: Default phone number ID (UUID) for workflow actions
          maxLength: 36
        email:
          type: string
          format: email
          description: Default email for workflow actions
          maxLength: 256
        allowed_windows:
          nullable: true
        allow_reentry:
          type: boolean
        stop_on_response:
          type: boolean
        is_deleted:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        trigger:
          allOf:
            - $ref: '#/components/schemas/WorkflowTrigger'
          nullable: true
        triggers:
          type: string
          readOnly: true
        actions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowAction'
        enrollment_count:
          type: string
          readOnly: true
        total_enrollment_count:
          type: string
          readOnly: true
        folder_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        jarvis_conversation_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
      required:
        - created_at
        - enrollment_count
        - folder_id
        - id
        - jarvis_conversation_id
        - name
        - total_enrollment_count
        - triggers
        - updated_at
    WorkflowTrigger:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        trigger_type:
          $ref: '#/components/schemas/TriggerTypeEnum'
        filters: {}
        config:
          description: Trigger-specific configuration
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        workflow:
          type: string
          format: uuid
          readOnly: true
          nullable: true
      required:
        - created_at
        - id
        - trigger_type
        - updated_at
        - workflow
    WorkflowAction:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        parent_action_id:
          type: string
          format: uuid
          readOnly: true
        waiting_count:
          type: string
          readOnly: true
        module_info:
          type: string
          readOnly: true
        tools_info:
          type: string
          readOnly: true
        action_type:
          $ref: '#/components/schemas/ActionTypeEnum'
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: Order of execution
        branch_index:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          description: >-
            Which branch this action belongs to (0=first branch, 1=second, etc.,
            null=else branch)
        node_type:
          allOf:
            - $ref: '#/components/schemas/NodeTypeEnum'
          description: |-
            Type of node: action, condition (if_else), or branch

            * `action` - Action
            * `condition` - Condition
            * `branch` - Branch
        config: {}
        is_deleted:
          type: boolean
          description: Soft delete flag - keeps action for historical reference
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        workflow:
          type: string
          format: uuid
          readOnly: true
        parent_action:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: Parent action (for branching - points to if_else condition)
      required:
        - action_type
        - created_at
        - id
        - module_info
        - parent_action
        - parent_action_id
        - tools_info
        - updated_at
        - waiting_count
        - workflow
    TriggerTypeEnum:
      enum:
        - ai_call_completed
        - meta_form_submitted
        - inbound_webhook
      type: string
      description: |-
        * `ai_call_completed` - AI Call Completed
        * `meta_form_submitted` - Meta Form Submitted
        * `inbound_webhook` - Inbound Webhook
    ActionTypeEnum:
      enum:
        - send_ai_call
        - wait
        - if_else
        - send_sms
        - send_email
        - jarvis_agent
        - create_opportunity
        - update_opportunity
        - update_contact
        - assign_chat_agent
        - interrupt_chat_agent
        - run_module
        - webhook
        - drip
        - add_tag
        - remove_tag
        - add_to_workflow
        - remove_from_workflow
      type: string
      description: |-
        * `send_ai_call` - Send AI Call
        * `wait` - Wait
        * `if_else` - If/Else Block
        * `send_sms` - Send SMS
        * `send_email` - Send Email
        * `jarvis_agent` - Jarvis AI Agent
        * `create_opportunity` - Create Opportunity
        * `update_opportunity` - Update Opportunity
        * `update_contact` - Update Contact
        * `assign_chat_agent` - Assign Chat Agent
        * `interrupt_chat_agent` - Interrupt Chat Agent
        * `run_module` - Run Module Tool
        * `webhook` - Webhook
        * `drip` - Drip
        * `add_tag` - Add Tag
        * `remove_tag` - Remove Tag
        * `add_to_workflow` - Add to Workflow
        * `remove_from_workflow` - Remove from Workflow(s)
    NodeTypeEnum:
      enum:
        - action
        - condition
        - branch
      type: string
      description: |-
        * `action` - Action
        * `condition` - Condition
        * `branch` - Branch
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````