API de equipos

La API de equipos te permite gestionar los miembros de tu organización. Puedes invitar nuevos colaboradores, asignar roles, actualizar permisos y eliminar miembros. Los límites de miembros del equipo se aplican según tu plan de suscripción.

URL base: https://api.zenflip.io/v1/teams

Roles y permisos

ZenFlip utiliza cuatro roles con permisos jerárquicos:

Cada organización tiene exactamente un owner. El rol de propietario no puede ser eliminado ni degradado. La transferencia de propiedad debe realizarse a través del panel de control.

Listar miembros del equipo

Recupera todos los miembros de tu organización.

Ejemplo de solicitud

Ejemplo de respuesta

El campo status indica si el miembro está active (aceptó la invitación) o invited (pendiente de aceptación).

Invitar a un miembro del equipo

Envía una invitación por email a un nuevo miembro del equipo. El invitado recibe un enlace para establecer su contraseña y unirse a la organización.

Rol requerido: admin o superior.

Cuerpo de la solicitud

Ejemplo de solicitud

Ejemplo de respuesta

Si la organización ha alcanzado el límite de miembros de equipo de su plan, la API devuelve un error 403 con un mensaje indicando que se ha alcanzado el límite.

Reenviar invitación

Reenvía el email de invitación a un miembro del equipo pendiente.

Rol requerido: admin o superior.

Ejemplo de solicitud

Ejemplo de respuesta

Revocar invitación

Cancela una invitación pendiente antes de que haya sido aceptada.

Rol requerido: admin o superior.

Ejemplo de solicitud

Ejemplo de respuesta

Validar una invitación (público)

Comprueba si un token de invitación es válido sin consumirlo. Este es un endpoint público utilizado por el frontend para mostrar el formulario de aceptación de la invitación.

No se requiere autenticación.

Cuerpo de la solicitud

Ejemplo de respuesta

Aceptar una invitación (público)

Acepta una invitación y establece una contraseña. Este endpoint crea la cuenta de usuario, genera tokens JWT e inicia sesión del usuario inmediatamente.

No se requiere autenticación.

Cuerpo de la solicitud

Ejemplo de solicitud

Ejemplo de respuesta

Actualizar rol de miembro

Cambia el rol de un miembro del equipo existente.

Rol requerido: admin o superior.

Cuerpo de la solicitud

Ejemplo de solicitud

Ejemplo de respuesta

Restricciones:

• No puedes cambiar el rol de owner.

• Un admin no puede promover a otro miembro a owner.

• No puedes cambiar tu propio rol.

Eliminar un miembro del equipo

Elimina un miembro de la organización. Esto revoca todo su acceso inmediatamente.

Rol requerido: admin o superior.

Ejemplo de solicitud

Ejemplo de respuesta

Restricciones:

• El owner de la organización no puede ser eliminado.

• Un miembro no puede eliminarse a sí mismo (usa el panel de control para abandonar una organización).

Límites del plan

Los límites de miembros del equipo varían según el plan de suscripción:

Intentar invitar a un miembro más allá del límite de tu plan devuelve un error 403. Actualiza tu plan a través de la configuración de facturación para aumentar el límite.