List Users

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

Options

Field

Definition

Type

Required

Include Removed?

Specify if removed users should be included.

Dropdown

TRUE

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 Stream matching records 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 to 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.

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

Number

Users

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

ID

Unique identifier of the user.

Text

Account ID

Unique identifier for the account.

Text

External ID

Unique external ID of the user.

Text

Email

Email address of the user.

Text

Given Name

First name of the user.

Text

Surname

Family name of the user.

Text

Familiar Name

Locale-dependent name. Possibilities include the Given Name, or a combination of the Given Name and the Surname.

Text

Display Name

A name used to represent the Dropbox for Business account of the user.

Text

Abbreviated Name

An abbreviated version of the user's name. For most locales, this is the user initials.

Text

Status

The membership status for the user:

  • Active

  • Invited

  • Suspended

  • Removed

String

Role

The role the user has in the group:

  • team_admin

  • user_management_admin

  • support_admin

  • member_only

Text

Groups

The groups that the user belongs to.

Text

Raw Output

Raw payload returned from the API.

Object

Related topics

Dropbox for Business connector

Workflow elements

Dropbox Developer Documentation