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

# List Workflows

> List workflow definitions in the caller's organization and environment. Returns metadata only; the workflow state graph is not included.



## OpenAPI

````yaml GET /v1/workflows
openapi: 3.1.0
info:
  title: Beltic Workflow API
  version: 1.0.0
  description: >-
    # Workflow API


    The Beltic Workflow API runs configurable workflows that orchestrate Beltic
    verification services (identity, business, document, screening, website
    check) along with HTTP requests, AI completions, and human-in-the-loop
    steps.


    ## Key Features


    - **Run workflows**: Submit a workflow for execution against the deployed or
    draft state

    - **List workflows**: Discover available workflows in your organization

    - **Inspect executions**: List recent executions across all workflows or for
    a specific workflow, including status, output verdicts, and paused-block
    metadata


    ## Authentication


    Most requests authenticate with a Bearer JWT obtained from your Beltic
    session, but server-to-server callers may also use an API key. The API key
    implies the calling organization and workflow environment.


    **Bearer JWT (default):**

    ```

    Authorization: Bearer YOUR_JWT

    ```


    **API key (server-to-server):**

    ```

    x-api-key: YOUR_API_KEY

    ```


    ## Response Format


    Responses are plain JSON (not JSON:API). Error responses have the shape `{
    "error": string, "code"?: string, "details"?: ... }`.
  contact:
    name: Beltic API Support
    email: engineering@beltic.com
servers:
  - url: https://api.beltic.com
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Workflows
    description: List workflows and retrieve workflow-scoped execution history.
  - name: Executions
    description: Start workflow executions and list execution history across all workflows.
externalDocs:
  description: Beltic Platform Documentation
  url: https://docs.beltic.com
paths:
  /v1/workflows:
    get:
      tags:
        - Workflows
      summary: List workflows
      description: >-
        List workflow definitions in the caller's organization and environment.
        Returns metadata only; the workflow state graph is not included.
      parameters:
        - name: deployed
          in: query
          required: false
          description: >-
            When `true`, return only workflows that have at least one deployed
            version.
          schema:
            type: boolean
      responses:
        '200':
          description: List of workflow metadata records.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowMetadata'
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller lacks the `workflows:read` permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    WorkflowMetadata:
      type: object
      description: Workflow definition metadata, without the workflow state graph.
      required:
        - id
        - organizationId
        - environment
        - name
        - version
        - lastSynced
        - createdAt
        - updatedAt
        - isDeployed
        - deployedAt
      properties:
        id:
          type: string
          description: Workflow ID.
        organizationId:
          type: string
          description: Owning organization ID.
        environment:
          type: string
          enum:
            - staging
            - production
          description: Environment the workflow belongs to.
        name:
          type: string
          description: Human-readable workflow name.
        version:
          type: integer
          description: Current draft version number. Increments on edits.
        lastSynced:
          type: string
          format: date-time
          nullable: true
          description: >-
            Last time the workflow definition was synced. `null` if never
            synced.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        isDeployed:
          type: boolean
          description: Whether the workflow has at least one deployed version.
        deployedAt:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of the most recent deployment. `null` if never deployed.
        lastExecution:
          type: object
          description: Most recent execution summary, when available.
          required:
            - executionId
            - status
            - updatedAt
          properties:
            executionId:
              type: string
            status:
              type: string
            updatedAt:
              type: string
              format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: Machine-readable error code, when available.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Beltic-issued JWT bearer token.
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Workflow API key. The key identifies the calling organization and
        workflow environment.

````