Users API

Tags: Flow

A user object creates and acts on other objects.  When multiple user records are associated with an individual, due to differences in email or variations in a name for example, user records can be merged under a single apex user record.

Who can use this?

 Core
Plus
 
   

 

Supported request

Get a collection of users:

https://flow.pluralsight.com/v3/customer/core/users/

Fields

NameTypeDescription
iddoubleUser's unique identifier.
id__indoubleMultiple user_id values separated by commas.
namestringUser’s name.
name__icontainsstringUser's name contains a specific string.
name__startswithstringUser's name starts with a specific string.
emailstringUser's email address.
email__icontainsstringEmail contains a specific string.
email__startswithstringEmail starts with a specific string.
hidden_from_reportsbooleanReturns true to indicate the user's record is excluded.
org_iddoubleOrg's unique identifier
created_atdoubleDate and time the user record was created.
created_at__gtstringRecords greater than date or datetime (yyyy-mm-dd hh:mm:ss).
created_at__gtestringRecords greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss).
created_at__ltstringRecords less than date or datetime (yyyy-mm-dd hh:mm:ss).
created_at__ltestringRecords less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss).
teamsstringAn array of TEAMS associated with the User. Filter-traversable object.
has_loginbooleanReturns true if User has a login.
pending_invitationbooleanReturns true if the user has been invited to the account but has not signed in.
alias_countdoubleAlias count.
alias_count__gtdoubleAlias count is greater than the input number.
alias_count__gtedoubleAlias count is greater than or equal the input number.
alias_count__ltdoubleAlias count is less than the input number.
alias_count__ltedoubleAlias count is less than or equal to the input number.
last_activity_atstringUser's last activity at date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__gtstringUser's last activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__gtestringUser's last activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__ltstringUser's last activity less than date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__ltestringUser's last activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_atstringUser's first activity at date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__gtstringUser's first activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__gtestringUser's first activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__ltstringUser's first activity less than date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__ltestringUser's first activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
avatar URLstringExternal URL for user's avatar image.
avatar_existsbooleanReturns true if an avatar exists for a user.
invitation_idstringUnique identifier for invitation.
login_enabledbooleanReturns true if user's login is enabled.
is_samlbooleanReturns true if the user's login is controlled via SAML Integration.
orderingstringValid ordering fields are id, name, email, hidden_from_reports, has_login and alias_count.
searchstringA search term

Example response

back to top


If you need help, please contact Pluralsight Support.