> ## Documentation Index
> Fetch the complete documentation index at: https://developer.omni.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Detalhar flow

> Busque um flow e suas pendências de validação

## Conceituação

Retorna um flow específico, incluindo o `flow_json` completo e o array `validation_errors` com o que a Meta apontou.

Com `sync=true`, o estado é buscado direto na Meta antes de responder — mais lento, mas atualizado.

<Note>
  O `flowId` é obtido no retorno de [Criar flow](/flows/create-flow) ou [Listar flows](/flows/list-flows).
</Note>


## OpenAPI

````yaml pt/flows/openapi.json GET /whatsapp/businesses/{wabaId}/flows/{flowId}
openapi: 3.1.0
info:
  title: Omni Z-API - Flows do WhatsApp
  description: >-
    API para criar e gerenciar WhatsApp Flows (formulários nativos dentro da
    conversa)
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /whatsapp/businesses/{wabaId}/flows/{flowId}:
    get:
      tags:
        - Flows
      summary: Detalhar flow
      description: >-
        Retorna um flow específico, incluindo o `flow_json` e as pendências de
        validação da Meta.
      operationId: getFlow
      parameters:
        - name: wabaId
          in: path
          required: true
          description: ID do WABA (obtido via Listar WABAs)
          schema:
            type: string
            example: '428083093730937'
        - name: flowId
          in: path
          required: true
          description: ID do flow (obtido via Listar flows)
          schema:
            type: string
            example: '1122334455667788'
        - name: sync
          in: query
          required: false
          description: >-
            Quando `true`, busca o estado do flow direto na Meta antes de
            responder
          schema:
            type: boolean
            example: true
      responses:
        '200':
          description: Operação realizada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Flow'
              example:
                id: '1122334455667788'
                name: agendamento_consulta
                categories:
                  - APPOINTMENT_BOOKING
                status: PUBLISHED
                endpoint_uri: null
                validation_errors: []
                flow_json: >-
                  {"version": "7.0", "routing_model": {"WELCOME": ["DONE"],
                  "DONE": []}, "screens": [{"id": "WELCOME", "title":
                  "Agendamento", "layout": {"type": "SingleColumnLayout",
                  "children": [{"type": "TextHeading", "text": "Escolha um
                  horario"}, {"type": "Form", "name": "form", "children":
                  [{"type": "TextInput", "name": "nome", "label": "Seu nome",
                  "input-type": "text", "required": true}, {"type":
                  "DatePicker", "name": "data", "label": "Data"}, {"type":
                  "Footer", "label": "Continuar", "on-click-action": {"name":
                  "navigate", "next": {"type": "screen", "name": "DONE"},
                  "payload": {}}}]}]}}, {"id": "DONE", "title": "Pronto",
                  "terminal": true, "success": true, "layout": {"type":
                  "SingleColumnLayout", "children": [{"type": "TextBody",
                  "text": "Agendamento confirmado."}, {"type": "Footer",
                  "label": "Fechar", "on-click-action": {"name": "complete",
                  "payload": {}}}]}}]}
        '401':
          description: Token inválido ou ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Flow não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Flow:
      type: object
      properties:
        id:
          type: string
          description: ID do flow
        name:
          type: string
          description: Nome do flow
        categories:
          type: array
          description: Categorias do flow (a Meta usa na revisão)
          items:
            type: string
            enum:
              - SIGN_UP
              - SIGN_IN
              - APPOINTMENT_BOOKING
              - LEAD_GENERATION
              - CONTACT_US
              - CUSTOMER_SUPPORT
              - SURVEY
              - OTHER
        status:
          type: string
          enum:
            - DRAFT
            - PUBLISHED
            - DEPRECATED
            - BLOCKED
            - THROTTLED
          description: Status de publicação
        endpoint_uri:
          type: string
          nullable: true
          description: >-
            URL do seu endpoint, obrigatória apenas para flows com
            `data_exchange`
        flow_json:
          type: string
          description: Definição das telas em JSON, enviada como **string**
        validation_errors:
          type: array
          description: Pendências de validação devolvidas pela Meta
          items:
            type: object
            properties:
              key:
                type: string
                description: Chave da pendência
              value:
                type: string
                description: Detalhe da pendência
    Error:
      type: object
      properties:
        error:
          type: integer
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````