Users Object

---

id

string

REQUIRED · 

The unique identifier for the user

first_name

string

The user's first name

last_name

string

The user's last name

name

string

The user's name

username

string

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

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

status

string

The lifecycle status of the user in the LMS

All possible enum values:

• active
• inactive
• invited
• suspended
• deleted
• unknown

role

string

The primary role of the user in the LMS

All possible enum values:

• learner
• instructor
• admin
• manager
• other

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

updated_at

string · date-time

The date and time the user record was last updated

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.