Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
users

Get current user

Gets the current user.

For System Admins, the following UserProfile attributes are included in the response:

  • customWelcomeScreenViewed (only included when an Enterprise user has viewed the <a href="https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only" target="_blank" rel="noopener noreferrer">Custom Welcome Screen</a>)
  • lastLogin (only included if the user has logged in)
  • sheetCount (Sunset) - The sheetCount attribute now holds the value -1 and is included only if the retrieved user's status is ACTIVE.
get/users/me

Query parameters

include'groups'

When specified with a value of 'groups', response includes an array of groups (groupId, name, and description only) that the user is a member of.

Headers

Authorizationstring

API Access Token used to authenticate requests to Smartsheet APIs.

Response

IndexResultUnknownPages object containing a UserProfile object.

idnumber

Current user's ID.

adminboolean

Indicates whether the user is a system admin (can manage user accounts and organization account).

companystring

User's company.

customWelcomeScreenViewedstring date-time

Timestamp of viewing an Enterprise Custom Welcome Screen by the current user.

departmentstring

User's department.

emailstring

Current user's primary email address.

firstNamestring

Current user's first name.

groupAdminboolean

Indicates whether the user is a group admin (can create and edit groups).

jiraAdminboolean

Indicates whether the user is a JIRA admin.

lastLoginstring date-time

Last login time of the current user.

lastNamestring

Current user's last name.

licensedSheetCreatorboolean

Indicates whether the user is a licensed user (can create and own sheets).

localestring

Current user's locale (see ServerInfo).

mobilePhonestring

User's mobile phone number.

resourceViewerboolean

Indicates whether the user is a resource viewer (can access resource views).

rolestring

User's role.

salesforceAdminboolean

Indicates whether the user is a Salesforce admin.

salesforceUserboolean

Indicates whether the user is a registered Salesforce user.

sheetCountnumber

SUNSET - The sheetCount attribute now holds the value -1 and is included only if the retrieved user's status is ACTIVE.

timeZonestring

Current user's time zone ID.

titlestring

User's title.

workPhonestring

User's work phone number.

Example response

{
  "id": 48569348493401200,
  "account": {
    "id": 122454719915908,
    "name": "Smartsheet Org"
  },
  "admin": true,
  "alternateEmails": [
    {
      "id": 8150532427671428,
      "confirmed": true,
      "email": "johnathan.doe@smartsheet.com"
    }
  ],
  "company": "Smartsheet",
  "customWelcomeScreenViewed": "2020-08-25T12:15:47Z",
  "department": "Engineering",
  "email": "john.doe@smartsheet.com",
  "firstName": "John",
  "groupAdmin": true,
  "jiraAdmin": true,
  "lastLogin": "2020-10-31T12:15:47Z",
  "lastName": "Doe",
  "licensedSheetCreator": true,
  "locale": "en_US",
  "mobilePhone": "555-867-5309",
  "profileImage": {
    "imageId": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD",
    "height": 1050,
    "width": 1050
  },
  "resourceViewer": true,
  "role": "Software Developer",
  "sheetCount": -1,
  "timeZone": "US/Pacific",
  "title": "Senior Software Engineer",
  "workPhone": "844-324-2360",
  "data": [
    {
      "id": 4583173393803140,
      "name": "Group 1",
      "description": "My group",
      "owner": "john.doe@smartsheet.com",
      "ownerId": 2331373580117892
    }
  ]
}