Pular para o conteúdo principal
GET
Listar os Agents de um workspace

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Parâmetros de consulta

type
enum<string> | null

Retorna apenas Agents deste tipo. Tipos de Agent expostos pela API pública.

Opções disponíveis:
LEADSCOUT,
SERVICE_AGENT
limit
integer
padrão:20

Número de Agents por página

Intervalo obrigatório: 1 <= x <= 100
cursor
string | null

Cursor recebido em uma solicitação anterior para obter a próxima página

Resposta

Resposta bem-sucedida

Corpo da resposta para listar os Agents de um workspace.

agents
AgentResponse · object[]
obrigatório

Lista de Agents.

cursor
string | null

Cursor a ser enviado ao solicitar a próxima página. É null na última página.