Saltar al contenido principal
GET
Listar directorio de usuarios

Autorizaciones

Authorization
string
header
requerido

Token JWT de autenticación

Encabezados

x-company-id
string

Identificador de la empresa objetivo. Obligatorio solo para API keys globales (type=global). Se ignora para API keys de empresa y usuarios humanos.

Parámetros de consulta

page
integer
predeterminado:1

Número de página (empieza en 1)

Rango requerido: 0 < x <= 9007199254740991
rowsPerPage
integer
predeterminado:10

Cantidad de elementos por página

Rango requerido: 0 < x <= 100

Filtra por nombre o correo electrónico (sin distinguir mayúsculas).

Maximum string length: 100
status
enum<string>
predeterminado:ACTIVE

Estado de los usuarios listados. Valor por defecto: ACTIVE.

Opciones disponibles:
ACTIVE,
INACTIVE

Respuesta

Página del directorio de usuarios

result
object[]
requerido

Usuarios de la página

meta
object
requerido

Metadatos de la paginación