Skip to main content

List Groups

UiPath.Smartsheet.Activities.Groups.ListGroups

Uses the Smartsheet List Org Groups API to get a list of groups and supports paging options.

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 Groups 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.

In the Body of the Activity​

  • Include All - If you want to include all records. Enter a boolean or boolean variable. If true, include all results, that is, do not paginate.
  • Page - Which page to return. Enter a Int32 or Int32 variable. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.
  • Page Size - The maximum number of items to return per page. Enter a Int32 or Int32 variable. Unless otherwise stated for a specific endpoint, defaults to 100.
  • Groups - The groups to return. Enter a Group[] variable.
  • Page Info - Paging information to use for subsequent calls. 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.