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

# List workflow templates and workspace instances

> Every workflow template with its field schema and the caller workspace instances of it. A workspace may run several instances of one template, one per regulated entity. Omitting `kind` returns the deterministic CADOC 5710/5711 and CARF templates (the pre-existing shape); pass `kind=agent` to poll the templates the Autopilot runtime executes.



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/workflows
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.31
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/workflows:
    get:
      tags:
        - Workflows
      summary: List workflow templates and workspace instances
      description: >-
        Every workflow template with its field schema and the caller workspace
        instances of it. A workspace may run several instances of one template,
        one per regulated entity. Omitting `kind` returns the deterministic
        CADOC 5710/5711 and CARF templates (the pre-existing shape); pass
        `kind=agent` to poll the templates the Autopilot runtime executes.
      operationId: listWorkflows
      parameters:
        - name: kind
          required: false
          in: query
          description: >-
            Filter templates by kind. Omitted defaults to `deterministic` — the
            pre-existing CADOC-only shape. The Autopilot runner polls its
            enabled instances with `kind=agent`.
          schema:
            example: agent
            type: string
            enum:
              - deterministic
              - agent
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkflowsResponseDto'
components:
  schemas:
    ListWorkflowsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowTemplateDto'
      required:
        - items
    WorkflowTemplateDto:
      type: object
      properties:
        template:
          type: string
          example: cadoc-5711
          enum:
            - cadoc-5710
            - cadoc-5711
            - carf-uk-xml
            - treasury-statement
            - transfer-attribution
            - corridor-reconciliation
            - redemption-monitor
            - alert-investigation
            - control-testing-and-sampling
        pretty_name:
          type: string
          example: CADOC 5711 - Daily custody workflow
        kind:
          type: string
          example: deterministic
          enum:
            - deterministic
            - agent
          description: >-
            'deterministic' is Pablo's reporting pipeline; 'agent' is executed
            by the Autopilot runtime (rangesecurity/autopilot).
        default_cadence:
          type: string
          enum:
            - daily
            - monthly
            - manual
            - event
        allowed_formats:
          type: array
          items:
            type: string
        field_schema:
          type: object
          additionalProperties: true
          description: Template-declared fields an instance may set.
        requires_carf:
          type: boolean
          description: True when the template consumes CARF classifications.
        supports_custom_runs:
          type: boolean
          description: >-
            Supports POST /v2/workflows/runs/custom. CARF, treasury-statement
            and transfer-attribution support custom runs.
        instances:
          description: The workspace instances of this template, possibly empty.
          type: array
          items:
            $ref: '#/components/schemas/WorkflowInstanceDto'
      required:
        - template
        - pretty_name
        - kind
        - default_cadence
        - allowed_formats
        - field_schema
        - requires_carf
        - supports_custom_runs
        - instances
    WorkflowInstanceDto:
      type: object
      properties:
        id:
          type: string
          example: 9b2f7c61-2d4e-4a8b-9f10-3c5d7e9a1b2c
        name:
          type: string
          example: CADOC 5711 - Range Brasil Ltda
        recipients:
          type: array
          items:
            type: string
            format: uuid
        enabled:
          type: boolean
          example: true
        cadence:
          type: string
          enum:
            - daily
            - monthly
            - manual
            - event
        formats:
          type: array
          items:
            type: string
        fields:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: boolean
              - type: object
                additionalProperties:
                  type: boolean
          example:
            cnpj: '99999999'
        updated_by:
          type: string
          nullable: true
          example: user_123
          description: >-
            Authenticated user ID or API-key fingerprint for new mutations.
            Historical values are retained unchanged.
        created_at:
          type: string
          example: '2026-08-25T00:00:00.000Z'
        updated_at:
          type: string
          example: '2026-08-25T00:00:00.000Z'
        state:
          type: string
          enum:
            - active
            - paused
            - running
            - failed
            - delivery_failed
          description: >-
            Derived from `enabled` and the most recent run: a disabled instance
            is always `paused`.
        last_run:
          nullable: true
          description: The most recent run, or null if the instance never ran.
          type: object
          allOf:
            - $ref: '#/components/schemas/WorkflowLastRunDto'
        backfill_summary:
          type: string
          nullable: true
          description: >-
            Present on a redemption monitor. One sentence recording how many
            redemptions were already past their deadline when monitoring started
            and were stored without a case.
      required:
        - id
        - name
        - recipients
        - enabled
        - cadence
        - formats
        - fields
        - created_at
        - updated_at
        - state
        - last_run
    WorkflowLastRunDto:
      type: object
      properties:
        id:
          type: string
          example: 1f0c8b3a-5d6e-4f70-8192-a3b4c5d6e7f8
        execution_status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - failed
            - cancelled
            - skipped
        delivery_status:
          type: string
          enum:
            - not_required
            - pending
            - sending
            - sent
            - failed
            - cancelled
        created_at:
          type: string
          example: '2026-09-01T02:59:00.000Z'
      required:
        - id
        - execution_status
        - delivery_status
        - created_at
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.