Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
users

Fetch user

Returns the matching user.

get/users/{user_id}

Response

Successful response

idinteger

Unique identifier for the resource instance.

first_namestring

First name.

last_namestring

Surname.

display_namestring

Display name.

emailstring

Email address.

user_type_id0 | 1 | 2 | 3 | 4 | 5 | 7 | 8

A numeric code that specifies the user's permission level.

Permission Level Codes:

CodePermission level
0None
1Resourcing Administrator
2Portfolio Editor
3Portfolio Reporter
4Portfolio Viewer
5Contractor
7People Scheduler
8Project Editor

Note: Unlisted values you may encounter are for internal purposes or future use.

You may set the user_type_id to any value except 1 (Resourcing Administrator). To make a user a Resourcing Administrator, use the app.

billableboolean

true if the user is billable; false otherwise.

hire_datestring date-time

Date (in UTC) the user was hired.

termination_datestring date-time nullable

Date (in UTC) the user's employment was terminated.

mobile_phonestring

Cell phone number.

office_phonestring

Office phone number.

archivedboolean

true if the user has been archived; false otherwise.

Note:

  • An account owner cannot be archived.
  • An archived user can be unarchived.
archived_atstring date-time nullable

Date the user was archived.

account_ownerboolean

true if the user is the account owner; false otherwise.

invitation_pendingboolean

true if an invitation is pending for the user; false otherwise.

guidstring

Globally Unique Identifier for the user.

employee_numberstring

The user's employee number.

rolestring

The user's role.

disciplinestring

The user's field.

locationstring

The user's geographic location.

typestring

The object type.

license_type'licensed' | 'managed_resource'

The user's license type.

billability_targetnumber float

The percentage of the resource's available time (based on working days/hours settings and part-time availability) that the resource is expected to have work assigned. It's on utilization reports to compare with the actual percentage.

billrateinteger

The currency amount that a resource is "billed out" to clients on an hourly basis. Bill rates are inherited from the bill rate matrix in Account Settings, but can be overridden in specific resource profiles. Bill rates are considered in Time & Fees and Budget reports.

has_loginboolean

true if the user has a setup login; false otherwise.

login_type'smar' | 'saml' | 'default'

The user's authentication method.

Possible values:

  • smar - Sign in with Smartsheet
  • saml - Security Assertion Markup Language
  • default - Username/password authentication
thumbnailstring

A URL to the user's profile image.

approver_user_idsinteger[]

IDs of other users who approve this user's timesheets.

approvee_user_idsinteger[]

IDs of other users whose timesheets this user approves.

last_login_timestring date-time

Date

created_atstring date-time

Date

updated_atstring date-time

Date

Example response

{
  "id": 1234567,
  "first_name": "Jane",
  "last_name": "Doe",
  "display_name": "Jane Doe",
  "email": "jane.doe@smartsheet.com",
  "billable": true,
  "hire_date": "2021-07-09T00:00:00Z",
  "guid": "96d769c7-1b4e-4b07-8baf-5ed6f2b915aa",
  "role": "Senior",
  "discipline": "Program Management",
  "location": "Seattle",
  "type": "User",
  "license_type": "licensed",
  "billability_target": 100,
  "billrate": -1,
  "has_login": true,
  "login_type": "smar",
  "approver_user_ids": [
    123,
    456,
    789
  ],
  "approvee_user_ids": [
    222,
    333,
    444
  ],
  "last_login_time": "2025-02-17T19:12:36Z",
  "created_at": "2024-11-13T20:38:10Z",
  "updated_at": "2024-11-13T20:38:10Z"
}