Skip to main content
GET
List User Details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required
userId
string
required

Response

User successfully returned.

Represents a user in the system with their profile information and access settings

id
string

Unique identifier for the user

customerId
string

Identifier of the customer the user belongs to

userName
string

Username for authentication

externalIdentifier
string

External identifier for SSO integration

fullName
string

Full display name of the user

emailAddress
string

Email address of the user

language
object

Preferred language locale

timezone
string

User's preferred timezone

roleId
string

Identifier of the user's role

roleName
string

Display name of the user's role

groupId
string

Identifier of the user's primary group

groupName
string

Display name of the user's primary group

unitPreferences
object

User's unit preference settings

sendWelcomeEmail
boolean

Flag indicating whether to send a welcome email

secondaryGroups
object[]

List of secondary groups the user belongs to