Data in the end users, team members, group, and organization objects can be searched on their respective pages.
This article covers the following topics:
About searching
At the top of each page related to managing and organizing users, there is a search bar. Searches on these pages are limited in scope to the page. That means a search on the Team members page only returns team members that meet the search criteria and, likewise, a search on the Organizations page only returns organizations that meet the search criteria.
If you search using the global search tool, you need to use the type
keyword if you want to restrict results to specific types of data. If you don't, your search results will include matches from the data in your Zendesk Support instance.
type:organization tags:premium
For more information about using search, see Searching the data in your Zendesk. All the user data properties you can search are described in the tables below. All of the searchable data in your Zendesk Support instance (including ticket data) is described in Zendesk search reference.
The user and type keywords
To search for a user's profile data, you have the following two options.
user
keyword:
user:amyOr, using the
type:user
keyword:
type:user amy
user
when not combined with type
is just a shortcut for finding users by ID, name, and email address. The user
keyword, like the ticket user role keywords (assignee, requester, submitter), accepts the ID, name, and email address as valid user identifiers.
user:52789480 user:amy user:"amy moore" user:amy@mondocam.com
type:user
.
type:user tags:beta_user organization:customers
This example also illustrates the usefulness of type
keyword. With it you can search for user data that is shared by more than one user. You can search for users that are in the same organization or group or any of the other searchable user data. For more information about the type
keyword, see Using the type keyword.
type
keyword is also used to search the group and organization data objects. For example:
-
type:group name:"level 2"
-
type:organization name:customers
Searching users
The user data object contains all of the user properties that you can set in the user profile for end users and team members. Not all of the user profile data is searchable; those properties that are searchable are described in the following table.
Keyword | Description |
---|---|
name |
The user's partial or full name.
name:"alex anderson" |
role |
The user's designated role.
role:admin |
email |
Specify the user's email address, or specify none to search for users without an email address.
email:alex@mondocam.com email:"none"
Tip: Wildcards do not work for email address searches. For example, the following search returns no results:
email:dwight* |
group |
The user's group name. This only applies to admin and agent users.
group:"Level 2" |
organization |
Specify the user's organization name or ID, or specify none to search for users without an organization. If the user belongs to more than one organization, searching on any of those organizations will return their profile.
organization:mondocam |
created |
The date the user was added to your Zendesk.
created<2011-05-01 For more information on using date and time in your search, see Searching by date and time. |
notes |
All text in the notes field in the user's profile.
notes:"manager" |
details |
All text in the details field in the user's profile.
details:"madison, wi" |
external_id |
Specify the user's external ID, if used, or specifynone to search for users without an external ID.
external_id:0098884412 |
phone |
Specify the user's phone number, or specify none to search for users without a phone number.
phone:555-111-2222 |
tags |
Specify tags on the user's profile, or specify none to search for users without tags.
tags:premium tags:wholesaleFor more information about tagging users and organizations, see Adding tags to users and organizations. |
customfield |
Custom user fields.
plan_type:platinumFor more information, see Searching custom user and organization fields. |
is_verified |
Indicates whether the user’s primary email address has been verified.
|
is_suspended |
Indicates whether the user has been suspended.
|
Search for users based on a WhatsApp phone number.
For more information see Searching for tickets by WhatsApp number. |
Searching for users by email domain
type:user mondocam.com
type:user mondocam.com zendesk.com
Searching groups
Here are the group properties that can be searched.
Keyword | Description |
---|---|
name |
The group's name.
name:"level 2" |
created |
The date the group was added.
created<2011-05-01 For more information on using date and time in your search, see Searching by date and time. |
Searching organizations
Here are the organization properties that can be searched.
Keyword | Description |
---|---|
name |
The organization's partial or full name.
name:mondocam |
created |
The date the organization was added.
created<2011-05-01 For more information on using date and time in your search, see Searching by date and time. |
notes |
All text in the notes field in the user's profile.
notes:EMEA |
details |
All text in the details field in the organization's profile.
details:london |
tags |
Specify tags that have been added to the organization, or specify none to search for organizations without tags.
tags:premium For more information about tagging users and organizations, see Adding tags to users and organizations. |
customfield |
Custom organization fields.
plan_type:platinumFor more information, see Searching custom user and organization fields. |
external_id |
The external ID of the organization or specify none to search for users without an external ID.
external_id:00112345 |
Searching custom user and organization fields
You can search for data in custom user fields and custom organization fields by using the key that identifies the custom field.
- Navigate to the list of custom fields:
- In Admin Center, click the People icon () in the sidebar, then select Configuration > Organization fields.
- In Admin Center, click the People icon () in the sidebar, then select Configuration > User fields.
- Click the name of a custom field.
The field key appears in the properties panel on the right.
You can search for users and organizations that have no value in a specific custom field, by using none as the search term, along with the custom field key. For instance, if you have a custom field key foo, a search for foo:none returns all users or organizations with the empty custom field foo.
Field type | Operators | Examples |
---|---|---|
Drop-down list | : | Find users or organizations where plan_type is platinum:
plan_type:platinum Find users or organizations where plan_type is platinum or gold: plan_type:platinum plan_type:gold |
Text
Multi-line text |
: | Find users or organizations where product_name contains widget:
product_name:widget |
Regular expression |
: |
Find users or organizations where product_name contains the multi-word phrase "red widget:" product_name:"red widget" |
Numeric |
>, <, >=, <=, : |
Find users or organizations where num_agents is exactly 5:
num_agents:5 Find users or organizations where num_agents is between 4 and 10, inclusive: num_agents>4 num_agents<10 |
Decimal | >, <, >=, <=, : | Find users or organizations where avg_score is greater than 14.5:
avg_score>14.5 Find users or organizations where avg_score is between 10.1 and 15.3, exclusive: avg_score>10.1 avg_score<15.3 |
Check box | : | Find users or organizations where is_active is true:
is_active:true |
Date | >, <, >=, <=, : | Find users or organizations where subscription_date is before 2013-06-23:
subscription_date<2013-06-23 Find users or organizations where subscription_date is between 2012-05-23 and 2013-06-23, exclusive subscription_date>2012-05-23 subscription_date<2013-06-23 |
Lookup relationship | Searching by lookup relationship field values is not supported. |