List groups

List all groups in the Lucidchart environment.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First 100 Records: Returns the first 100 matching records.

  • Stream Records: Passes all matching user records from your parent flow to a helper flow.

    Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

 Dropdown FALSE

Input

Field Definition Type Required

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

Record Limit

Specify the number of records to stream.

  • 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 500000.

  • The valid range is 1 to 500000.

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

 Number FALSE

Output

Field Definition Type

Result

Groups

List of Objects

ID

The ID of the Lucid group. For example: lucid-group-1234, where 1234 is the ID.

 Text

Display Name

The display name of the group.

 Text

Members

List of Objects

ID

The ID of the group member.

 Text

Location

The URI of the group member.

 Text

User Name

The display name of the group member.

 Text

Meta

Object

Resource Type

The type of resource. The value is always Group.

 Text

Created At

The date and time when the group was created.

 Date & Time

Last Modified

The date and time when the group details were most recently updated.

 Date & Time

Version

The version ID of the group.

 Text

Location

The URI of the group.

 Text

Raw Output

The raw output returned by the Lucidchart API.

 Object

Records Streamed

The number of streamed records.

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

 Number