> ## 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.

# Listar fluxos

> Recupera uma lista paginada de fluxos pertencentes à organização especificada. Suporta filtração, ordenação e pesquisa nas propriedades dos fluxos. Os resultados são devolvidos em páginas com metadados de paginação.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v1.json get /v1/organizations/{organization_id}/flows
openapi: 3.0.3
info:
  title: API Publica Portal
  version: 1.0.0
  description: API pública REST para portal
servers:
  - url: https://api.flexxible.net
    description: Portal API (production)
security:
  - bearerAuth: []
tags: []
paths:
  /v1/organizations/{organization_id}/flows:
    get:
      tags:
        - Fluxos
      summary: Listar fluxos
      description: >-
        Recupera uma lista paginada de fluxos pertencentes à organização
        especificada. Suporta filtração, ordenação e pesquisa nas propriedades
        dos fluxos. Os resultados são devolvidos em páginas com metadados de
        paginação.
      operationId: listFlows
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: O identificador único da organização
          example: 507f1f77bcf86cd799439011
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: 'Número da página (padrão: 1)'
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Campo de ordenação com sufixo de ordem opcional (:asc ou :desc), por
            exemplo, "name", "name:asc", "cooldown_minutes:desc". Usa ordem
            ascendente por padrão se não fornecido sufixo. Campos de ordenação
            válidos: 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: >-
            Lista separada por vírgulas de campos a serem incluídos em cada
            elemento de fluxo. Campos selecionáveis: id, name, description,
            type, detection_only, cooldown_minutes, enabled. O campo id sempre é
            incluído.
          example: name,description,enabled
        - name: filters
          in: query
          required: false
          schema:
            type: string
            maxLength: 5120
            pattern: ^.*$
          description: >-
            Filtra fluxos por um ou mais critérios. Fornece um objeto JSON com
            condições de filtro. Você pode filtrar por: id, name, description,
            type, detection_only, cooldown_minutes, enabled, init_text, ok_text,
            ko_text. Usa operadores de comparação (eq, ne, gt, gte, lt, lte, in,
            nin, contains, startsWith, endsWith, between) e combina múltiplas
            condições com operadores lógicos (and, or). Tamanho máximo: 5120
            caracteres.
          examples:
            simple:
              summary: Filtrar por fluxos habilitados
              description: Retorna apenas fluxos habilitados.
              value: '{"field": "enabled", "op": "eq", "value": true}'
            complex-and:
              summary: Filtrar por tipo e modo de detecção
              description: Retorna fluxos SESSION que não são apenas de detecção.
              value: >-
                {"and": [{"field": "type", "op": "eq", "value": "SESSION"},
                {"field": "detection_only", "op": "eq", "value": false}]}
            complex-or-and:
              summary: Combinar condições OU e E
              description: >-
                Coincidir com múltiplos campos de texto e requer fluxos
                habilitados.
              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: Número de itens por página
        - 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: >-
            Código de idioma para campos de texto que suportam múltiplos
            idiomas. Ao criar ou atualizar recursos, isso especifica o idioma
            dos valores de texto fornecidos. Ao recuperar recursos, isso
            determina qual variante de idioma dos campos de texto multilíngues é
            devolvida. Valores aceitos: 'en-EN' (inglês), 'es-ES' (espanhol),
            'pt-BR' (português), 'ca-ES' (catalão), 'eu-ES' (euskera). Usa
            'es-ES' por padrão se não fornecido.
      responses:
        '200':
          description: >-
            Lista paginada de fluxos recuperada corretamente. A resposta inclui
            metadados de paginação e o conjunto de dados de fluxos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowListItemV1ListResponseV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: >-
            Solicitação incorreta. Causas comuns: - Parâmetros de paginação
            inválidos - Parâmetro de ordenação inválido - Parâmetros de filtro
            inválidos
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Não autorizado - é necessária autenticação
        '404':
          $ref: '#/components/responses/NotFound'
          description: Organização não encontrada
        '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: Tempo de espera em minutos
        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: Solicitação incorreta
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Solicitações em excesso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````