Skip to main content
GET
Get user

Authorizations

Authorization
string
header
required

Authenticate with an API access token in the Authorization header: Authorization: Bearer <token>. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.

Path Parameters

userId
string
required

The id of the user, or the literal me to reference the currently authenticated user.

Query Parameters

include
string

Comma-separated related resources to embed. Allowed: user_level, default_company, project_list_setting, extended_properties.

append
string

Comma-separated computed attributes to include. Allowed: home_page, project_page, is_password_set, needs_onboarding, two_factor_setup_status.

Response

The requested user.

id
integer

The user's unique identifier.

Example:

1159

tenant_id
integer

The id of your organization's account.

Example:

1

default_company_id
integer

The id of the company selected as this user's default company. References a company in your organization.

Example:

6

user_level_id
integer | null

The id of the user's permission level (role), which determines the pages, reports, and actions the user can access. Can be null if no level has been assigned.

Example:

4

email
string | null

The user's email address, used to log in. Kept in sync with username — the two are always identical.

Example:

"jane.doe@example.com"

username
string

The user's login username. Kept in sync with email — the two are always identical.

Example:

"jane.doe@example.com"

first_name
string

The user's first name.

Example:

"Jane"

last_name
string | null

The user's last name. Can be null for legacy user records.

Example:

"Doe"

initials
string | null

The user's initials, typically derived from their first and last name. Can be null if not set.

Example:

"JD"

title
string | null

The user's job title within your organization. Can be null if not set.

Example:

"Operations Manager"

color
string | null

Hex color code used to visually represent the user throughout the app, for example on calendar and schedule views. Can be null if not set.

Example:

"#0a7d2c"

timezone
string | null

The IANA time zone identifier (for example America/Chicago) used to display dates and times for this user. Can be null if not set.

Example:

"America/Chicago"

started_at
string<date> | null

The date the user started with your organization, formatted as YYYY-MM-DD. Can be null if not recorded.

Example:

"2019-06-03"

terminated_at
string<date> | null

The date the user was terminated, formatted as YYYY-MM-DD. Null while the user remains active.

Example:

null

is_active
boolean

Whether the user's account is active. Inactive users cannot authenticate.

Example:

true

phone_home
string | null

The user's home phone number. Null if not provided.

phone_cell
string | null

The user's cell phone number. Null if not provided.

Example:

"(555) 100-2048"

phone_direct
string | null

The user's direct work phone number. Null if not provided.

phone_direct_ext
string | null

Extension for the user's direct phone number. Null if not applicable.

address_street
string | null

The street portion of the user's address. Null if not provided.

address_city
string | null

The city portion of the user's address. Null if not provided.

address_state
string | null

The two-letter state or province code for the user's address. Can be null if not provided.

Example:

"WI"

address_zip
string | null

The postal code for the user's address. Null if not provided.

tax_id
string | null

The user's tax identification number, used for subcontractor reporting. Null if not provided.

employment_type
enum<integer>

How the user is employed by your organization. 0 = not set, 1 = employee, 2 = 1099/vendor (independent contractor).

Available options:
0,
1,
2
Example:

1

description
string | null

Free-form notes about the user. Null if not set.

theme
string | null

The UI color theme the user has selected for the app (for example charcoal). Can be null if the user hasn't chosen one.

Example:

"charcoal"

avatar_thumbnail_url
string | null

URL of the user's avatar thumbnail image. Can be null if the user hasn't uploaded a profile photo.

Example:

"https://cdn.contractorscloud.com/users/1159/thumb.jpeg"

auto_insured_at
string<date> | null

The date the user's auto insurance was last verified, formatted as YYYY-MM-DD. Null if not tracked.

game_mode_daily_high_score
integer

The user's high score for the current day in the app's Game Mode feature.

Example:

0

game_mode_total_score
integer

The user's all-time cumulative score in the app's Game Mode feature.

Example:

0