Skip to main content
GET
/
v1
/
agents
Listar agentes del workspace
curl --request GET \
  --url https://agents.studio.getsupervisor.ai/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "data": [
    {
      "agentId": "5769e110-7267-4cf7-a3ca-2d06e8fffbb3",
      "workspaceId": "a44bb95e-9f01-4d19-8b62-1f6f2b8e8363",
      "name": "Soporte Voz Latam",
      "agentType": "voice",
      "status": "active",
      "createdAt": "2025-09-20T18:22:04.012Z",
      "updatedAt": "2025-10-03T10:15:11.004Z"
    },
    {
      "agentId": "c13e5575-55a3-4b64-8a1e-e4b3efa497f4",
      "workspaceId": "a44bb95e-9f01-4d19-8b62-1f6f2b8e8363",
      "name": "Onboarding Chat",
      "agentType": "chat",
      "status": "inactive",
      "createdAt": "2025-09-02T14:03:29.501Z",
      "updatedAt": "2025-09-18T08:41:02.903Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 37,
    "hasPrevious": false,
    "hasNext": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-workspace-id
string<uuid>
required

Identificador del workspace multi-tenant.

Query Parameters

​
page
integer
default:1

Número de página (>= 1). Por defecto es 1.

Required range: x >= 1
​
limit
integer
default:20

Tamaño de página (1..100). Por defecto 20.

Required range: 1 <= x <= 100
​
sort
string

Lista separada por comas de campos a ordenar. Usa prefijo '-' para orden descendente.

Example:

"createdAt,-id"

​
fields
string

Lista separada por comas de campos a retornar (sparse fieldset).

Example:

"id,externalId,status"

​
include
string

Lista separada por comas de relaciones a cargar.

Example:

"messages,sender"

​
q
string

Búsqueda de texto global sobre campos soportados del recurso.

Example:

"soporte"

​
filter
string

Expresión de filtros combinados generada con el API Query Builder. Utiliza funciones como and(...), or(...), eq(...), like(...), etc. Consulta docs/api-query-builder.md para la gramática completa y ejemplos adicionales.

Expresión string compatible con el API Query Builder. Soporta composición de funciones (and, or) y operadores (eq, like, between, etc.) para filtrar resultados.

Example:

"and(eq(status,\"active\"),like(name,\"%ventas%\"))"

Response

Listado paginado de agentes

​
data
object[]
required
​
meta
object
required