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

# List flows

> Return a cursor-paginated list of the tenant's automation flows, newest first. Optionally filter by lifecycle `status` or a case-insensitive name `search`. Powers the Flows hub list and its Total / Active KPI cards, so the paginated `total` reflects the filtered count (reported as `10000` when the tenant exceeds that ceiling).



## OpenAPI

````yaml /openapi.yaml get /api/v1/flows/
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/flows/:
    get:
      tags:
        - Flows
      summary: List flows
      description: >-
        Return a cursor-paginated list of the tenant's automation flows, newest
        first. Optionally filter by lifecycle `status` or a case-insensitive
        name `search`. Powers the Flows hub list and its Total / Active KPI
        cards, so the paginated `total` reflects the filtered count (reported as
        `10000` when the tenant exceeds that ceiling).
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            Opaque pagination cursor from a previous page's
            `meta.pagination.cursor`.
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Maximum number of flows to return.
        - in: query
          name: sort
          required: false
          schema:
            type: string
            enum:
              - created_at
              - '-created_at'
              - name
              - '-name'
              - status
              - '-status'
          description: >-
            Sort column; prefix with `-` for descending. Defaults to newest
            first.
        - in: query
          name: status
          required: false
          schema:
            type: string
            enum:
              - draft
              - published
              - archived
          description: Restrict to flows in this lifecycle status.
        - in: query
          name: search
          required: false
          schema:
            type: string
            maxLength: 200
          description: Case-insensitive substring match on the flow name.
      responses:
        '200':
          description: A page of flows.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Flow'
                  meta:
                    $ref: '#/components/schemas/PaginationResponseMeta'
components:
  schemas:
    Flow:
      type: object
      description: >-
        A saved automation flow — its builder graph (`definition`), trigger
        configuration, lifecycle status, and current version.
      properties:
        id:
          type: string
          description: Flow identifier (prefixed `flow_`).
        name:
          type: string
        description:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - draft
            - published
            - archived
          description: Lifecycle state. Only `published` flows execute live.
        definition:
          type: object
          description: >-
            The builder graph describing triggers, messaging / agent / delay /
            condition steps and their connections.
          properties:
            nodes:
              type: array
              items:
                type: object
            edges:
              type: array
              items:
                type: object
        trigger_type:
          type: string
          enum:
            - manual
            - webhook
            - schedule
            - event
            - workflow
          description: How the flow is entered.
        trigger_config:
          type: object
          nullable: true
        cron_expr:
          type: string
          nullable: true
          description: 5-field cron expression; present when `trigger_type` is `schedule`.
        cron_tz:
          type: string
          nullable: true
          description: IANA timezone for `cron_expr` (defaults to UTC).
        last_scheduled_run_at:
          type: string
          format: date-time
          nullable: true
        version:
          type: integer
          nullable: true
        published_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationResponseMeta:
      type: object
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        pagination:
          type: object
          required:
            - has_more
          additionalProperties: false
          properties:
            cursor:
              type: string
              nullable: true
            has_more:
              type: boolean
            total:
              type: integer
              nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````