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

# List workflows

> List workflows for the organization (from the `X-Organization-ID` header) with optional filtering and pagination. Returns all matching workflows by default; pass `page_size` to paginate.



## OpenAPI

````yaml /api-reference/openapi.json get /workflows
openapi: 3.0.3
info:
  title: ModuleX API
  version: 0.1.2
  description: >-
    ModuleX REST API. Authenticate with a user API key (`Authorization: Bearer
    mx_live_*`, or the `X-API-KEY` header) and supply the organization context
    header `X-Organization-ID` on org-scoped endpoints. Routers carry NO `/v1`
    version segment. Billing-gated surfaces (workflow run, managed knowledge
    search) reject before any write with a flat `DenialEnvelope` (402/403/429).
servers:
  - url: https://api.modulex.dev
    description: Production
security:
  - bearerAuth: []
    orgHeader: []
tags:
  - name: Workflows
    description: Create, read, update and delete workflow definitions.
  - name: Runs
    description: Execute workflows. Subject to the billing admission gate.
  - name: Schedules
    description: Recurring (cron / interval) workflow executions.
  - name: Knowledge
    description: Knowledge bases and semantic search.
  - name: Credentials
    description: Integration credentials (API key, bearer, OAuth2, ModuleX-managed).
  - name: Integrations
    description: Catalog of available tools, LLM providers and knowledge providers.
  - name: Organizations
    description: Organization management.
  - name: API keys
    description: User-owned API keys for programmatic access.
paths:
  /workflows:
    get:
      tags:
        - Workflows
      summary: List workflows
      description: >-
        List workflows for the organization (from the `X-Organization-ID`
        header) with optional filtering and pagination. Returns all matching
        workflows by default; pass `page_size` to paginate.
      operationId: listWorkflows
      parameters:
        - name: status
          in: query
          required: false
          description: Filter by status (e.g. draft, active, archived).
          schema:
            type: string
        - name: category
          in: query
          required: false
          description: Filter by category.
          schema:
            type: string
        - name: visibility
          in: query
          required: false
          description: Filter by visibility level.
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: Search in name and description.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number (1-based). Only used when page_size is set.
          schema:
            type: integer
            minimum: 1
        - name: page_size
          in: query
          required: false
          description: Items per page (max 100). Enables pagination when set.
          schema:
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: A list of workflows.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowList'
        '400':
          $ref: '#/components/responses/MissingOrgHeader'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    WorkflowList:
      type: object
      description: >-
        Workflow list. `page`, `page_size` and `total_pages` are present only
        when pagination is requested.
      required:
        - workflows
        - total
      properties:
        workflows:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              description:
                type: string
                nullable: true
              category:
                type: string
                nullable: true
              status:
                type: string
              visibility:
                type: string
              tags:
                type: array
                items:
                  type: string
              version:
                type: string
                nullable: true
              creator_id:
                type: string
                format: uuid
                nullable: true
              input:
                type: object
                additionalProperties: true
              created_at:
                type: string
                format: date-time
              updated_at:
                type: string
                format: date-time
        total:
          type: integer
        page:
          type: integer
        page_size:
          type: integer
        total_pages:
          type: integer
    Error:
      type: object
      description: Standard FastAPI error response.
      properties:
        detail:
          description: >-
            Human-readable error message, or a structured object (some endpoints
            return `{message, code, ...}`).
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
    ValidationErrorItem:
      type: object
      required:
        - loc
        - msg
        - type
      properties:
        loc:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
        type:
          type: string
  responses:
    MissingOrgHeader:
      description: The `X-Organization-ID` header is required for this endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Authentication required or invalid. Provide `Authorization: Bearer
        <key>` or `X-API-KEY`.
      headers:
        WWW-Authenticate:
          schema:
            type: string
          description: Bearer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Request validation failed (FastAPI 422).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        User API key: `Authorization: Bearer mx_live_*`. The `X-API-KEY:
        mx_live_*` header is also accepted.
    orgHeader:
      type: apiKey
      in: header
      name: X-Organization-ID
      description: Required organization context for org-scoped endpoints.

````