Retrieves a list of all users associated with your company.
Table Specific Information
Query the Users table. The adapter will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the adapter.
- Id, GroupId, Username, PayrollId and EmployeeNumber fields support the '=' and IN operators.
- FirsName and LastName fields support the '=' and LIKE operators.
- Active field supports the '=' operator.
- LastModified field supports the <=,<,>=,>,= operators.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE Active = false SELECT * FROM Users WHERE LastModified > '2019-01-01 18:30' AND GroupId IN (1,2,3) SELECT * FROM Users WHERE FirstName LIKE 'josh%' and PayrollId IN ('562348', '45457')
|Id [KEY]||Integer||Id of this user.|
|FirstName||String||First name of user.|
|LastName||String||Last name of user.|
|DisplayName||String||The display name of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null display_name value (users who have not setup their display_name will return empty string)|
|Pronouns||String||The personal pronouns of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null pronouns value (users who have not setup their pronouns will return empty string)|
|GroupId||Integer||Id of the group this user belongs to.|
|Active||Boolean||Whether this user is active. If false, this user is considered archived.|
|EmployeeNumber||Integer||Unique number associated with this user.|
|Salaried||Boolean||Indicates whether or not the user is salaried.|
|Exempt||Boolean||Indicates whether or not the user is eligible for overtime pay.|
|Username||String||Username associated with this user.|
|String||Email address associated with this user.|
|EmailVerified||Boolean||Indicates whether or not the user is eligible for overtime pay.|
|PayrollId||String||Unique company wide string associated with this user. Usually used for linking with external systems.|
|HireDate||Date||Date on which this user was hired.|
|TermDate||Date||Date on which this user was terminated.|
|LastModified||Datetime||Date/time when this user was last modified.|
|LastActive||Datetime||Date/time when this user last performed any action.|
|Created||Datetime||Date/time when this user was created|
|ClientUrl||String||Client account url identifier associated with this user.|
|CompanyName||String||Client account name identifier associated with the user.|
|ProfileImageUrl||String||Url identifier associated with this user's profile image.|
|MobileNumber||String||Mobile phone number associated with this user.|
|PTOBalances||String||List of jobcode identifiers and their respective PTO balances for this user (in seconds).|
|SubmittedTo||Date||The latest date this user has submitted timesheets up to.|
|ApprovedTo||Date||The latest date this user has had timesheets approved to.|
|ManagerOfGroupIds||String||The group ids that this user manages.|
|RequirePasswordChange||Boolean||Whether this user will be required to change their password on their next login.|
|LoginPIN||Integer||Used for logging into a Kiosk or similar.|
|PayRate||Double||The rate of pay associated with this user. Only visible to admins.|
|PayInterval||String||The timeframe to which this user's pay rate applies, either 'hour' or 'year'. Only visible to admins.|