List Groups

List all groups in Smartsheet.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • 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

Input

Field Definition Type Required

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

Groups

ID

Unique ID of the group.

Text

Name

Group name.

Text

Description

Group description.

List of Text

Owner Email

Email address of the group owner.

Text

Owner ID

User ID of the group owner.

Text

Created At

Date and time when the group was created.

Date & Time

Updated At

Date and time when the group was updated.

Date & Time

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