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

# List flows

> Retrieve a paginated list of flows belonging to the specified organization. Supports filtering, sorting, and searching across flow properties. Results are returned in pages with pagination metadata.



## OpenAPI

````yaml /en/api-reference/openapi.en-v1.json get /v1/organizations/{organization_id}/flows
openapi: 3.0.3
info:
  title: Public Portal API
  version: 1.0.0
  description: Public REST API for portal
servers:
  - url: https://api.staging.flxwvdexternal.com
    description: Staging API server.
security:
  - bearerAuth: []
tags: []
paths:
  /v1/organizations/{organization_id}/flows:
    get:
      tags:
        - Flows
      summary: List flows
      description: >-
        Retrieve a paginated list of flows belonging to the specified
        organization. Supports filtering, sorting, and searching across flow
        properties. Results are returned in pages with pagination metadata.
      operationId: listFlows
      parameters:
        - name: organization id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: The unique identifier of the organization
          example: 507f1f77bcf86cd799439011
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: 'Page number (default: 1)'
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Sort field with optional order suffix (:asc or :desc), e.g., "name",
            "name:asc", "cooldown_minutes:desc". Ascending order is default if
            no suffix provided. Valid sort fields: id, name, description, type,
            detection_only, cooldown_minutes, enabled, init_text, ok_text,
            ko_text.
        - name: fields
          in: query
          required: false
          schema:
            type: string
            maxLength: 2048
          description: >-
            Comma-separated list of fields to include in each flow item.
            Selectable fields: id, name, description, type, detection_only,
            cooldown_minutes, enabled. The id field is always included.
          example: name,description,enabled
        - name: filters
          in: query
          required: false
          schema:
            type: string
            maxLength: 5120
            pattern: ^.*$
          description: >-
            Filter flows by one or more criteria. Provide a JSON object with
            filter conditions. You can filter by: id, name, description, type,
            detection_only, cooldown_minutes, enabled, init_text, ok_text,
            ko_text. Use comparison operators (eq, ne, gt, gte, lt, lte, in,
            nin, contains, startsWith, endsWith, between) and combine multiple
            conditions with logical operators (and, or). Maximum length: 5120
            characters.
          examples:
            simple:
              summary: Filter by enabled flows
              description: Returns only enabled flows.
              value: '{"field": "enabled", "op": "eq", "value": true}'
            complex-and:
              summary: Filter by type and detection mode
              description: Returns SESSION flows that are not merely detection.
              value: >-
                {"and": [{"field": "type", "op": "eq", "value": "SESSION"},
                {"field": "detection_only", "op": "eq", "value": false}]}
            complex-or-and:
              summary: Combine OR and AND conditions
              description: Match multiple text fields and require enabled flows.
              value: >-
                {"and": [{"or": [{"field": "name", "op": "contains", "value":
                "backup"}, {"field": "description", "op": "contains", "value":
                "backup"}]}, {"field": "enabled", "op": "eq", "value": true}]}
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 100
            maximum: 100
            minimum: 1
          description: Number of items per page
        - name: Accept-Language
          in: header
          required: false
          schema:
            type: string
            enum:
              - en-EN
              - es-ES
              - pt-BR
              - ca-ES
              - eu-ES
            default: es-ES
          description: >-
            Language code for text fields that support multiple languages. When
            creating or updating resources, this specifies the language of the
            provided text values. Upon retrieving resources, it determines which
            language variant of the multilingual text fields is returned.
            Accepted values: 'en-EN' (English), 'es-ES' (Spanish), 'pt-BR'
            (Portuguese), 'ca-ES' (Catalan), 'eu-ES' (Basque). Default is
            'es-ES' if not provided.
      responses:
        '200':
          description: >-
            Paginated list of flows successfully retrieved. The response
            includes pagination metadata and the flow data array.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowListItemV1ListResponseV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: >-
            Bad Request. Common Causes: - Invalid pagination parameters -
            Invalid sorting parameter - Invalid filter parameters
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Unauthorized - authentication required
        '404':
          $ref: '#/components/responses/NotFound'
          description: Organization not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    FlowListItemV1ListResponseV1:
      type: object
      properties:
        has_next:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/FlowListItemV1'
      required:
        - has_next
        - data
    FlowListItemV1:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        type:
          type: string
          enum:
            - session
            - workspace
        detection_only:
          type: boolean
        cooldown_minutes:
          type: number
          description: Waiting time in minutes
        enabled:
          type: boolean
      required:
        - id
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````