← Volver al listado
GET/api/v1/calendars

Obtener calendarios

Recuperar una lista paginada de calendarios con filtrado opcional

Autenticación

Envía tu API key en el header x-api-key header.

x-api-keybearer

Parámetros

name

query · string

Filtrar calendarios por nombre (coincidencia parcial)
isPrimary

query · boolean

Filtrar calendarios por estado principal
readOnly

query · boolean

Filtrar calendarios por estado de solo lectura
page

query · string

Número de página para la paginación
limit

query · string

Número de elementos por página

Respuestas

200Calendarios recuperados exitosamente

PublicApiGetCalendarsResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

array<PublicApiCalendarDto>

Ejemplo de respuesta

json
{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "name": "My Calendar",
      "description": "My personal calendar for work events",
      "hexColor": "#4285f4",
      "hexForegroundColor": "#ffffff",
      "isPrimary": false,
      "location": "New York, NY",
      "timezone": "America/New_York",
      "readOnly": false,
      "metadata": {
        "customField": "value"
      },
      "createdAt": "2024-07-15T09:00:00.000Z",
      "updatedAt": "2024-07-15T09:30:00.000Z"
    }
  ]
}
401No autorizado - clave API o token Bearer faltante o inválido