---
title: "Obter automação"
method: GET
path: "/api/management/automations/{automation}"
tags: ["automations"]
---

# Obter automação

`GET /api/management/automations/{automation}`

Retorna a automação com todos os componentes, cada um com suas opções, vínculos e escopo de projetos. A árvore do fluxo é montada por `parent_id` e `conditional_case`; ver [Como o fluxo é executado](https://docs.olie.ai/guides/automation/anatomy).

## Response `200`

Sucesso

- object — Automação encontrada.
  - `response` boolean — Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas.
  - `automation` object — Automação, com seus componentes.
    - `id` integer — ID da automação.
    - `title` string — Nome da automação.
    - `active` boolean — Se a automação está ligada.
    - `executions` integer, nullable — Quantas vezes a automação foi executada.
    - `components` object[] — Componentes do fluxo, ordenados por order.
      - `id` string, uuid — ID (UUID) do componente.
      - `type` 'trigger' | 'condition' | 'action' — Tipo do componente.
      - `variant` 'project_step_moved_trigger' | 'project_idle_in_step_trigger' | 'project_field_change_trigger' | 'project_tag_linked_trigger' | 'project_dynamic_form_edited_trigger' | 'project_date_reached_trigger' | 'project_execution_trigger' | 'project_content_added_trigger' | 'project_contains_tag_condition' | 'project_contains_funnel_status_condition' | 'project_in_step_condition' | 'project_filter_checker_condition' | 'project_step_put_action' | 'project_change_status_action' | 'project_content_add_action' | 'send_an_email_action' | 'update_project_funnel_status_action' | 'project_funnel_link_toggle_action' | 'project_funnel_tag_add_action' | 'project_funnel_tag_remove_action' | 'project_add_loose_form_action' | 'project_group_link_toggle_action' | 'update_form_counter_action' | 'project_save_form_history_action' | 'unlink_project_from_step_action' | 'webhook_dispatch_action' | 'create_project_action' | 'assignee_users_action' | 'update_date_field_action' | 'create_customer_action' | 'create_contact_action' | 'create_project_hierarchy_action' | 'step_assistant_execute_manually_action' | 'update_manual_goal_progress_action' | 'project_execution_control_action' — Variante do componente.
      - `parent_id` string, nullable — ID da condição à qual o componente pertence. Nulo no nível principal.
      - `conditional_case` 'when_true' | 'when_false' | 'null', nullable — Ramo da condição pai: when_true ou when_false.
      - `order` integer — Posição entre os irmãos.
      - `project_scope` object, nullable — Escopo de projetos salvo (scope, quantifier, advanced_syntax, hierarchy_levels). Nulo em gatilhos.
        - `scope` 'trigger' | 'descendants' | 'ancestors' | 'siblings' | 'siblings_including_trigger' | 'advanced_syntax' | 'filtered' — Em quais projetos o componente age.
        - `quantifier` 'all' | 'any' | 'none' — Como uma condição combina resultados de vários projetos.
        - `advanced_syntax` string — Expressão que devolve os projetos.
        - `hierarchy_levels` integer[] — Níveis da hierarquia considerados.
      - `project_scope_saved_filter_id` union — ID do filtro salvo que restringe os projetos da ação.
        - string
        - integer
      - `config` object — Opções do componente; as chaves dependem da variante.
      - `relations` object[] — Vínculos do componente.
        - `id` string, uuid — ID (UUID) do vínculo.
        - `model_type` string — Tipo do objeto vinculado.
        - `model_id` string — ID do objeto vinculado, em texto.
        - `discriminator` string, nullable — Papel do vínculo, quando a variante distingue mais de um.
      - `created_at` string, date-time — Data de criação do componente.
      - `updated_at` string, date-time — Data da última alteração do componente.
      - `deleted_at` string, date-time, nullable — Data de exclusão do componente. Nulo quando ativo.
      - `project_scope_saved_filter_items` object[], nullable — Regras do filtro de escopo, quando houver.
    - `created_at` string, date-time — Data de criação da automação.
    - `updated_at` string, date-time — Data da última alteração da automação.
    - `deleted_at` string, date-time, nullable — Data de exclusão. Sempre nulo nas respostas.

## Other responses

- `404` — Não encontrada

## Changes

- **2026-09-22** `d8fb547e20a2` — 9 breaking, 41 warning, 5 info
  - the response property `automation/executions` became nullable for the status `200`
  - the `automation/components/items/conditional_case` response's property type changed from no type to `string` for status `200`
  - the `automation/components/items/deleted_at` response's property type changed from no type to `string`, and format from no format to `date-time` for status `200`
  - the `automation/components/items/parent_id` response's property type changed from no type to `string` for status `200`
  - …51 more
- **2026-09-22** `4e244f2507d6` — 2 info
  - added the media type `application/json` for the response with the status `200`
  - added the non-success response with the status `404`

[Change history](https://skmtc.dev/olie-ai/apis/olie-api/changes/api/management/automations/:automation/get.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.dev/olie-ai/apis/olie-api/revisions/d7bda7d32f67?raw)