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

# Obter um funil de projeto

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

Retorna a configuração completa de um funil: etapas com checklists, restrições, anexos, formulário e assistentes, além de etiquetas, status, bloqueios, projetos-modelo e área de negócio. Traz também a lista de usuários com acesso ao funil e, quando o autenticado é um usuário, a configuração de quadro dele. Ver [Criar e configurar um funil](https://docs.olie.ai/guides/funnels/creating-funnels) e [Etapas do funil](https://docs.olie.ai/guides/funnels/steps).

## Request body

- object
  - `project_funnel_id` integer, required — ID do funil a carregar. Obrigatório.
  - `include_automations` boolean — Quando true, inclui as automações de cada etapa — desde que o usuário possa vê-las.
  - `with_trashed_relations` boolean — Quando true, inclui etiquetas e status excluídos, para exibir o histórico de projetos antigos.
  - `offset` integer — Reservado para paginação interna.

## Response `200`

Sucesso

- object
  - `response` boolean, required — Sempre true quando a operação é concluída.
  - `project_funnel` object, required — Funil com a configuração completa.
    - `id` integer — ID do funil.
    - `name` string — Nome do funil.
    - `prefix` string, nullable — Prefixo usado no código dos projetos do funil.
    - `order` integer — Posição do funil na ordem de exibição.
    - `condition` 'active' | 'inactive' — Situação do funil.
    - `allow_multi_step` boolean — Indica se o projeto pode ocupar várias etapas ao mesmo tempo.
    - `project_term` object, nullable — Vocabulário do funil para o termo 'projeto'.
    - `show_cost_info` boolean — Indica se as informações de custo aparecem no funil.
    - `allow_execution` boolean — Indica se o funil permite cronometrar execução.
    - `business_area_id` integer, nullable — ID da área de negócio do funil.
    - `form_id` integer, nullable — ID do formulário de vínculo do funil.
    - `funnel_config_template_id` integer, nullable — Modelo de configuração de quadro em uso.
    - `frame_id` string, uuid — ID (UUID) da conta dona do funil.
    - `created_at` string, date-time — Data de criação.
    - `updated_at` string, date-time — Data da última alteração.
    - `deleted_at` string, date-time, nullable — Data de arquivamento, quando o funil está arquivado.
    - `steps` object[] — Etapas do funil.
    - `tags` object[] — Etiquetas do funil.
    - `funnel_status` object[] — Status do funil.
    - `attachments` object[] — Anexos do funil.
    - `template_projects` object[] — Projetos-modelo vinculados ao funil.
    - `business_area` object, nullable — Área de negócio do funil.
    - `form` object, nullable — Formulário de vínculo do funil.
    - `access` object[] — Usuários com acesso ao funil e o alcance de cada um.
      - `id` string, uuid — ID (UUID) do usuário.
      - `name` string — Nome do usuário.
      - `avatar_url` string, nullable — Foto do usuário.
      - `index_all` boolean — Vê todos os projetos do funil.
      - `index_assigned` boolean — Vê os projetos em que está designado.
      - `index_created` boolean — Vê os projetos que criou.
      - `role_based_step_change` boolean — Pode mover projetos entre etapas pelo cargo.
  - `funnel_view_configs` union — Configuração de quadro do usuário autenticado. Ausente quando o autenticado é uma aplicação.
    - object
    - unknown[]
      - unknown

## Changes

- **2026-08-24** `3c590152d5b5` — 12 breaking, 38 warning, 16 info
  - the response property `funnel_view_configs` became nullable for the status `200`
  - the response property `project_funnel/business_area` became nullable for the status `200`
  - the response property `project_funnel/business_area_id` became nullable for the status `200`
  - the response property `project_funnel/deleted_at` became nullable for the status `200`
  - …62 more
- **2026-08-19** `f3efb100a3fc` — 2 info
  - api tag `Funis` added
  - api tag `get-project-funnels` removed

[Change history](https://skmtc.dev/olie-ai/apis/olie-api/changes/api/management/get-project-funnels/post.md)

---

[API](https://skmtc.dev/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.dev/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/olie-ai/olie-api/revisions/8c9bac94e5ad/schema)