Get user information

This endpoint retrieves the information of a user filtered by their username.

GET /api/v2/businesses/{businessId}/users/{userName}

If the data included in the request is correct —both businessId and userName—, the response will contain the information defined for the employee:

  • username: name of the user.

  • mail: email address linked to the user.

  • nodes: nodes in which the user has visibility.

  • roles: user roles.

Below is an example of a response:

GET /api/v2/businesses/BUSINESSID/users/test.user@orquest.com
{
    "username": "test.user@orquest.com",
    "email": "test.user@orquest.com",
    "nodes": [
        5391, 5392
    ],
    "roles": ["Manager"]
}

Considerations

If the username specified in the request URL does not match any user in the business, the request will return a 404 Not Found error, indicating User not found in the message.

If the user does not have any role assigned, an empty array [] will appear in this field.

What is a user?

What is a node?

What is the difference between an employee role and a user role?