List Groups

Lists the groups within a team on your Dropbox for Business instance.

Options

Field

Definition

Type

Required
Result Set

Specify how you want to have the results returned. Select either the First 200 Records or Stream Records.

Dropdown

 TRUE

To learn how to use the Stream Records option and set up a helper flow to return a large number of records, see Set up the stream matching option with a helper flow.

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.

This field displays when Stream Records is selected from the Result Set field.

 Flow TRUE
List Criteria
Record Limit

Specify the number of records to stream.

  • When the Record Limit field is set to 0, returns a 400 Bad Request error.

  • When the Record Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Record Limit field is empty or not selected, all records are streamed.

  • Default value is 1 million.

  • Valid range is from 1 up to 1 million.

Appears when Stream Records is selected from the Result Set option.

 Number FALSE

Output

Field Definition Type
Records Streamed

Number of records streamed in a streaming flow.

Appears when Stream Records is selected from the Result Set option.

 Number
Groups This field appears when First 200 Records is selected from the Result Set field.
Name

Name of the group.

 String
ID Unique identifier of the group. String
External ID

Unique external ID of the group.

 String
Management Type

Specifies how the group is managed.

  • Company Managed - administrators are responsible for adding and removing group members. This is the default.

  • User Managed - selected users can rename the group, add or remove members, and existing members can choose to leave the group

 String
Member Count Number of members in the group. String

Related topics

Dropbox for Business connector

Elements of Workflows

Dropbox Developer Documentation