Search users

Search for users in Lucidchart.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First Matching Record: Returns the first record that matches.

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

    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

Search By

Choose one of the following options to search for users:

  • External ID: External identifier of the User.

  • User Name: User name of the user.

  • Primary Email: Primary email address of the user.

  • Custom Filter: Provide a user API attribute name for flexible search.

Filtering on non-optimized attributes (such as roles or active) is resource-intensive and may result in slow processing or 504 Gateway Timeout errors.

 Dropdown FALSE

Input

Field Definition Type Required

User

External ID

This field displays when External ID is selected in the Search By field.

 Text FALSE

User Name

This field displays when User Name is selected in the Search By field.

 Text FALSE

Primary Email

This field displays when Primary Email is selected in the Search By field.

 Text FALSE

Custom Filter

This field displays when Custom Filter is selected in the Search By field.

 Text 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

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

ID

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

 Text

Emails

List of Objects

Email

The email of the user.

 Text

Is Primary

A boolean value that specifies whether this email address is the primary contact for the user account.

 True/False

User Name

The unique identifier for the user. In most configurations, this is the user's primary email address.

 Text

First Name

The first name of the user.

 Text

Last Name

The last name of the user.

 Text

Is Active

A boolean value that indicates the user's account status. Set to True to allow the user to sign in, or False to disable their access.

 True/False

Display Name

The user's name as it appears within the Lucid app interface. By default, this is typically set to the user's email address.

 Text

Roles

A list of administrative roles to assign to the user. These roles grant the user specific administrative permissions within Lucidchart.

 List of Text

Title

The title of the user.

 Text

Phone Numbers

List of Objects

Phone Number

The phone number of the user.

 Text

Type

The category of the phone number. For example, work, mobile, or home.

 True/False

Meta

Object

Resource Type

The type of resource.

 Text

Created At

The date and time when the user was created.

 Date & Time

Last Modified At

The date and time when the user record was most recently updated.

 Date & Time

Location

The URI of the user.

 Text

Groups

Object

ID

The ID of the group.

 Text

Display Name

The display name of the group.

 Text

Cost Center

The name of the cost center assigned to the user.

 Text

Organization

The name of the user's organization.

 Text

Division

The name of the user's division.

 Text

Department

The name of the user's department.

 Text

Manager ID

The unique identifier of the user's manager.

 Text

Raw Output

The raw output returned by the Lucidchart API.

 Object

Users

List of Objects

ID

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

 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