Skip to main content
GET
/
v1
/
agents
/
{agentId}
/
schedules
Listar horarios configurados del agente
curl --request GET \
  --url https://api-prod.studio.getsupervisor.ai/v1/agents/{agentId}/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "timezone": "<string>",
      "outOfHoursBehavior": "offline",
      "rules": [
        {
          "dayOfWeek": "monday",
          "isEnabled": true,
          "slot": {
            "startTime": "<string>",
            "endTime": "<string>"
          }
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "outOfHoursMessage": "<string>",
      "metadata": {}
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "hasNext": true,
    "hasPrevious": 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.

Path Parameters

​
agentId
string<uuid>
required

Identificador del agente

Query Parameters

​
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%\"))"

​
or
string

Agrupa condiciones alternativas usando la gramática del API Query Builder. Expresión string que agrupa condiciones alternativas utilizando or(...) o combinaciones anidadas junto con and(...) según convenga.

Example:

"or(eq(status,\"active\"),eq(status,\"training\"))"

​
sort
string

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

Example:

"createdAt,-id"

​
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

Response

200 - application/json

Horarios encontrados

Colección paginada de horarios configurados para un agente.

​
data
object[]
required
​
meta
object
required