Search users and return basic user information

  • Published on Oct 27, 2025
  • 2 minute(s) read
Prev Next
Get
/users
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

Query parameters
page
number

Used in combination with the limit parameter to page through the data.

Default1.0
Example1.0
perPage
number

Used in combination with the page parameter to page through the data.

Minimum1
Maximum1000
Default100.0
Example50.0
Responses
200

The users

Expand All
object
results
Array of object (User)
object

A 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
deleted
boolean

Defines whether the user has been deleted

Examplefalse
compliance
number

The user's compliance score

Example0.0
level
number

The user's level

Example0.0
firstLogin
string (date-time) | null
Example2021-01-01T09:00:00Z
lastLogin
string (date-time) | null
Example2021-01-01T09:00:00Z
tags
object
skills
string
ExampleLeadership
usersFollowing
Array of string
Example[ "646767d82535201223349e09" ]
string
tagsFollowing
Array of string
Example[ "646767d82535201223349e09" ]
string
createdAt
string (date-time) | null
Example2021-01-01T09:00:00Z
updatedAt
string (date-time) | null
Example2021-01-01T09:00:00Z
hasPicture
boolean

Defines whether the user has a profile picture

Examplefalse
timeZone
string | null

The user's time zone

ExampleEurope/London
summary
string | null

The user's summary

ExampleA summary of the user
relevancy
number

The user's relevancy score

Example0.0
rank
object
currentCategory
string
ExampleBeginner
currentRank
number
Example1.0
agreedTerms
boolean | null

Defines whether the user has agreed to the terms

Exampletrue
onboarded
boolean | null

Defines whether the user has been onboarded

Exampletrue
audiences
Array of string
Example[ "646767d82535201223349e09" ]
string
singleSignOn
boolean

Defines whether the user is using single sign-on

Exampletrue
pagination
object (Pagination)

Details of the pagination

totalResults
integer

Total number of results matching the query

Example48
totalPages
integer

Total number of pages available

Example3
page
integer

Current page number

Minimum1
Default1
Example1
perPage
integer

Number of results per page

Minimum1
Maximum1000
Default100
Example20
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