Obtener recordatorio

GET/reminders/{id}

Requiere el scope reminders:read.

Los mismos que ve el usuario en la app: los propios y los de sus proyectos compartidos. Sin acceso, inexistente o con id malformado responde el mismo 404.

Parámetros de ruta

idstringobligatorio: Id del recordatorio.

Respuestas

200

El recordatorio.

dataReminderobligatorio

Recordatorio: algo a una hora o un día, sin estado (no se completa: se borra). Todos los campos están siempre presentes; los sin valor van como null. Timestamps en epoch milisegundos UTC.

Campos de Reminder

idstringobligatorio

titlestringobligatorio

datenumber | nullobligatorio

Instante (epoch ms); en uno recurrente, la primera ocurrencia. null = sin fecha.

allDaybooleanobligatorio

Sin hora; date es la medianoche de ese día en la zona horaria de quien lo creó.

recurrenceRecurrence | nullobligatorio

Regla de recurrencia de la tarea. Los campos opcionales pueden estar ausentes.

Campos de Recurrence

frequencyRecurrenceFrequencyobligatorio: Valores: dailyweeklymonthlyyearly
intervalnumber: Rango: 1–99
dayOfWeeknumber: 0 = domingo … 6 = sábado.
Rango: 0–6
dayOfMonthnumber: -1 = último día del mes; si no, 1..31.
Rango: -1–31

notifyNotifyobligatorio

Aviso del recordatorio. onDay = avisar el día; daysBefore = días de antelación; minutesBefore = minutos antes de la hora (0 = a la hora; sin él, la antelación por defecto del usuario). En uno de todo el día el aviso sale al empezar la jornada.

Campos de Notify

onDaybooleanobligatorio
daysBeforeinteger: Rango: 0–365
minutesBeforeinteger: Rango: 0–1440

No admite otros campos: uno desconocido responde 422.

locationstring | nullobligatorio

notesstring | nullobligatorio

projectIdstring | nullobligatorio

createdByPersonobligatorio

Cuenta de SecretarIA. Sin correo a propósito.

Campos de Person

idstringobligatorio
namestring | nullobligatorio: Nombre de pila; null si la cuenta ya no existe.

createdAtnumberobligatorio

excludedKeysarray<string>obligatorio

Días (YYYY-MM-DD) quitados de un recurrente con DELETE ?scope=occurrence.

401

Key ausente, malformada, inexistente, revocada, expirada o API deshabilitada (invalid_api_key, indistinguibles a propósito).

Códigos: invalid_api_key

403

Scope insuficiente (insufficient_scope), recurso sin acceso (forbidden) o sincronización de calendario de una tarea que creó otra persona (calendar_creator_only).

Códigos: insufficient_scopeforbiddencalendar_creator_only

404

Recurso inexistente, de otro usuario o id malformado (not_found, indistinguibles a propósito).

Códigos: not_found

429

Límite superado (rate_limited) — 60 req/min (ráfagas de 20) y 5.000 req/día por key. Reintentar tras Retry-After.

Códigos: rate_limited

Cabecera Retry-After: Segundos (enteros) a esperar antes de reintentar.

500

Error interno (internal_error). Cuerpo opaco a propósito; reintentar con backoff.

Códigos: internal_error

bash

curl 'https://system.secretar-ia.org/api/v1/reminders/r4t8y2u6i0o4p8a2s6d0f4g8h2j6k0l4' \
  -H "Authorization: Bearer $SECRETARIA_API_KEY"

Recordatorio completo

JSON

{
  "data": {
    "id": "r4t8y2u6i0o4p8a2s6d0f4g8h2j6k0l4",
    "title": "Dentista",
    "date": 1797582600000,
    "allDay": false,
    "recurrence": null,
    "notify": {
      "onDay": true,
      "minutesBefore": 60
    },
    "location": "Calle Mayor 3",
    "notes": null,
    "projectId": null,
    "createdBy": {
      "id": "k1m8x2c5v9b3n7q0w4e6r1t8y2u5i3o9",
      "name": "Ana"
    },
    "createdAt": 1791972000000,
    "excludedKeys": []
  }
}