kustomer-client
Preparing search index...
KustomerApi
getUserById
Function getUserById
getUserById
<
ThrowOnError
extends
boolean
=
true
>
(
options
:
Options
<
GetUserByIdData
,
ThrowOnError
>
,
)
:
RequestResult
<
{
data
:
{
attributes
:
{
createdAt
:
string
;
displayName
:
null
|
string
;
email
:
string
;
mobile
:
null
|
string
;
name
:
string
;
roles
:
string
[]
;
updatedAt
:
string
;
userType
:
string
;
}
;
id
:
string
;
links
:
{
self
:
string
}
;
relationships
:
{
org
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Get User by ID Retrieves a user using their unique ID.
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
options
:
Options
<
GetUserByIdData
,
ThrowOnError
>
Returns
RequestResult
<
{
data
:
{
attributes
:
{
createdAt
:
string
;
displayName
:
null
|
string
;
email
:
string
;
mobile
:
null
|
string
;
name
:
string
;
roles
:
string
[]
;
updatedAt
:
string
;
userType
:
string
;
}
;
id
:
string
;
links
:
{
self
:
string
}
;
relationships
:
{
org
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
kustomer-client
Loading...
Get User by ID Retrieves a user using their unique ID.