Sign in
step-assistants
Assistentes

Listar assistentes da etapa

Lista os assistentes de uma etapa específica, do mesmo formato da listagem geral e já restrita à etapa informada.

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/steps/{step}/assistants

Query parameters

pagestring

Página desejada. Padrão 1.

perPagestring

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

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. Redundante aqui, já que a etapa vem da URL.

filter[ai_agent_id]string

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

Response

Sucesso

current_pageinteger required

Página retornada.

first_page_urlstring

Endereço da primeira página.

frominteger

Posição do primeiro item da página no total.

last_pageinteger

Número da última página.

last_page_urlstring

Endereço da última página.

next_page_urlstring

Endereço da próxima página, ou null na última.

pathstring

Endereço base usado para montar os links.

per_pageinteger required

Itens por página.

prev_page_urlstring

Endereço da página anterior, ou null na primeira.

tointeger

Posição do último item da página no total.

totalinteger required

Total de itens encontrados.

Changes