Usuarios

Obtener usuarios

GET /v1/users

Permite la posibilidad de obtener el listado de usuarios. Disponible con credenciales CUSTOMER.

ParámetrosDescripción
page
  • (opcional)
  • integer
  • El número de la página de resultados a obtener (>=0). Si no es enviado, por defecto es 0
size
  • (opcional)
  • integer
  • El número de resultados por página (max = 10000). Si no es enviado, por defecto es 10
email
  • (opcional)
  • string
  • El email del usuario
merchantId
  • (opcional)
  • string
  • El id del comercio al que pertenece un usuario
customerId
  • (opcional)
  • string
  • El id del cliente al que pertenece un usuario
userType
  • (opcional)
  • string
  • El tipo de usuario a listar
  • [MERCHANT, CUSTOMER]
next
  • (opcional)
  • integer
  • Número de página a obtener. Si se envía, tiene prioridad sobre page
limit
  • (opcional)
  • integer
  • Cantidad de resultados por página. Si se envía, tiene prioridad sobre size
curl --location --request GET 'https://api.menta.global/api/v1/users?page=0&size=10' \
--header 'Authorization: Bearer {access_token}' 
{
"users": [
    {
        "attributes": {
            "id": "string",
            "name": "string",
            "username": "string",
            "description": "string",
            "email": "string",
            "customer_id": "array",
            "merchant_id": "array",
            "country": "string",
            "type": "string",
            "scope": "string"
        },
        "status": "CONFIRMED",
        "enabled": boolean,
        "audit": {
            "creation_date": "2019-02-05T21:03:54.499+0000",
            "update_date": "2019-02-05T21:03:54.499+0000"
        }
    }
],
"_metadata": {
    "_size": 0,
    "_total_elements": 0,
    "_total_pages": 0,
    "_number": 0,
    "_next": "string",
    "_limit": 0
}
}

username y description se incluyen solo si están definidos. En _metadata, _next es el número de la página siguiente como texto (se omite si no hay) y _limit es el tamaño de página.