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

# Get a Workflow

> Use this endpoint to retrieve a specific workflow definition by its unique identifier.



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml get /v1/workflows/{id}
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.1.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/workflows/{id}:
    get:
      tags:
        - Workflows API
      summary: Get a Workflow
      description: >-
        Use this endpoint to retrieve a specific workflow definition by its
        unique identifier.
      operationId: getWorkflow
      parameters:
        - description: Unique identifier of the workflow.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutput'
          description: >-
            Indicates that the request was successful and the response contains
            the requested data.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was malformed or contained invalid
            parameters.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indicates that the requested resource could not be found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates an unexpected internal error. If this persists, please
            contact support.
components:
  schemas:
    WorkflowOutput:
      example:
        id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        name: Payment Notification Flow
        description: Receives a webhook trigger and logs the payment event.
        status: active
        nodes:
          - id: trigger-1
            type: trigger
            name: Webhook Trigger
            position:
              x: 0
              'y': 0
            data:
              triggerId: webhook
          - id: log-event
            type: action
            name: Log Payment Event
            position:
              x: 200
              'y': 0
            data:
              action: log
        edges:
          - id: e1
            source: trigger-1
            target: log-event
        metadata:
          team: payments
          environment: sandbox
        createdAt: '2026-03-17T14:30:00Z'
        updatedAt: '2026-03-17T14:31:00Z'
      properties:
        createdAt:
          description: Timestamp when the workflow was created.
          example: '2026-03-17T14:30:00Z'
          format: date-time
          type: string
        description:
          description: Human-readable description of the workflow.
          example: Receives a webhook trigger and logs the payment event.
          type: string
        edges:
          description: Connections between nodes that define the execution flow.
          items:
            $ref: '#/components/schemas/WorkflowEdgeOutput'
          type: array
        id:
          description: Unique identifier of the workflow.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          format: uuid
          type: string
        metadata:
          additionalProperties:
            type: object
          description: Custom key-value pairs for tagging or categorizing.
          example:
            team: payments
            environment: sandbox
          type: object
        name:
          description: Unique name of the workflow.
          example: Payment Notification Flow
          type: string
        nodes:
          description: The steps that make up this workflow.
          items:
            $ref: '#/components/schemas/WorkflowNodeOutput'
          type: array
        status:
          description: >-
            Current lifecycle status: `draft` (editable), `active` (executable),
            or `inactive` (archived).
          enum:
            - draft
            - active
            - inactive
          example: active
          type: string
        updatedAt:
          description: Timestamp of the last update.
          example: '2026-03-17T15:00:00Z'
          format: date-time
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Machine-readable error code with the FLK prefix.
          example: FLK-0001
          type: string
        message:
          description: Human-readable explanation of the error.
          example: Invalid input provided
          type: string
        title:
          description: Short error category title.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    WorkflowEdgeOutput:
      properties:
        condition:
          description: Condition expression for conditional edges.
          example: steps.kyc_check.status == 'approved'
          type: string
        id:
          description: Unique identifier of the edge.
          example: e1
          type: string
        label:
          description: Human-readable label.
          example: On success
          type: string
        source:
          description: ID of the source node.
          example: trigger-1
          type: string
        sourceHandle:
          description: Handle on the source node.
          example: output-1
          type: string
        target:
          description: ID of the target node.
          example: log-event
          type: string
      type: object
    WorkflowNodeOutput:
      properties:
        data:
          additionalProperties:
            type: object
          description: Configuration data specific to the node type.
          example:
            triggerId: webhook
          type: object
        id:
          description: Unique identifier of the node within the workflow.
          example: trigger-1
          type: string
        name:
          description: Display name of the node.
          example: Webhook Trigger
          type: string
        position:
          $ref: '#/components/schemas/PositionOutput'
        type:
          description: Type of the node.
          example: trigger
          type: string
      type: object
    PositionOutput:
      properties:
        x:
          description: Horizontal position in pixels.
          example: 100
          type: integer
        'y':
          description: Vertical position in pixels.
          example: 200
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````