User by ID

Prev Next
Get
/public/v1/user-management/users/{userId}

Retrieves a single user by their unique identifier, including their roles, locations, and location group assignments

Security

The requesting user must have the following permission to retrieve a user:

  • Administration → Users → View Users
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Path parameters
userId
stringRequired

The unique identifier of the user to retrieve (UUID format)

Responses
200

User

Expand All
object
id
string (uuid)

Unique identifier of the user.

fullName
string
username
string
defaultLocation
object (UserDetailLocation)
id
string (uuid)

Unique identifier of the location.

name
string

Display name of the location.

number
string

Number assigned to the location.

mobileNumber
string
email
string
inactive
boolean

Indicates whether the user is inactive.

allLocationsAccess
boolean
allBrandFranchiseeLocationAccess
boolean
allReportsAccess
boolean
canGrantAccessBeyondPersonalLevel
boolean
userRoles
Array of object (UserDetailRole)
object
id
string (uuid)

Unique identifier of the role.

name
string

Display name of the role.

reportRoles
Array of object (UserDetailRole)
object
id
string (uuid)

Unique identifier of the role.

name
string

Display name of the role.

locations
Array of object (UserDetailLocation)
object
id
string (uuid)

Unique identifier of the location.

name
string

Display name of the location.

number
string

Number assigned to the location.

externalLocations
Array of object (UserDetailLocation)
object
id
string (uuid)

Unique identifier of the location.

name
string

Display name of the location.

number
string

Number assigned to the location.

subGroupValues
Array of object (UserDetailSubGroupValue)
object
id
integer (int32)

Unique identifier of the option with location group.

subGroupValue
string | null
locationGroup
object (EntityReferenceLongGet)
id
integer (int64)

Unique identifier of the entity reference long.

name
string | null

Display name of the entity reference long.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.