Appearance

List Users ​

Endpoint ​

http
GET /unified/lms/users
Integrations supported
  • TalentLMS
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • TalentLMS

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

result
object[]

List of Users

id
string
REQUIRED · 

The unique identifier for the user

Supported in
  • TalentLMS
first_name
string

The user's first name

Supported in
  • TalentLMS
last_name
string

The user's last name

Supported in
  • TalentLMS
name
string

The user's name

Supported in
  • TalentLMS
username
string

The user's username or login identifier, when different from email

Supported in
  • TalentLMS
emails
object[]

The emails of the user

Supported in
  • TalentLMS
email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

status
string

The lifecycle status of the user in the LMS

All possible enum values:
  • active
  • inactive
  • invited
  • suspended
  • deleted
  • unknown
Supported in
  • TalentLMS
role
string

The primary role of the user in the LMS

All possible enum values:
  • learner
  • instructor
  • admin
  • manager
  • other
Supported in
  • TalentLMS
phones
object[]

The phones of the user

number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

locale
string

The locale of the user, when available. Example: en-US

timezone
string

The timezone of the user, when available. Example: Asia/Kolkata

job_title
string

The user's job title, when available

organization
object

The organization or tenant the user belongs to, when available

id
string

The unique identifier for an organization

name
string

The name of the organization

manager
object

The user's manager, when available

id
string

The unique identifier for a user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

created_at
string · date-time

The date and time the user record was created

Supported in
  • TalentLMS
updated_at
string · date-time

The date and time the user record was last updated

Supported in
  • TalentLMS
custom_fields
object

Provider or customer specific fields mapped into a flexible key-value object

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.