Objects

User Object

id
number

User Id.

admin
boolean
Default: false

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

customWelcomeScreenViewed
string <date-time>

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

email
string <email>

User's primary email address.

firstName
string

User's first name.

groupAdmin
boolean
Default: false

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

lastLogin
string <date-time>

Last login time of the current user.

lastName
string

User's last name.

licensedSheetCreator
boolean
Default: false

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

name
string

User's full name (read-only).

object
resourceViewer
boolean
Default: false

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

sheetCount
number

The number of sheets owned by the current user within the organization account.

status
string

User status, set to one of the listed enum values.

Enum: "ACTIVE" "DECLINED" "PENDING"
{
  • "id": 48569348493401200,
  • "admin": true,
  • "customWelcomeScreenViewed": "2020-08-25T12:15:47.000Z",
  • "email": "jane.doe@smartsheet.com",
  • "firstName": "Jane",
  • "groupAdmin": true,
  • "lastLogin": "2020-10-04T18:32:47.000Z",
  • "lastName": "Doe",
  • "licensedSheetCreator": true,
  • "name": "Jane Doe",
  • "profileImage": {
    },
  • "resourceViewer": true,
  • "sheetCount": 42,
  • "status": "ACTIVE"
}

User Profile Object

id
number

Current user's Id.

object
admin
boolean

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

object
company
string

User's company.

customWelcomeScreenViewed
string <date-time>

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

department
string

User's department.

email
string

Current user's primary email address.

firstName
string

Current user's first name.

groupAdmin
boolean

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

jiraAdmin
boolean

Indicates whether the user is a JIRA admin.

lastLogin
string <date-time>

Last login time of the current user.

lastName
string

Current user's last name.

licensedSheetCreator
boolean

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

locale
string

Current user's locale (see Server Information).

mobilePhone
string

User's mobile phone number.

object
resourceViewer
boolean

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

role
string

User's role.

salesforceAdmin
boolean

Indicates whether the user is a Salesforce admin.

salesforceUser
boolean

Indicates whether the user is a registered Salesforce user.

sheetCount
number

The number of sheets owned by the current user within the organization account.

timeZone
string

Current user's time zone Id.

title
string

User's title.

workPhone
string

User's work phone number.

{
  • "id": 48569348493401200,
  • "account": {
    },
  • "admin": true,
  • "alternateEmails": {
    },
  • "company": "Smartsheet",
  • "customWelcomeScreenViewed": "2020-08-25T12:15:47.000Z",
  • "department": "Engineering",
  • "email": "john.doe@smartsheet.com",
  • "firstName": "John",
  • "groupAdmin": true,
  • "jiraAdmin": true,
  • "lastLogin": "2020-10-31T12:15:47.000Z",
  • "lastName": "Doe",
  • "licensedSheetCreator": true,
  • "locale": "en_US",
  • "mobilePhone": "555-867-5309",
  • "profileImage": {
    },
  • "resourceViewer": true,
  • "role": "Software Developer",
  • "salesforceAdmin": false,
  • "salesforceUser": false,
  • "sheetCount": 42,
  • "timeZone": "US/Pacific",
  • "title": "Senior Software Engineer",
  • "workPhone": "844-324-2360"
}

Account Object

id
number

Account Id.

name
string

Account name.

{
  • "id": 122454719915908,
  • "name": "Smartsheet Org"
}

AlternateEmail Object

id
number

AlternateEmail Id.

confirmed
boolean

Indicates whether the alternate email address has been confirmed.

email
string

User's alternate email address.

{
  • "id": 8150532427671428,
  • "confirmed": true,
  • "email": "johnathan.doe@smartsheet.com"
}
➔ Next to Methods