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

# Recuperar um fluxo

> Recupera informações detalhadas sobre um fluxo específico, incluindo configuração, lógica de execução, condições, destinos e métricas de execução. Retorna os dados completos do fluxo no idioma solicitado.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v1.json get /v1/organizations/{organization_id}/flows/{flow_id}
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/{flow_id}:
    get:
      tags:
        - Fluxos
      summary: Recuperar um fluxo
      description: >-
        Recupera informações detalhadas sobre um fluxo específico, incluindo
        configuração, lógica de execução, condições, destinos e métricas de
        execução. Retorna os dados completos do fluxo no idioma solicitado.
      operationId: getFlowById
      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: flow_id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: O identificador único do fluxo
          example: 507f1f77bcf86cd799439012
        - 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 vários 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 será retornada.
            Valores aceitos: 'en-EN' (inglês), 'es-ES' (espanhol), 'pt-BR'
            (português), 'ca-ES' (catalão), 'eu-ES' (basco). O valor padrão é
            'es-ES' se não for fornecido.
      responses:
        '200':
          description: >-
            Detalhes do fluxo recuperados com sucesso. A resposta inclui a
            configuração completa do fluxo, condições, destinos e métricas de
            execução.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: Requisição incorreta - ID de fluxo inválido
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Não autorizado - é necessária autenticação
        '404':
          $ref: '#/components/responses/NotFound'
          description: Fluxo não encontrado
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    FlowV1:
      type: object
      description: >-
        Detalhe do fluxo como retornado por GET flow por id. A organização é
        implícita pelo caminho
        `/v1/organizations/{organization_id}/flows/{flow_id}`. Os
        workspaces/grupos alvo são normalizados em target.ids (cadenas
        hexadecimais de ObjectId de MongoDB).
      properties:
        id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
        created_at:
          type: string
          format: date-time
        name:
          type: string
          description: Resolvido para Accept-Language quando é multilíngue
        description:
          type: string
          description: Resolvido para Accept-Language quando é multilíngue
        type:
          type: string
          enum:
            - session
            - workspace
        version:
          type: number
        detection_only:
          type: boolean
        cooldown_minutes:
          type: number
          description: Tempo de espera em minutos
        enabled:
          type: boolean
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/FlowConditionV1'
          description: Omitido ou vazio quando o fluxo não tem condições
        trigger:
          type: string
          nullable: true
        target:
          $ref: '#/components/schemas/FlowTargetSelectorV1'
          description: >-
            Destino de execução: type seleciona o escopo; ids lista valores de
            _id de Workspace, _id de grupo de Workspace ou _id de Grupo de
            relatório (vazio quando type é ALL_WORKSPACES)
        microservice_id:
          type: string
          nullable: true
          description: ID do microserviço vinculado quando presente
        init_text:
          type: string
          nullable: true
          description: Resolvido para Accept-Language quando é multilíngue
        ok_text:
          type: string
          nullable: true
          description: Resolvido para Accept-Language quando é multilíngue
        ko_text:
          type: string
          nullable: true
          description: Resolvido para Accept-Language quando é multilíngue
        execution_metrics:
          $ref: '#/components/schemas/FlowExecutionMetricsV1'
          nullable: true
          description: Presente quando métricas foram calculadas para este fluxo
      required:
        - id
        - created_at
        - name
        - description
        - type
        - version
        - detection_only
        - cooldown_minutes
        - enabled
        - target
    FlowConditionV1:
      type: object
      properties:
        condition_type_id:
          type: string
        metric:
          type: string
        operator:
          type: string
        compare_to:
          type: string
        period:
          type: number
          nullable: true
        check_every:
          type: number
      required:
        - condition_type_id
        - metric
        - operator
        - compare_to
        - check_every
    FlowTargetSelectorV1:
      type: object
      properties:
        type:
          type: string
          enum:
            - all_workspaces
            - workspaces
            - workspace_groups
            - reporting_groups
          description: >-
            ALL_WORKSPACES: ids são sempre []. WORKSPACES: ids são _id de
            documentos de Workspace (24 hex). WORKSPACE_GROUPS /
            REPORTING_GROUPS: ids são valores de _id de grupo.
        ids:
          type: array
          items:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
      required:
        - type
        - ids
    FlowExecutionMetricsV1:
      type: object
      properties:
        targeted_workspaces:
          type: number
        evaluations_per_day:
          type: number
        possible_executions_per_day:
          type: number
        total_possible_executions_per_day:
          type: number
      required:
        - targeted_workspaces
        - evaluations_per_day
        - possible_executions_per_day
        - total_possible_executions_per_day
    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

````