Users

Retrieves a collection of users, including their details and roles.

Table-Specific Information

SELECT

The driver uses the Monday API to process some of the filters. The driver processes other filters client-side within the driver.

Id supports the '=','IN' comparison operators.
Email supports the '=','IN' comparison operators.
IsGuest supports the '=' comparison operator.
IsPending supports the '=' comparison operator.
NonActive supports the '=' comparison operator.
TeamsIds supports the '=','IN' comparison operators when filtering for users that belong to a single team.

For example, the following queries are processed server side:

SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE Id = '27278379'
SELECT * FROM Users WHERE Id IN ('27278379', '27278377')
SELECT * FROM Users WHERE Email = '[email protected]'
SELECT * FROM Users WHERE Email IN ('[email protected]', '[email protected]')
SELECT * FROM Users WHERE TeamsIds = '915408'

UPDATE

The following inputs can be used in UPDATE statements (Note that Email changes require user verification to complete):

Name, Phone, Birthday, Email, JoinDate, Location, MobilePhone, Title, Department, BypassConfirmationForClaimedDomains, RoleName, RoleId.

UPDATE Users SET Name = 'AnotherName' WHERE Id = '5549166043'
UPDATE Users SET RoleName = 'ADMIN' WHERE Id = '5549166043'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The unique identifier for the user, used to reference the user across the system.
TeamsIds	String	False		A list of unique identifiers for the teams the user belongs to, helping to track user membership within teams.
Name	String	False		The full name of the user, used for identification and display purposes.
Phone	String	False		The user's primary phone number, used for contact and verification.
Birthday	Date	False		The user's birthdate, which can be used for age verification or personalization.
CurrentLanguage	String	False		The language currently selected by the user for their interface preferences.
CountryCode	String	False		The two-letter country code of the user's location, based on their country of residence.
CreatedAt	Datetime	False		The timestamp for when the user account was created, used for tracking account age and activity.
LastActivity	Datetime	False		The most recent date and time when the user was active, providing insight into user engagement.
Email	String	False		The user's email address, used for communication, notifications, and account recovery.
Enabled	Bool	False		Indicates whether the user account is currently active and able to perform actions.
IsAdmin	Bool	False		Indicates if the user has administrative privileges and can manage account settings and users.
IsGuest	Bool	False		Indicates if the user has guest access, typically with restricted permissions.
IsPending	Bool	False		Indicates whether the user account is pending approval or activation.
IsVerified	Bool	False		Indicates if the user has verified their email address, confirming their identity.
IsViewOnly	Bool	False		Indicates if the user has view-only access, meaning they can view but not modify data.
JoinDate	Date	False		The date when the user first joined the account, useful for understanding user tenure.
Location	String	False		The geographic location of the user, which may affect settings like time zone or language.
MobilePhone	String	False		The user's mobile phone number, used for notifications or secondary contact.
PhotoOriginal	String	False		The URL for the user's photo in its original size, typically used in larger display contexts.
PhotoSmall	String	False		The URL for the user's photo in a smaller size (150x150), suitable for smaller profile views.
PhotoThumb	String	False		The URL for the user's thumbnail photo (100x100), used in list views and smaller displays.
PhotoThumbSmall	String	False		The URL for the user's small thumbnail photo (50x50), typically used for icons or minimal views.
PhotoTiny	String	False		The URL for the user's tiny photo (30x30), used for extremely small icons or visual references.
TimeZoneIdentifier	String	False		The user's time zone identifier, used for scheduling and displaying time-related information.
Title	String	False		The user's job title or designation, providing context about their role within the organization.
Url	String	False		The URL to the user's profile page, typically used for linking to the user's detailed information.
UtcHoursDiff	Int	False		The difference in hours between the user's local time and UTC, used for adjusting timestamps and scheduling.
SignUpProductKind	String	False		The product or service that the user initially signed up for, helping to categorize user plans.
AccountFirstDayOfTheWeek	String	False		The day of the week (Sunday or Monday) designated as the start of the week for the account, affecting calendar views.
AccountId	String	False		The unique identifier for the account to which the user belongs, used to associate users with specific accounts.
AccountLogo	String	False		The URL for the account's logo, displayed in the UI to represent the account.
AccountName	String	False		The name of the account, used to identify the account in the system.
AccountPlanMaxUsers	Int	False		The maximum number of users allowed under the current account plan, indicating the plan's user capacity.
AccountPlanPeriod	String	False		The duration of the account's plan (for example, monthly, annually), which helps track billing cycles.
AccountPlanTier	String	False		The tier of the account's subscription plan (for example, Basic, Premium), defining the features available.
AccountPlanVersion	Int	False		The version number of the current plan, useful for tracking plan changes over time.
AccountShowTimelineWeekends	Bool	False		Indicates whether weekends are included in the account's timeline views.
AccountSlug	String	False		A URL-friendly version of the account name, typically used for the account's web address or identifier.
AccountTier	String	False		The account's subscription tier, which determines available features and limitations.
AccountCountryCode	String	False		The two-letter ISO 3166 country code for the account's registered country, helping to localize settings.
AccountSignUpProductKind	String	False		The product or service the account initially signed up for, which may determine the account's default settings.
AccountProducts	String	False		A list of active products or services associated with the account, showing the account's current offerings.
OutOfOfficeActive	Bool	False		Indicates whether the user's out-of-office status is currently active, affecting their availability.
OutOfOfficeDisableNotifications	Bool	False		Indicates if notifications are disabled while the user is out of office.
OutOfOfficeStartDate	Date	False		The date when the user's out-of-office status began, marking the start of their absence.
OutOfOfficeEndDate	Date	False		The date when the user's out-of-office status ends, marking the return to active status.
OutOfOfficeType	String	False		The type of out-of-office status, such as vacation or personal leave, used to specify the reason for absence.
NonActive	Bool	False		Indicates whether non-active users should be included in account queries, useful for generating reports on inactive users.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.