User

A user is a person or entity that uses the Contractors Cloud system.

Attributes

Attribute	Type	Description
id	Integer	The unique id of the user.
tenant_id	Integer	The id of the Tenant the user belongs to.
default_company_id	Integer	The id of the Company the user has set as their default.
user_level_id	Integer	The id of the UserLevel.
email	String	The user's email.
username	String	The user's user name.
first_name	String	The user's first name.
last_name	String	The user's last name.
initials	String	The user's initials.
title	String	The user's title.
color	String	A hexadecimal color for the user.
timezone	String	The user's timezone.
started_at	Date	A date that defines when the user started their employment.
terminated_at	Date	A date that defines when the user's employment was terminated.
is_active	Boolean	Defines if the user's account is active.
phone_home	String	The user's home phone number.
phone_cell	String	The user's cell phone number.
phone_direct	String	A direct phone number for the user.
phone_direct_ext	String	A direct phone number extension for the user.
address_street	String	The user's street address.
address_city	String	The city for the user's address.
address_state	String	The state abbreviation for the user's address.
address_zip	String	The post code for the user's address.
avatar_thumbnail_url	String	A full URL to the user's avatar.

Allowed includes

Relation	Type	Description
tenant	Tenant	The Tenant the User belongs to.
user_level	UserLevel	The UserLevel that corresponds to the User.
default_company	Company	The User's default Company.

Allowed filters

Name	Type	Description
id	Integer	Filter users by their id.
email	String	Filter users by their email.
employed	Boolean	Filter users by their employment status.
in_company	Array|Integer	Filter users to those who belong to the given Company ids.
status	Boolean	Filter users by their status (active / inactive).
search	String	Filter users by a specific search term.

Allowed sorts

Name	Description
first_name	Sort users by their first name
last_name	Sort users by their last name
email	Sort users by their email
status	Sort users by their account status