latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1919701.3 MB

063de6e2e93c

step-assistants
Assistentes

Listar todos os assistentes de etapa

Lista os assistentes de etapa de todos os funis da conta, sem precisar percorrer etapa por etapa. É a visão usada pelo menu de Assistentes de etapa.

Cada item já vem com a etapa e o agente de IA associados. Aceita filtros e paginação por query params, consulte:

Os campos de paginação (current_page, per_page, total, ...) vêm na raiz da resposta, ao lado de data, e não dentro de meta como no restante da API.

get/api/management/step-assistants

Query parameters

pagestring

Página desejada. Padrão 1.

perPagestring

Itens por página. Padrão 30, máximo 100.

filter[id]string

ID (UUID) de um assistente específico. Aceita vários IDs separados por vírgula.

filter[name]string

Trecho do nome do assistente.

filter[active]string

1 retorna apenas os ativos, 0 apenas os inativos.

filter[funnel_step_id]string

ID da etapa do funil à qual o assistente pertence.

filter[ai_agent_id]string

ID (UUID) do agente de IA que executa o assistente.

Response

Sucesso

current_pageinteger
first_page_urlstring uri
frominteger
last_pageinteger
last_page_urlstring uri
{"stackTrail":"paths:/api/management/step-assistants:get:responses:200:content:application/json:schema:properties:next_page_url","oasType":"schema","type":"unknown","nullable":true}
pathstring uri
per_pageinteger
{"stackTrail":"paths:/api/management/step-assistants:get:responses:200:content:application/json:schema:properties:prev_page_url","oasType":"schema","type":"unknown","nullable":true}
tointeger
totalinteger