> ## Documentation Index > Fetch the complete documentation index at: https://docs.olie.ai/llms.txt > Use this file to discover all available pages before exploring further. # Obter automação > 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). ## OpenAPI ````yaml /api-reference/openapi.json get /api/management/automations/{automation} openapi: 3.0.0 info: title: Olie API version: 1.0.0 description: > # Introdução 👋 Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/). Aqui você encontra as referências e exemplos de uso dos nossos endpoints. Para uma visão completa, recomendamos fortemente que você leia a [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá estão detalhados tópicos essenciais como [autenticação](https://docs.olie.ai/api-reference/introduction/authentication), [estrutura de respostas](https://docs.olie.ai/api-reference/general/response-structure), [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros guias de integração. No Postman, esta coleção foca nas informações específicas de cada requisição (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e desenvolvimento. servers: - url: https://api.olie.ai security: - BearerAuth: [] paths: /api/management/automations/{automation}: parameters: - name: automation in: path required: true description: ID (número) da automação. schema: type: string example: '' get: tags: - automations summary: Obter automação description: >- 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). operationId: obterAutomaOEspecFica responses: '200': description: Sucesso content: application/json: schema: type: object description: Automação encontrada. properties: response: type: boolean description: >- Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas. automation: type: object description: Automação, com seus componentes. properties: id: type: integer description: ID da automação. title: type: string description: Nome da automação. active: type: boolean description: Se a automação está ligada. executions: type: integer description: Quantas vezes a automação foi executada. nullable: true components: type: array description: Componentes do fluxo, ordenados por order. items: type: object description: Componente do fluxo. properties: id: type: string description: ID (UUID) do componente. format: uuid type: type: string description: Tipo do componente. enum: - trigger - condition - action variant: type: string description: Variante do componente. enum: - 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 parent_id: type: string description: >- ID da condição à qual o componente pertence. Nulo no nível principal. nullable: true conditional_case: type: string description: 'Ramo da condição pai: when_true ou when_false.' enum: - when_true - when_false - null nullable: true order: type: integer description: Posição entre os irmãos. project_scope: type: object description: >- Escopo de projetos salvo (scope, quantifier, advanced_syntax, hierarchy_levels). Nulo em gatilhos. properties: scope: type: string description: Em quais projetos o componente age. enum: - trigger - descendants - ancestors - siblings - siblings_including_trigger - advanced_syntax - filtered quantifier: type: string description: >- Como uma condição combina resultados de vários projetos. enum: - all - any - none advanced_syntax: type: string description: Expressão que devolve os projetos. hierarchy_levels: type: array description: Níveis da hierarquia considerados. items: type: integer description: Nível da hierarquia. nullable: true project_scope_saved_filter_id: description: >- ID do filtro salvo que restringe os projetos da ação. nullable: true anyOf: - type: string - type: integer config: type: object description: >- Opções do componente; as chaves dependem da variante. additionalProperties: true relations: type: array description: Vínculos do componente. items: type: object description: Vínculo do componente com um objeto da conta. properties: id: type: string description: ID (UUID) do vínculo. format: uuid model_type: type: string description: Tipo do objeto vinculado. model_id: type: string description: ID do objeto vinculado, em texto. discriminator: type: string description: >- Papel do vínculo, quando a variante distingue mais de um. nullable: true created_at: type: string description: Data de criação do componente. format: date-time updated_at: type: string description: Data da última alteração do componente. format: date-time deleted_at: type: string description: >- Data de exclusão do componente. Nulo quando ativo. format: date-time nullable: true project_scope_saved_filter_items: type: array description: Regras do filtro de escopo, quando houver. items: type: object description: Regra do filtro de escopo. properties: {} additionalProperties: true nullable: true created_at: type: string description: Data de criação da automação. format: date-time updated_at: type: string description: Data da última alteração da automação. format: date-time deleted_at: type: string description: Data de exclusão. Sempre nulo nas respostas. format: date-time nullable: true example: response: true automation: id: 33 title: '[Postman doc] Avisar equipe na manutenção corretiva' active: false executions: 0 components: - id: 01a0cb23-fd4a-71aa-9174-55786e2af56d type: trigger variant: project_step_moved_trigger parent_id: null conditional_case: null order: 0 project_scope: null project_scope_saved_filter_id: null project_scope_saved_filter_items: null config: {} relations: - id: 01a0cb23-fd4d-730f-9846-5cb1df92495c model_type: App\Models\FunnelStep model_id: '46' discriminator: null created_at: '2026-09-22T22:02:08.000000Z' updated_at: '2026-09-22T22:02:16.000000Z' deleted_at: null - id: 01a0cb23-fd56-71cc-a75b-b28ff7970270 type: action variant: project_content_add_action parent_id: 01a0cb23-fd4f-7197-9018-b10f48d439c7 conditional_case: when_true order: 0 project_scope: scope: trigger project_scope_saved_filter_id: null project_scope_saved_filter_items: null config: channel_name: Equipe destination_mode: internal message: Manutenção corretiva iniciada em {{project.name}}. relations: [] created_at: '2026-09-22T22:02:08.000000Z' updated_at: '2026-09-22T22:02:16.000000Z' deleted_at: null - id: 01a0cb23-fd4f-7197-9018-b10f48d439c7 type: condition variant: project_contains_tag_condition parent_id: null conditional_case: null order: 1 project_scope: scope: trigger project_scope_saved_filter_id: null project_scope_saved_filter_items: null config: block_flow: true only_one_checks: true relations: - id: 01a0cb23-fd54-7002-a076-d16dde248be5 model_type: App\Models\FunnelTag model_id: '53' discriminator: null created_at: '2026-09-22T22:02:08.000000Z' updated_at: '2026-09-22T22:02:16.000000Z' deleted_at: null created_at: '2026-09-22T22:02:08.000000Z' updated_at: '2026-09-22T22:02:16.000000Z' deleted_at: null '404': description: Não encontrada content: application/json: schema: type: object description: Resposta de erro. properties: response: type: boolean description: Indicador de sucesso da requisição. Sempre false em erros. message: type: string description: >- Código do erro para tratamento no cliente: automation_model_not_found (inexistente, excluída ou de outra conta). error: type: string description: Descrição legível do erro. example: response: false message: automation_model_not_found error: No query results for model [App\Models\Automate\Automation]. components: securitySchemes: BearerAuth: type: http scheme: bearer ````