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

# Get approval workflow

> Retrieve a single approval workflow.



## OpenAPI

````yaml get /v1/approvals/workflows/{id}
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/approvals/workflows/{id}:
    get:
      tags:
        - Approval workflows
      summary: Get approval workflow
      description: Retrieve a single approval workflow.
      operationId: getApprovalWorkflow
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalWorkflow'
        '404':
          description: Approval workflow not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    ApprovalWorkflow:
      type: object
      properties:
        id:
          type: string
          description: Approval workflow ID.
          example: apw_DKL4Xcb5VSa8CQ
        name:
          type: string
          description: Approval workflow name.
          example: Enterprise quote approval
        description:
          type:
            - string
            - 'null'
          description: Approval workflow description.
          example: Requires approval for high-value subscription quotes.
        applicable_flows:
          type: array
          items:
            type: string
            enum:
              - quote_subscription
              - quote_subscription_update
              - quote_one_off
              - subscription_update
          description: Quote or subscription flows where the workflow applies.
          example:
            - quote_subscription
        is_active:
          type: boolean
          description: Whether the workflow is active.
          example: true
        priority:
          type: integer
          description: >-
            Workflow priority. Lower values are evaluated first when multiple
            workflows match.
          example: 10
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ApprovalWorkflowRule'
          description: Rules that determine when the workflow applies.
        step_execution:
          type: string
          enum:
            - sequential
            - parallel
          description: >-
            How workflow steps execute. Sequential steps run by order; parallel
            steps run together.
          example: sequential
        email_notification_enabled:
          type: boolean
          description: Whether approvers receive email notifications for this workflow.
          example: true
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ApprovalWorkflowStep'
          description: Approval steps required by the workflow.
        version:
          type: integer
          description: Workflow version number.
          example: 1
        original_workflow_id:
          type:
            - string
            - 'null'
          description: Original workflow ID when this workflow is an archived version.
          example: null
        created_at:
          type: string
          format: date-time
          description: >-
            Approval workflow creation date. UTC date time string in the [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601) format.
          example: '2024-12-20T16:04:11Z'
      required:
        - id
        - name
        - description
        - applicable_flows
        - is_active
        - priority
        - rules
        - step_execution
        - email_notification_enabled
        - steps
        - version
        - original_workflow_id
        - created_at
    ApprovalWorkflowRule:
      type: object
      properties:
        id:
          type: string
          description: Approval workflow rule ID.
          example: apr_DKL4Xcb5VSa8CQ
        operator:
          type: string
          enum:
            - and
            - or
          description: Logical operator used to combine the rule conditions.
          example: and
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/ApprovalCondition'
          description: Conditions that must match for the rule to apply.
      required:
        - id
        - operator
        - conditions
    ApprovalWorkflowStep:
      type: object
      properties:
        id:
          type: string
          description: Approval workflow step ID.
          example: aps_DKL4Xcb5VSa8CQ
        name:
          type: string
          description: Approval workflow step name.
          example: Finance approval
        order:
          type: integer
          description: Step order. Orders must be sequential starting from 1.
          example: 1
        approver_requirement:
          type: string
          enum:
            - any
            - all
          description: Whether any approver or all approvers must approve the step.
          example: any
        approver_role_ids:
          type: array
          items:
            type: string
          description: User role IDs that can approve the step.
          example:
            - rol_DKL4Xcb5VSa8CQ
        approver_user_ids:
          type: array
          items:
            type: string
          description: User IDs that can approve the step.
          example:
            - usr_DKL4Xcb5VSa8CQ
      required:
        - id
        - name
        - order
        - approver_requirement
        - approver_role_ids
        - approver_user_ids
    ApprovalCondition:
      type: object
      properties:
        field:
          type: string
          description: Field evaluated by the approval condition.
          example: total_amount
        operator:
          type: string
          enum:
            - eq
            - neq
            - gt
            - gte
            - lt
            - lte
            - in
            - not_in
            - contains
            - not_contains
          description: Comparison operator used by the approval condition.
          example: gte
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                type: string
            - type: array
              items:
                type: number
            - type: object
              properties:
                period:
                  type: string
                  enum:
                    - weeks
                    - months
                    - years
                  description: Product interval period.
                  example: months
                count:
                  type: integer
                  exclusiveMinimum: 0
                  description: Number of periods in the product interval.
                  example: 12
              required:
                - period
                - count
            - type: object
              properties:
                period:
                  type: string
                  enum:
                    - once
                  description: Product interval period.
                  example: once
                count:
                  type: 'null'
                  description: Number of periods in the product interval.
                  example: null
              required:
                - period
                - count
            - type: 'null'
          description: Expected value for the approval condition.
          example: 100000
      required:
        - field
        - operator
        - value
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````