Usuarios
Listar usuarios
Devuelve las personas con acceso a la cuenta —las que inician sesión en Filmo, no el personal— con su rol, si administran la cuenta, el estado de su acceso (activo, invitación pendiente o inactivo) y el miembro del personal al que están vinculadas.
users:readusers:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
No emite credenciales, sesiones, permisos ni preferencias. Solo administradores. Ordenadas por nombre.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: name, email, status, createdAt, updatedAt. Por defecto, "name". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Filtra por estado de acceso: active, pending (invitado, aún sin aceptar) o inactive.
Opciones disponibles: active, pending, inactive
Filtra por status, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Opciones disponibles: active, pending, inactive
Límites: mín. 1 elementos, máx. 50 elementos
Filtra según si el usuario es administrador de la cuenta (true) o no (false).
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, updated.
Mostrar atributos hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único del usuario. Es el valor que otros recursos llevan en createdBy, mentionedUserIds y similares.
Nombre visible.
Email con el que la persona inicia sesión.
Rol en esta cuenta.
Mostrar atributos hijosOcultar atributos hijos
Identificador del rol: owner, super-admin, admin, un rol predefinido o custom.
Nombre del rol, en el idioma de la cuenta.
true cuando el rol administra la cuenta.
Estado del acceso: active, pending (invitado, aún sin aceptar) o inactive.
Opciones disponibles: active, pending, inactive
Identificador del miembro del personal al que está vinculado este usuario (consulta /api); null si ninguno.
Fecha en que se creó la cuenta de usuario en ISO 8601 UTC; null para una invitación aún no aceptada.
Fecha de la última modificación de la cuenta de usuario en ISO 8601 UTC; null para una invitación aún no aceptada.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/users.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasUsuarios
Listar usuarios
Devuelve las personas con acceso a la cuenta —las que inician sesión en Filmo, no el personal— con su rol, si administran la cuenta, el estado de su acceso (activo, invitación pendiente o inactivo) y el miembro del personal al que están vinculadas.
Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?