GET/api/v1/users

Obtener Usuarios

Recupera una lista paginada de usuarios para el inquilino con filtros opcionales. Utilice el formato metadata=[campo=valor] para el filtrado de metadatos.

Autenticación

Envía tu API key en el header x-api-key header.

x-api-keybearer

Parámetros

page

query · number

Número de página para la paginación (predeterminado: 1)

limit

query · number

Número de elementos por página (predeterminado: 10)

email

query · string

Filtrar por correo electrónico (coincidencia parcial)

phone

query · string

Filtrar por teléfono (coincidencia parcial)

metadata

query · array

Filtrar por campos de metadatos (formato: [campo=valor]&[campo2=valor2])

Respuestas

200

PublicApiGetUsersResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

array<PublicApiUserDto>

Array of users

Ejemplo de respuesta

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+1234567890",
      "position": "sales_manager",
      "metadata": {
        "salesRegion": "North",
        "customerId": "12345"
      },
      "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
    }
  ]
}

401No autorizado - clave API o token Bearer faltante o inválido