Changelog
Todos los cambios de la Apizeal API, del más reciente al más antiguo. El formato sigue Keep a Changelog y las versiones siguen Semantic Versioning.
Cómo leer esta página
| Categoría | Qué significa para tu integración | Versión |
|---|---|---|
| Breaking | Peticiones existentes pueden dejar de funcionar o devolver otra estructura. Solo sale en una
versión mayor nueva (un prefijo de URL nuevo, como /v2) y tras un aviso de
deprecación en esta página. |
MAJOR |
| Added | Endpoints, campos, filtros o scopes nuevos. Puedes ignorarlos hasta que los necesites. | MINOR |
| Changed | Cambio compatible en un comportamiento existente (por ejemplo, un límite ampliado o una descripción aclarada). No requiere acción. | MINOR / PATCH |
| Deprecated | Sigue funcionando, pero se eliminará. La entrada indica la fecha de retiro. Planifica tu migración. | MINOR |
| Removed | Una funcionalidad previamente deprecada ya no existe. | MAJOR |
| Fixed | Corrección de un error. El comportamiento ahora coincide con la documentación. | PATCH |
| Security | Un cambio relacionado con seguridad. Léelo aunque no hagas nada más. | Cualquiera |
Promesa de compatibilidad
Dentro de una versión mayor consideramos estos cambios no rompientes, así que tu código debe tolerarlos:
- Campos nuevos en las respuestas (ignora los campos desconocidos).
- Endpoints nuevos, parámetros opcionales nuevos y scopes nuevos.
- Valores nuevos en campos de estatus o enumeraciones.
- Cambios en el texto libre
detailde los errores (programa contracode).
Cada ruta lleva una etiqueta de ciclo de vida en la referencia: experimental (puede cambiar sin una versión mayor — usa solo lo que necesitas), stable, deprecated (con fecha de retiro) y sunset. Una ruta deprecada sigue funcionando al menos 90 días después del aviso.
1.1.1 2026-09-08
Fixed
- Las peticiones bloqueadas por el filtro de seguridad (WAF) ahora devuelven el envelope de error
estándar con
"status": 403y"code": "blocked"; antesstatusvenía vacío.
1.1.0 2026-09-04
Added
- Notas:
GET /v1/policies/{policy_id}/notesyGET /v1/contacts/{contact_id}/notes. Solo contenido en texto plano; se expone el campopermissions. - Recordatorios:
GET /v1/policies/{policy_id}/remindersyGET /v1/contacts/{contact_id}/reminders. - Tareas:
GET /v1/tasks(filtrosstatus_id,contact_id,policy_id,due_from,due_to) yGET /v1/tasks/{task_id}. - Citas médicas:
GET /v1/contacts/{contact_id}/medical-appointmentsyGET /v1/contacts/{contact_id}/medical-appointments/{appointment_id}. - Scopes
notes:read,reminders:read,tasks:readymedical:read. Todas las API keys, existentes y nuevas, reciben todos los scopes.
Changed
- La referencia del API ahora está agrupada por entidad, en orden alfabético.
1.0.0 2026-08-27
Added
- Primera versión de la Apizeal API (solo lectura) para cuentas Growth.
- Contactos:
GET /v1/contacts,GET /v1/contacts/{contact_id},GET /v1/contacts/{contact_id}/policies. - Pólizas:
GET /v1/policies,GET /v1/policies/{policy_id},GET /v1/policies/{policy_id}/members. - Catálogos:
GET /v1/catalog/carriers,GET /v1/catalog/product-types,GET /v1/catalog/policy-statuses. - API keys Bearer creadas desde la app (Integrations → API Keys), con expiración opcional
(90 o 365 días) y lista de IPs permitidas. Scopes
contacts:read,policies:read,catalog:read. - Paginación por cursor (
next_cursor,page_sizehasta 100), ids como string y un único envelope JSON de errores concodeestable.