Search Users

Search for users in Smartsheet.

Options

Field Definition Type Required
Result Set Choose one of the following options to display your search results:
  • First Matching Record: returns the first matching records.
  • First 100 Matching Records: returns the first 100 matching records.
  • Stream Matching Records: passes all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.
 Dropdown TRUE
Tip

To learn how to return a large number of records, see Stream matching records with a helper flow.

Input

Field Definition Type Required
Search
Emails List of email addresses that is used to filter the results. List of Strings TRUE
List Criteria
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, the stream returns no records.

  • When the Limit field is set to greater than 0, the stream returns up to the maximum number specified.

  • When the Limit field is empty, null, or not selected, the stream returns all records.

  • The default value is 10000000 (10 million).

  • The valid range is 0 to 10000000.

This field appears when you select Stream Matching Records from the Result Set option.

 Number FALSE
Streaming
Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

 Flow TRUE

Output

Field Definition Type
Result
Users List of Objects
ID Unique ID of the current user. String
Email Primary email address of the current user. String
Is Admin? True if the user is an admin who can manage user accounts and organization accounts (can create and edit users); otherwise, False. Boolean
Custom Welcome Screen Viewed Timestamp of viewing an Enterprise Custom Welcome Screen by the current user. Date and Time
First Name First name of the current user. String
Last Name Last name of the current user. String
Name Full name of the user (read only). String
Is Group Admin? True if the user is a group admin (can create and edit groups); otherwise, False. Boolean
Profile Image ID Image ID. String
Last Login Last login time of the current user. Date and Time
Is Licensed Sheet Creator? True if the user is a licensed user (can create and own sheets); otherwise, False. Boolean
Is Resource Viewer? True if the user is a resource viewer (can access resource views); otherwise, False. Boolean
Sheet Count Number of sheets owned by the current user within the organization account Number
Status User status, set to one of the following values:

  • ACTIVE

  • DECLINED

  • PENDING

 String
Records Streamed

Number of records streamed in a streaming flow.

This field appears when you select Stream Matching Records from the Result Set option.

 Number

Related topics

Smartsheet connector

Workflow elements

Smartsheet API Reference