Search Users

Search for one or more users.

Options

Field Definition Type Required
Return Choose from Single user and All matching users.

Single user - If selected, this card returns the first user that matches your search. Use this option when you're looking for a specific user.

All matching users - If selected, this card returns a collection of users that match your search. Use this option when you're looking for a filtered set of users.

Dropdown TRUE

Input

Field Definition Type Required
User
Name Name of the user. String FALSE
External ID

Unique external ID of the user.

String FALSE
Email Primary email address of the user. String FALSE
Phone Primary phone number of the user. String FALSE
Group Name of group which the user is associated. String FALSE
Details Additional miscellaneous details about the user.

For example, address.

String FALSE
Notes Notes about the user. String FALSE
Organization Name of organization with which a user is associated. String FALSE
Role Role of the user. Possible values are "end-user", "agent", or "admin". String FALSE
Tags Tags for a user. Only present if your account has user tagging available. List FALSE
Custom Fields A dynamically generated list of any custom fields associated with users. More on custom Fields. Various FALSE

Output

Field Definition Type
Users
User ID Unique identifier of the user. String
User URL A URL of the user. String
Name Name of the user. String
Email User's primary email address. String
Created At

Date and time when the object was created.

Time & Date
Updated At Time and date the user was updated. Time & Date
Timezone Time zone of the user; see Time Zone. String
IANA Timezone IANA time zone of the user. String
Phone Phone number of the user. String
Shared Phone Number If true, the phone number is shared. Boolean
Locale ID Language identifier of the user. Number
Locale Locale of the user; this is a BCP-47 compliant tag. String
Organization ID Identification code of the organization to which the user is associated. Number
Role Role of the user. Possible values are "end-user", "agent", or "admin". String
Verified? Identity of the user is verified. If true, user is verified. Boolean
External ID

Unique external ID of the user.

String
Tags Tags for a user. Only present if your account has user tagging available. String
Alias Alias displayed to end users. String
Active? If false, the user was deleted. Boolean
Shared? If the user is shared from a different Zendesk Support instance. If true, user is shared. Boolean
Shared Agent? If true, user is a shared agent from another support instance. Boolean
Last Login At Last time the user signed in. Date & Time
Two Factor Auth Enabled If true, two factor authentication is enabled. Boolean
Signature Signature of the user; only agents and admins have a signature. String
Details Additional miscellaneous details about the user, such as an address. String
Notes Notes about the user. String
Role Type Role type of the user. Number
Custom Role ID Custom role of the user. Number
Moderator? If true, the user has forum moderation capabilities. Boolean
Ticket Restriction Specifies tickets to which the user has access. String
Private Comments Only? If true, the user can only create private comments. Boolean
Restricted Agent? If true, the agent has restrictions. Boolean
Suspended? If true, the agent is suspended. Boolean
Chat Only? If true, the user is a chat-only agent. Boolean
Default Group ID Default group ID of the user. Number
Report CSV? If true, the user can access the CSV report. Boolean
Custom Fields A dynamically generated list of any custom fields associated with users. See About custom field types. Various

Related topics

Zendesk connector

About the elements of Okta Workflows

Zendesk REST API Documentation