List Users

UiPath.Smartsheet.Activities.Users.ListUsers

Uses the Smartsheet List Users API to get a list of users.

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the Smartsheet Application Scope activity to your project.
3. Add the List Users activity inside the Smartsheet Application Scope activity.
4. Create and enter values for Output properties.
5. Create and enter an ResponseStatus variable for the Output property.

You can enter filter information as optional parameters as needed.

In the Body of the Activity

• Email Address - The email addresses of the users to retrieve. Enter a String[] or String[] variable.
• Include Options -Options to include while fetching users. Enter a ListUserInclusion[] or ListUserInclusion[] variable. Only available for Admins.
• Include All - When true will include all records. Enter a Boolean or Boolean variable.
• Page - Which page to return. Enter a Int32 or Int32 variable. If not specified, the default value is 1.
• Page Size - The maximum number of items to return per page. Enter a Int32 or Int32 variable. If not specified, the default value is 100.
• Users - The users returned. Enter a User[] variable.
• Page Info - Enter a PageInfo variable.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable.