# CYPHER Learning - Search users action

The Search users action lets you retrieve a list of users in CYPHER Learning.

# Input

Input field Description
After Set this field to the last object ID to paginate results. This field can't be used with the Order field.
Include Enter a comma-separated list of relationships to include in the results.
Limit Specify the number of returned objects. The default is 10, and the maximum is 100.
Offset Use this field to paginate through small datasets. This field can be used with the Order field.
Order Specify the order in which to sort the returned objects.
Count Set this field to true to return the number of list items.
Filter Use this field to filter the results based on parameters you specify.

# Output

Output field Description
About The user's description.
Added by ID The ID of the user who added this user.
Archived Indicates whether the user is archived.
Archived at The timestamp when the user was archived, if applicable.
Archiver ID The ID of the user who archived this user.
Birthdate The user's birthdate.
City The city in the user’s address.
Country The country in the user’s address.
Custom fields Additional information about the user.
Email The user's email address.
Email sync Indicates how messages should be synced to email. Options include None, All, or Digest.
First login at The timestamp of the first login for this user account.
First name The user's first name.
Gender The user's gender.
ID The user's ID.
Instructor ID The instructor ID. This is typically used externally for the learning platform.
Job title ID The user’s job title ID.
Job title name The user's job title.
Joined at The timestamp when this user joined.
Language The user's language.
Last login at The timestamp of the last login for this user account.
Last login IP The IP address of the device used for the last login.
Last name The user's last name.
Learner ID The user's learner ID. This is typically used externally for the learning platform.
Mobile phone The user's mobile phone number.
Nickname The user's nickname.
Organization ID The ID of the user’s organization.
Password The user’s account password.
Phone The user's phone number.
Roles The user's roles.
SIS ID The SIS ID of the user.
SIS PID The SIS PID of the user.
SMS Email The email address used to send SMS messages.
SMS sync Indicates how messages should be synced to SMS or email. Options include None, All, or Digest.
State The state of the user’s address.
Street 1 The first line of the user’s address.
Street 2 The second line of the user’s address.
Street 3 The third line of the user’s address.
Tags The tags assigned to the user.
Time zone The user's time zone.
User ID The unique user ID of the user.
Year of graduation The user's graduation year.
ZIP The ZIP code in the user’s address.


Last updated: 5/21/2025, 5:22:32 AM

On this page