Skip to main content
GET
Listar assistentes da etapa

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

step
string
required

ID da etapa do funil.

Query Parameters

page
string

Página desejada. Padrão 1.

perPage
string

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

200 - application/json

Sucesso

Resposta paginada. Diferente do restante da API, os campos de paginação vêm na raiz, e não dentro de meta.

current_page
integer
required

Página retornada.

data
object[]
required

Assistentes encontrados na página atual.

per_page
integer
required

Itens por página.

total
integer
required

Total de itens encontrados.

first_page_url
string

Endereço da primeira página.

from
integer

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

last_page
integer

Número da última página.

last_page_url
string

Endereço da última página.

Links de navegação prontos para uma barra de paginação.

next_page_url
string

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

path
string

Endereço base usado para montar os links.

prev_page_url
string

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

to
integer

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