Get
/users/ref/{ref}
Security
HTTP
Type basic
To pass the authentication step you will need to provide the following:
Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received
Path parameters
ref
stringRequired
The user ref
Examplexyzabc
Responses
200
The user
object
A basic user object
id
string
The user's ID
Example646767d82535201223349e09
ref
string | null
The user's ref
Examplexyzabc
firstName
string | null
The user's first name
ExampleJohn
lastName
string | null
The user's last name
ExampleDoe
email
string | null
The user's email
Examplesample@thrivelearning.com
role
string | null
The user's role
Examplelearner
status
string | null
The user's status
Exampleactive
positions
Array of object (UserPosition)
The user's positions
object
User Position
id
string
The user ID
Example646767d82535201223349e09
manager
object | null
The user's management position
Example{
"id": "646767d82535201223349e09"
}
ouId
string | null
Example646767d825
isActive
boolean
Defines whether the user is active
Exampletrue
startDate
string (date-time) | null
Example2021-01-01T09:00:00Z
endDate
string (date-time) | null
Example2021-01-01T09:00:00Z
createdAt
string (date-time) | null
Example2021-01-01T09:00:00Z
updatedAt
string (date-time) | null
Example2021-01-01T09:00:00Z
additionalFields
object | null
Additional fields
Example{
"location": "London"
}
languageCode
string | null
The user's language code
Exampleen-gb
400
Bad Request
object
Bad Request
status
number
Example400.0
error
string
ExampleBad Request
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
401
Unauthorized
object
Unauthorized
status
number
Example401.0
error
string
ExampleUnauthorized
message
string
404
Not Found
object
Not found
status
number
Example404.0
error
string
ExampleNot Found
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
default
Internal Server Error
object
Internal Server Error
status
number
Example500.0
error
string
ExampleInternal Server Error
message
string