Data in the user, group, and organization objects can be searched. Searching these objects returns user profiles and group and organization summary pages; each of which also lists any associated tickets.
This article covers the following topics:
About searching
You can search users, organizations, and groups by using the search tool that is displayed in the People page.
When you search from this page the results are restricted to this people data.
If you search using the global search tool, you need to also 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:amyOr, using the type:user keyword:
type:user amy
user:52789480 user:amy user:"amy moore" user:amy@mondocam.com
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: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. 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 |
The user's email address.
email:alex@mondocam.com |
group |
The user's group name. This only applies to admin and agent users.
group:"Level 2" |
organization |
The user's organization name.
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 |
The user's external ID, if used.
external_id:0098884412 |
phone |
The user's phone number.
phone:555-111-2222 |
tags |
Tags that have been added to the user's profile.
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. |
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 |
Tags that have been added to the organization.
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. |
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.
To locate the key for a custom field, click the Admin icon () and select User Fields or Organization Fields, then 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 |
44 Comments
This question doesn't seem to have been updated since the new search came out so I am going to check again: can I search for users that are not assigned to an organization?
Hi Peter,
You can indeed, by using the search operator 'organization:none'. This applies equally to the user search as above, and the full Zendesk search. You can read a bit more about it at https://support.zendesk.com/hc/en-us/articles/203663226-Zendesk-search-reference#topic_qmq_oxc_vc
Hi All,
We are interested in learning how you, Zendesk customers, use the Zendesk search in your work to help us continue enhancing and improving this feature.
If you and your team are interested in sharing how search supports your work and are available for talking to us, please sign up using the form here. http://goo.gl/forms/IDuqGK20uu397YAb2
We will follow up from there if we find a match to our study. Due to limited resource available, we may not be able to cover all customers.
Thanks!
Is there a way to search for duplicate end users in Zendesk? We've got end users getting pulled in via API and end users emailing our company directly and at times, it results in a duplicate end user being created. I'd like to be able to easily run a search every so often to get these cleaned up. Suggestions?
Hey Vanessa!
Zendesk uses the email of the requester to link user information together and no two users in a Zendesk can have the same email address, so there shouldn't be exactly duplicate users in the account. If for some reason there really is multiple users being created with the same exact email or phone number, let us know as that could point to an issue with user creation in your account.
Users may have the same name, but their contact information (email, phone #, etc) should be different. You can direct the search a bit to just their name by using (name: "insert name here") in the search field. If you find two users with the same name but different contact information, I'd suggest merging the two together from their user profile page so any subsequent interactions from them will all be linked to the same user account.
I hope that helps!
I am having trouble searching for organizations based on custom Org field values. I created a custom drop-down whose field key is org_type and applied one of the values to several orgs. However I get no results when I search using "org_type:agency", for example.
Should I submit a ticket about this?
@Mike. It does sound like you're doing everything correctly. We'll need to take a look at your account to verify what might be going wrong, so yes, please submit a ticket and we'll go from there. Thanks!
I figured out the problem. I was trying to use the search option on the People screen rather than the main search bar at the top. It works when using the main search bar.
Thanks for coming back and letting us know, Mike!
What is the query to find all organizations with or without a domain. Is it possible get all the domains associated with it too?
Hey Leslie!
You should be able to pull that information using our API!
How do you search on Twitter or Facebook handle from the Search bar?
Hi Chris,
Regretfully, it's not possible to search for users based on their Twitter or Facebook handle right now. I'd recommend sharing your feedback in our Product Feedback forum to bring more visibility to this request.
You can search for tickets created via those channels by searching for via:twitter or via:facebook, which may help make those users easier to find.
I hope this helps!
Hi everybody,
how can i search an organization in a full name not in partial name ?
My request is this one
https://society.zendesk.com/api/v2/search?query=type:organization%20name:MYNAME ........
the result are all organisation with partial name
Thank you for help
Hi Michel! Welcome to the Community!
Can you tell me where you're trying to do this search and what search syntax you're using?
Hi jessie,
i have a window application and i am try to check if an organization already exist.
the syntax that i am using is this one
https://society.zendesk.com/api/v2/search?query=type:organization%20name:MYNAME
sure i am already connected with user and password.
thank you for help
Hey Michel!
society.zendesk.com is actually an internal subdomain so you're not going to be able to get results from that search. Are you sure you're using the right subdomain?
Otherwise, I think your query is okay except that I believe you need to use user: "Your Name" rather than name.
Is it possible to search by user id or organization id?
Hey Brett -
Where/how are you trying to search?
With the advanced search. If I know the id of the user or the organization the I want to pull it up
e.g. organization:id 123456 or user:id 234567
Hey Brett -
So sorry for the delayed response. The easiest way to do this is to simply enter the ID number into the url, so for example you would have:
https://yourdomain.zendesk.com/agent/users/123456
Give that a try and let me know if you have further questions.
Any chance you guys enable Search on Organization id? Seems to be a big gap as it can't be searched on - even in your Advanced Search interface in Zendesk.
Hi Justin! You can utilize our API to search for organization id! https://developer.zendesk.com/rest_api/docs/core/organizations#show-organization
If you'd like to share your use-case, we can provide some additional options for you as well!
I was able to search Organizations which has a blank custom_field by using below Search:
type:Organization Custom_Field:None
How Do I search Organizations which has some data in Custom_Field.. something like Not Null. ?
type:Organization Custom_Field: Not None
type:Organization Custom_Field <> Not None
type:Organization Custom_Field=! Not None
What about searching for users that have a null property?
type:user external_id:none
I know that doesn't work, but is there a way to do this?
Welcome to the Community, Jorge!
There isn't a search operator that will do this, but if you can give me more information on what you're hoping to do with that information I may be able to help you find another way to do it.
Is there a way to pull the organization name and their group alignment at the organizational level rather than ticket level? If so, I'd greatly appreciate feedback on this for we are attempting to change all organizations over to a new group alignment and need to verify everything is set as expected and continuously audit this. Thanks.
Hi Jen -
What plan level are you on?
Hi, Is there a way to pull tickets from multiple groups ?
e.g. I have 4 ticket groups : Round Users, Square Users, Triangle Users and Rectangle Users
I would like to have a url query that gets all the tickets under Round users OR Square Users.
Is that possible ? Currently I am only able to search for one group per query.
/api/v2/search.json?query=type:ticket+group:"Round+Users"&sort_by=created_at&sort_order=asc
This query does not work (getting 0 tickets):
/api/v2/search.json?query=type:ticket+group:"Round+Users,Square+Users"&sort_by=created_at&sort_order=asc
Thanks
Hi Gilad,
There is a way to pull from multiple groups! In order to do so, you would want to have those groups separated, not within the same quotation marks. To match your example with Round Users and Square Users, the call you'd want to make would look more like this:
`/api/v2/search.json?query=type:ticket+group:"Round Users"+group:"Square Users"&sort_by=created_at&sort_order=asc`
You can also use this for even more groups, you'll just want to add "+group:"Group Name"", so for example, to add in Triangle Users, it would be
`/api/v2/search.json?query=type:ticket+group:"Round Users"+group:"Square Users"+group:"Triangle Users"&sort_by=created_at&sort_order=asc`
I hope that helps!
Please sign in to leave a comment.