Search Users

Search a user in Freshservice.


Field Definition Type Required
Result Set Choose one of the following options to display your search results:
  • First Matching User: returns a single user record

  • Stream Matching Users: pass all matching user records from your parent flow to a helper flow; a Streaming input section will be added to the card from which you can select a helper flow for streaming and adding custom extensible fields.

Dropdown TRUE

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


Field Definition Type Required
Filter By Filter users by Email, Phone, or Mobile. Dropdown TRUE
Value The value to match to the selected filter type.

For example, match all Phone entries that have the value 5555551234.

Only enter the digits of phone numbers. Don't enter any other symbols or special characters such as parentheses (), plus signs (+), or dashes (-).

String TRUE
State Filter users by their state: All, Verified, Unverified, Deleted, or Blocked.

Deleted users are not returned when the filter is set to All. Choose Deleted to search deleted users.

Dropdown TRUE
Flow Click Choose Flow to browse and select a helper flow to which 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.



Field Definition Type
Active Indicates if the user is active. Boolean
First Name

First name of the user.

Last Name Last name of the user. String
Address User's address. String
Created At

Date and time when the object was created.

Date & Time
Description Description of the user. String
Email User's email address. String
Secondary Emails Additional emails associated with the user. List of Text
External ID

Unique external ID of the user.

User ID

Unique identifier of the user.

Has Logged In True if the user has logged in to Freshservice; otherwise False. Boolean
Reporting Manager ID User ID of the user's reporting manager. String
Helpdesk Agent Indicates if the user is a helpdesk agent. Boolean
Job Title User's job title. String
Language User's language. String
Mobile User's mobile number. String
Phone User's phone number. String
Time Zone User's time zone. String
Time Format User's time format (12H or 24H). String
Location ID Unique ID for the location associated with the user. String
Updated At Date and time that the user was last updated. Date & Time
Department Names List of department names associated with the user. List of Text
Department IDs Unique IDs of the departments associated with the requester. List of Numbers
View All Associated Department Tickets True if the requester is allowed to view tickets filed by other members of the department; otherwise False. Boolean
Custom Fields Custom fields containing additional user information specific to your organization. Various

Related topics

Freshservice connector

Workflow elements

Freshservice API documentation