Obtener todos los usuarios del negocio

Este endpoint permite consultar la lista de usuarios vinculados a un negocio.

GET /api/v1/businesses/{businessId}/users

Si el businessId incluido en la petición es correcto, la respuesta contendrá un array con la información de todos los usuarios vinculados al negocio.

Ejemplo de respuesta

[
    {
        "username": "user1",
        "email": "user1@orquest.com",
        "employeeId": "EMP-001",
        "roles": ["Manager"],
        "nodes": [
            "2102",
            "2101",
            "00000"
        ],
        "lastLogin": "2025-03-20T08:45:00Z",
        "creation": "2023-01-15",
        "createdBy": "user2"
    },
    {
        "username": "user3",
        "email": "user3@orquest.com",
        "roles": [],
        "nodes": [],
        "createdBy": "SYSTEM"
    }
]
Detalles

  • username. Nombre de usuario.

  • email. Dirección de correo electrónico vinculada al usuario.

  • employeeId. Identificador externo del empleado vinculado al usuario, si corresponde.

  • roles. Lista de roles definidos para el usuario.

  • nodes. Lista de identificadores externos de los nodos en los que el usuario tiene visibilidad. Si no se ha definido el identificador externo del nodo en el negocio, no podrá aparecer en la respuesta.

  • lastLogin. Fecha y hora del último acceso del usuario en formato yyyy-MM-ddTHH:mm:ss.SSSZ.

  • creation. Fecha de creación del usuario en formato yyyy-MM-dd.

  • createdBy. Nombre del usuario que creó la cuenta.

Aspectos que tener en cuenta

La petición devolverá la información correspondiente para cada usuario: si no está vinculado a un empleado o si no ha accedido nunca al sistema, estos campos no aparecerán en la respuesta.

Si un usuario pertenece a varios negocios, aparecerá en la consulta de todos aquellos a los que está vinculado, siempre que el usuario que realiza la petición tenga visibilidad sobre ellos.

En la respuesta aparecerán solo los roles que el usuario tenga definidos en el negocio de la petición. Si un rol no existe en ese negocio, se devolverá un array vacío [].

Del mismo modo, solo aparecerán los nodes sobre los que el usuario tenga visibilidad dentro del negocio de la petición.

Paginación

La respuesta de esta petición es paginada, por lo que, después de la primera llamada, en las cabeceras de respuesta (Headers) aparecerá un cursor a la página siguiente (next) que indica la URL de la siguiente petición. Para obtener la siguiente página de datos, se debe realizar una petición a esa URL con el cursor:

GET /api/v1/businesses/{businessId}/users?cursor=******

Será necesario repetir este proceso hasta que la respuesta no contenga la cabecera next, lo que indica que la paginación ha terminado y que no hay más datos que mostrar.

Si el cursor no es correcto o ha expirado, la petición devolverá un error 400 Bad Request.

Solo se devolverán los nodes sobre los que el usuario tenga visibilidad en el negocio de la petición y los roles definidos dentro de este negocio.

Enlaces de interés

¿Qué es un usuario? ¿Cómo se crea o actualiza?

¿Cuál es la diferencia entre rol de empleado y rol de usuario?

¿Qué es un nodo?