---
title: "Obter um funil de projeto"
method: POST
path: "/api/management/get-project-funnels"
tags: ["project-funnels", "get-project-funnels"]
---

# Obter um funil de projeto

`POST /api/management/get-project-funnels`

Retorna os dados completos de um funil de projeto específico, incluindo todas as suas etapas, configurações de visualização, restrições de fluxo e recursos disponíveis.

**Objetos retornados:**

- **project_funnel**: Dados do funil incluindo:
    
    - **steps**: Etapas sequenciais do funil com suas restrições de movimentação, assistentes de IA, checklists e formulário
        
    - **restrictions**: Regras que controlam a movimentação de itens entre etapas (incoming/outgoing)
        
    - **assistants**: Assistentes de IA configurados para executar ações automatizadas em etapas específicas
        
    - **business_area**: Área de negócio à qual o funil pertence
        
    - **tags**: Etiquetas disponíveis para categorizar itens no funil
        
    - **funnel_status**: Status disponíveis para itens (ex: Urgente) com seus bloqueios de etapa
        
    - **form**: Formulário principal associado ao funil

## Request body

- object
  - `project_funnel_id` integer, required — ID do funil de projeto

## Response `200`

Sucesso

- object
  - `response` boolean — Indica se a requisição foi bem-sucedida
  - `project_funnel` object — Dados completos do funil de projeto incluindo etapas, restrições, tags e configurações do funil de projeto
    - `id` integer — Identificador único do funil de projeto
    - `name` string — Nome do funil de projeto
    - `prefix` string — Prefixo usado na criação de projetos para que o prefixo do código do projeto seja criado com esse prefixo
    - `order` integer — Ordem de exibição do funil em relação a outros funis
    - `condition` 'active' | 'inactive' — Condição atual do funil (ativo ou inativo)
    - `business_area_id` integer — ID da área de negócio à qual o funil pertence
    - `form_id` integer — ID do formulário associado ao funil (opcional)
    - `frame_id` string, uuid — UUID do frame/contexto no qual o funil está inserido
    - `created_at` string, date-time — Data e hora de criação do funil
    - `updated_at` string, date-time — Data e hora da última atualização do funil
    - `deleted_at` string, date-time — Data e hora de exclusão (soft delete), null se não excluído
    - `funnel_config_template_id` integer — ID do template de configuração (visualização do usuário)
    - `access` unknown[] — Lista de controles de acesso/permissões para o funil
      - unknown
    - `steps` object[] — Etapas do funil em ordem sequencial
      - `id` integer — ID único da etapa
      - `name` string — Nome da etapa do funil
      - `project_funnel_id` integer — ID do funil ao qual a etapa pertence
      - `sensation_amount` integer — Valor de sensação/peso associado à etapa
      - `step_forward_id` integer — ID da etapa seguinte padrão (opcional)
      - `step_backward_id` integer — ID da etapa anterior padrão (opcional)
      - `order` integer — Ordem sequencial da etapa no funil
      - `help_text` string — Texto de ajuda/orientação para a etapa
      - `form_id` integer — ID do formulário associado à etapa (opcional)
      - `sort_config` object — Configuração de ordenação dos itens dentro da etapa
        - `field` string — Campo usado para ordenação
        - `arguments` unknown[] — Argumentos adicionais para a ordenação
          - unknown
        - `direction` 'asc' | 'desc' — Direção da ordenação (ascendente ou descendente)
      - `created_at` string, date-time — Data e hora de criação da etapa
      - `updated_at` string, date-time — Data e hora da última atualização da etapa
      - `checklists` unknown[] — Lista de checklists associados à etapa
        - unknown
      - `restrictions` object[] — Restrições de movimentação de/para esta etapa
        - `id` integer — Identificador único da restrição
        - `name` string — Nome descritivo da restrição (opcional)
        - `step_id` integer — ID da etapa à qual a restrição pertence
        - `direction` 'incoming' | 'outgoing' — Direção da restrição (entrada ou saída da etapa)
        - `restriction_type` 'step' | 'filter' | 'tag' | 'status' — Tipo de restrição aplicada
        - `target_step_id` integer — ID da etapa alvo (quando restriction_type é 'step')
        - `target_tag_id` integer — ID da tag alvo (quando restriction_type é 'tag')
        - `target_status_id` integer — ID do status alvo (quando restriction_type é 'status')
        - `target_saved_filter_id` string, uuid — UUID do filtro salvo (quando restriction_type é 'filter')
        - `hierarchy_scope` 'current' | 'parent' | 'child' | 'all' — Escopo hierárquico da restrição
        - `hierarchy_depth` integer — Profundidade hierárquica da restrição (opcional)
        - `created_at` string, date-time — Data e hora de criação da restrição
        - `updated_at` string, date-time — Data e hora da última atualização da restrição
      - `attachments` unknown[] — Anexos associados à etapa
        - unknown
      - `assistants` object[] — Assistentes de IA configurados para esta etapa
        - `id` string, uuid — UUID do assistente
        - `name` string — Nome do assistente de IA
        - `active` boolean — Indica se o assistente está ativo
        - `funnel_step_id` integer — ID da etapa à qual o assistente pertence
        - `ai_agent_id` string, uuid — UUID do agente de IA usado pelo assistente
        - `prompt` string — Template do prompt enviado ao agente de IA
        - `execute_on` 'manual' | 'automatic' | 'scheduled' — Momento de execução do assistente
        - `manual_execution_enabled` boolean — Permite execução manual pelo usuário
        - `result_as_media` boolean — Salva o resultado como mídia/anexo
        - `result_as_dynamic_form` object — Configuração para transformar resultado em formulário dinâmico
          - `edge_id` integer — ID da aresta/conexão do formulário
          - `form_id` integer — ID do formulário dinâmico
          - `project_id` string — Template para ID do projeto (usa variáveis)
          - `pivot_class` string — Classe do modelo pivot para relacionamento
          - `project_funnel_id` integer — ID do funil do projeto
        - `failure_funnel_step_id` integer — ID da etapa para onde mover em caso de falha (opcional)
        - `created_at` string, date-time — Data e hora de criação do assistente
        - `updated_at` string, date-time — Data e hora da última atualização do assistente
        - `deleted_at` string, date-time — Data e hora de exclusão (soft delete)
    - `business_area` object — Área de negócio à qual o funil pertence
      - `id` integer — Identificador único da área de negócio
      - `name` string — Nome da área de negócio
      - `order` integer — Ordem de exibição da área de negócio
      - `frame_id` string, uuid — UUID do frame/contexto da área
      - `deleted_at` string, date-time — Data e hora de exclusão (soft delete)
    - `attachments` unknown[] — Anexos associados ao funil
      - unknown
    - `form` object — Formulário principal associado ao funil
      - `id` integer — Identificador único do formulário
      - `title` string — Título do formulário
    - `template_projects` unknown[] — Projetos template associados ao funil
      - unknown
    - `tags` object[] — Etiquetas/tags disponíveis para categorizar itens no funil
      - `id` integer — Identificador único da tag
      - `name` string — Nome da tag
      - `color` string — Cor da tag em formato hexadecimal
      - `project_funnel_id` integer — ID do funil ao qual a tag pertence
      - `deleted_at` string, date-time — Data e hora de exclusão (soft delete)
      - `funnel_step_blockings` unknown[] — Bloqueios de etapas associados a esta tag
        - unknown
    - `funnel_status` object[] — Status de funil disponíveis para projetos no funil
      - `id` integer — ID único do status
      - `name` string — Nome do status
      - `color` string — Cor do status em formato hexadecimal
      - `project_funnel_id` integer — ID do funil ao qual o status pertence
      - `is_conclusive` boolean — Indica se este status marca o item como concluído no prazo
      - `created_at` string, date-time — Data e hora de criação do status
      - `updated_at` string, date-time — Data e hora da última atualização do status
      - `deleted_at` string, date-time — Data e hora de exclusão (soft delete)
      - `funnel_step_blockings` object[] — Bloqueios de etapas quando este status está ativo
        - `id` integer — Identificador único do bloqueio
        - `automation_bypass` boolean — Permite que automações ignorem este bloqueio
        - `funnel_step_id` integer — ID da etapa bloqueada
        - `funnel_status_id` integer — ID do status que causa o bloqueio (opcional)
        - `funnel_tag_id` integer — ID da tag que causa o bloqueio (opcional)
        - `created_at` string, date-time — Data e hora de criação do bloqueio
        - `updated_at` string, date-time — Data e hora da última atualização do bloqueio
  - `funnel_view_configs` object[] — Configurações de visualização do funil (visibilidade de campos, botões, etc.)
    - `key` string — Chave da configuração (ex: 'card.weight', 'info.show.tags')
    - `value` union — Valor da configuração (pode ser string, boolean ou número)
      - string
      - boolean
      - integer
      - number
    - `form_edge_id` integer — ID da aresta do formulário relacionada (opcional)

---

[API](https://skmtc.net/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.net/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/olie-ai/olie-api/versions/4859f7ec8b64/schema)
