This article contains tables listing and describing data property keywords and values that can be used, along with common search operators, to narrow your search results. There are also sections describing more advanced search methods and formatting.
This article is aimed at administrators and support managers with full access to the data in Zendesk Support. If you're an agent, start withSearching the data in Zendesk Supportand refer back to this reference article if you want to perform more advanced searches.
This article includes the following topics on advanced search methods:
This article includes the following reference tables:
- Search operators
- Ticket property keywords
- User property keywords
- Organization property keywords
- Group property keywords
- Satisfaction rating searchable values
Search terms and terminology
Search terms
Search terms are user-defined words, phrases, or values. Examples:
- 3245227
- Greenbriar
- serial number
- "Jane Doe"
Search terms are case-insensitive. For example, "App" and "app" return the same results.
A single-word search term returns a result if it appears in the data as follows:
- a single word
- a single word in a longer phrase
- the prefix of a longer word
The search term will not return a result if it appears in the data as follows:
- in the middle of a word
- at the end of a word
For example, the search term "top" would match "top", "top tier", "Top Ten Trucking", "Tip-Top Mops", "Big Top Entertainment", and "Dessert Toppings, Inc". It would not match "Desktop Solutions" or "One-Stop Publishing".
请升级我的帐户
Property keywords
You can narrow your results by combiningproperty keywordswith search terms andoperators. Example:
status
A property keyword is the name of a property in a ticket, a user, an organization, or a group. Examples:
- assignee
- created
- name
See the following property keyword references for all the properties and details about each:
Example property searches:
Search | Property keyword | Returns |
---|---|---|
priority>normal | priority | Tickets with a priority of high or urgent |
subject:2fa | subject | Tickets with the search term 2fa in the subject |
email:jdoe@example.com | The user with the email jdoe@example.com |
Some properties have predefined values. For example, the ticket status property has the following predefined values: new, open, pending, hold, solved, closed. You can only search by these values. Example search:status:open
. See the property keyword references for details about each property.
Other properties accept user-defined search terms. Example:subject:2fa
. SeeSearch terms. The same matching rules apply for property searches with the exception of prefix matching. Results are not returned if the search term appears as the prefix of a longer word. For example, the search term "tier" would return results for "tier 1" and "tier 2" but not "tiered".
You can search for multiple values of a single property by including the property keyword multiple times in a query. Example:
tags:silver tags:bronze
Search uses OR logic for matching in this case. The previous example returns results that contain either the tag "silver" or the tag "bronze".
Example search
The following search expression looks for anything with the tag "vip" that was created before May 1, 2019:
tags:vip created<2019-05-01
- tags是一个属性关键字说明你搜索only within a specific data property, in this case atag.
- :is the "equal to" operator indicating thetagproperty value needs to be equal to the subsequent search term. Note that there's no space before or after the:.
- vipis the search term.
- created是一个属性关键字说明你搜索thecreateddata property for items created relative to a certain date.
- <is the "less than" operator indicating you're searching for records created before a certain date.
- 2015-05-01is a search term indicating the date you want to use.
Searching for properties that contain no data
none
as the search term, along with thegroup,tags,via,organization, orassigneekeywords, as in this example:assignee:none
This returns all unassigned tickets.
Searching by date and time
Date property keywords -created,updated,solved, anddue date) can be combined with search operators to return data from a specific date, before a certain date, and after a certain date. To search dates in any locale, use the format YYYY-MM-DD. You can also use locale-specific formats such as MM/DD/YYYY in the United States.
created<2011-05-01
due_date>2010-01-10
solved:2010-01-10
You can also use the<=or>=operators to indicateless-than-or-equal-toandgreater-than-or-equal-torespectively.
Searching with combined dates and times
created>2015-09-01T12:00:00-08:00 updated<2015-09-01T12:00:00Z
The first example above searches for anything created after September 1, 2015 at 12:00 p.m. (Pacific Standard Time).
The second example above searches for anything updated before September 1, 2015 at 12:00 p.m. (UTC).
Searching within a date/time range
created>2014-08-01 created<2014-08-05
You can also include specific times in your search range. The following example searches for anything created between August 1, 2014 at 11:59 p.m. (UTC) and August 4, 2014 at midnight (UTC):
created>2014-08-01T23:59:00Z created<2014-08-04T23:59:59Z
Searching with relative times
You can search for a time relative to the present time, using the time unitshours,minutes,days,weeks,months, oryears. The following search returns anything created in the last four hours:
created>4hours
Sorting search results
order_by:field
sort:asc
orsort:desc
created
commented
priority
status
ticket_type
Using theorder_by
andsort
keywords is equivalent to using the API parameterssort_by
andsort_order
.
Using the 'type' keyword
For API searches, one of the tools you have available for narrowing your search results is thetype
keyword. It is used to explicitly declare that you want to search for one of the following types:
- ticket
- user
- organization
- group
Using thetype
keyword means that you are explicitly searching on the type you specify. For example, you can search for all the users that belong to the customer's organization using this search statement:
type:user organization:customers
If you instead searched fororganization:customers
you would also get all the tickets that have requesters who belong to this organization. This is because searches that do not explicitly specify type return results for all types, including tickets (and organization is a ticket property).
Usingtype:user
, your search returns all users that belong to the Customers organization. So, you're narrowing your search to the user type and excluding tickets.
While organizations and groups are properties of the user object, they have their own properties that can be searched as well. The following query allows you search only for organization tags, excluding tags of the same name that may be used in other elements of your Zendesk Support instance such as tickets and forum topics.
type:organization tags:premium
Using the 'user' keyword
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
For more information about theuser
keyword and how it's different from thetype:user
keyword, see the section aboutThe user and type keywordsinSearching users, groups, and organizations.
Search FAQ
- How soon can new data be searched?
When you add new data to Zendesk Support, it typically takes about a minute before it's indexed and can be searched.
- 标点符号是如何影响搜索?
Punctuation characters are generally not included in searches.
- Are there limitations to wildcard searches?
You can only do wildcard searches when combined with property keywords (
subject:photo*
). - Who can search what?
Administrators can search all the data in Zendesk Support. Agents can search the data that they've been granted access to. End-users can do full text searches of the knowledge base.
What languages are supported?
There is language-specific support for searching in the following languages:- English
- French
- German
- Japanese
- Portuguese
- Spanish
The support includes dictionary-based tokenization for Japanese, because words are not separated by spaces in that language. For the other languages, the language-specific support is primarily stemming, which allows different forms of the same word to match. In particular, the singular and plural forms of a word will generally match.
Search operators
You can use the following search operators to build your search statements.
Operator | Description |
---|---|
: | The colon indicates that the given field should equal the specified value.status:open |
< | Less than.status |
> | Greater than.priority>normal |
<= | Less than or equal to.status<=pending |
>= | Greater than or equal to.优先级> =正常 |
" " | Double quotes. In a simple keyword search, this is referred to as a phrase search and returns the exact words in the exact order; however, punctuation characters are not included."Please upgrade my account"
Note:In the Japanese version of Support, this feature does not work as expected. A simple keyword search that includes double quotes returns results, but the results are not the exact words in the exact order. In a search including data properties, use double quotes to perform an inclusive AND search, returning results that includeallproperties in the search. tags:"superman is_awesome" |
- | Minus sign. Excludes items containing a word (or property value) from the search results. For example, the following statement searches for any tickets with the status 'pending', but excludes any tickets containing the tag 'invoice' from the search results:status:pending -tags:invoice |
* | The wildcard operator is useful when you want to search various forms of a word. For example, searching forphoto* returns results that would include photography, photographer, photograph and any other words that began with 'photo'.
However, because of the performance issues involved with doing wildcard searches, unqualified wildcard searches are not currently supported. In other words, you need to use a property keyword to make your search specific to the data you're trying to locate. subject:photo* |
Ticket property keywords
You can search on the following ticket properties.
For more information about ticket search, seeSearching tickets.
Keyword | Description |
---|---|
Ticket ID | There isn't a property keyword for the ticket ID. Instead, you simply search for the ticket by its ID number in the following format:233 |
created |
The date, or date and time, the ticket was created. Enter date in yyy-mm-dd format.created:2011-05-01 Search within a date or time range. Enter times usingISO 8601syntax. For example, to search for a ticket created between 10:30 a.m. and 12 p.m. (UTC) on August 1, 2014: created>2014-08-01T10:30:00Z created<2014-08-01T12:00:00Z For more information on using date and time in your search, seeSearching by date and time. |
updated |
The date of the most recent ticket update.updated>2011-05-15 For more information on using date and time in your search, seeSearching by date and time. |
solved |
The date the ticket was set to solved.solved<2011-06-01 For more information on using date and time in your search, seeSearching by date and time. |
due_date |
The due date of tickets.due_date:2011-06-01 For more information on using date and time in your search, seeSearching by date and time. |
assignee |
The assigned agent or other entity. You can specify "none", "me", user name (full name or partial), email address, user ID, or phone number (see thephone user propertyfor help searching by phone number).assignee:"Susan Warren" |
submitter |
The ticket submitter. This may be different than the requester if the ticket was submitted by an agent on behalf of the requester. You can specify "none", "me", user name (full name or partial), email address, user ID, or phone number (see thephone user propertyfor help searching by phone number). SeeSearching ticket user roles.submitter:me |
requester |
The ticket requester. You can specify "none", "me", user name (full name or partial), email address, user ID, or phone number (see thephone user propertyfor help searching by phone number).requester:amy@mondocam.com |
subject |
The text in the ticket's subject.subject:"upgrade account" |
description |
The text in the ticket's description and comments.description:defective |
custom_status_id |
Ifcustom ticket statuses are activated, search for a specific system or custom ticket status. Specify the status by its numeric ID, which you can find on the Ticket statuses page whenediting a ticket status.
|
status |
Possible values: new, open, pending, hold, solved, closed.status |
ticket_type |
Possible values: question, incident, problem, task.ticket_type:problem |
priority |
Possible values: low, normal, high, urgent.priority>low |
group |
Specify the name or ID of a group. Returns tickets assigned to agents who are members of the group. Examples:group:"Level 2" group:20663166 |
organization |
Specify the name or ID of an organization. Returns tickets by requesters who are members of the organization. Examples:organization:customers organization:22989442 You can also specify "none" to return tickets by requesters who are not members of any organization. organization:none |
tags |
Specify tags that have been added to the ticket or "none."tags:premium To find tickets that include either of two tags, use: tags:important tags:urgent To find tickets that include both tags: 标签:”文件夹内t urgent" |
via |
The ticket's source, which can be any of the following:
via:phone |
commenter |
People who have added comments to tickets. You can specify "none", "me", user name (full name or partial), email address, user ID, or phone number (see thephone user propertyfor help searching by phone number).commenter:"Mike" |
cc |
People who have been CC'd on tickets. You can specify "none", "me", user name (full name or partial), email address, user ID, or phone number (see thephone user propertyfor help searching by phone number).cc:amanda@mondocam.com |
fieldvalue |
Search for a specific value in any custom ticket fields by using thefieldvaluekeyword. For example:fieldvalue:12345 This returns all the tickets that have a custom field with the value "12345." For drop-down custom fields, search for tags associated with the field value you want to find. For checkbox custom fields, you can search for tickets with the field checked or unchecked. For example: custom_field_ |
custom_field_{id} |
Search for a value of a specific custom ticket field. Specify the field by its numeric ID, which you can get from the URL of the Ticket Fields page in the admin interface or with theTicket FieldsAPI. The syntax iscustom_field_ . Example:
|
brand |
Search for a specific brand on a ticket using the brand name or the brand ID. A brand with two or more words requires quotation marks. For example:brand:Nordstrom
Or brand: "Banana Republic" Or brand:<ID number> |
has_attachment |
Search for all tickets with or without attachments usingtrue orfalse .To search for tickets with attachments:
To search for all tickets without attachments:
|
form |
Search for all tickets created with a particular ticket form. If the name of the ticket form includes multiple words, use quotation marks. For example:
If the name of the ticket form is a single word, you don't have to use the quotation marks. For example:
|
recipient |
Search for all tickets created with a particular recipient.
This only works for Zendesk support addresses (the ultimate destination) of emails forwarded from external addresses.
|
comment |
Search for text within a ticket's comment.
To search for an exact match within the comments of a ticket, use double quotes.
Note:Only the first 500 comments in a ticket are searched. |
User property keywords
Here's the list of user properties that can be searched.
For more information about searching users, seeSearching for users, groups, and organizations.
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"
Using double quotes to search for an email address does not return an exact match like other keyword searches. For example, if you search the following the results may return any user whose email starts with "dwight":
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 specifynone 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, seeSearching 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 specifynone to search for users without a phone number.phone:+555-111-2222 When searching by phone number, you must include a plus sign (+) before the number. When searching by phone number using the API, you must include %2B (the URL-encoded version of +) before the number (for example, |
tags |
Specify tags on the user's profile, or specifynone to search for users without tags.tags:premium tags:wholesaleFor more information about tagging users and organizations, seeAdding tags to users and organizations. |
customfield |
用户自定义字段。plan_type:platinumFor more information, seeSearching 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 seeSearching for tickets by WhatsApp number. |
Organization property keywords
Here's the list of organization properties that can be searched. For more information, seeSearching for users, groups, and organizations.
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, seeSearching 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 specifynone to search for organizations without tags.tags:premium For more information about tagging users and organizations, seeAdding tags to users and organizations. |
customfield |
Custom organization fields.plan_type:platinumFor more information, seeSearching custom user and organization fields. |
external_id |
The external ID of the organization or specifynoneto search for users without an external ID.external_id:00112345 |
Group property keywords
Here's the list of group properties that can be searched. For more information, seeSearching for users, groups, and organizations.
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, seeSearching by date and time. |
Satisfaction rating searchable values
You can use thesatisfaction
keyword with rating values to search your customer satisfaction ratings. For more information on customer satisfaction, seeUsing customer satisfaction rating.
Value | Description |
---|---|
bad |
Tickets that have been rated 'bad'.
|
badwithcomment |
Tickets that have been rated 'bad' that also include a comment from the ticket requester.
|
good |
Tickets that have been rated 'good'.
|
goodwithcomment |
Tickets that have been rated 'good' that also include a comment from the ticket requester.
|
offered |
When you request a customer satisfaction rating, the ticket satisfaction rating status is set to 'offered'. The following notification is added to the ticket: Customer satisfaction feedback was offered. This means that you've asked for but not yet received a response to the rating request.
|
100 Comments
I just updated the topic so you should now have access. Let me know if you have any other questions!
Hello, is it possible to search for a user by email address if that user has a minus sign (or dash) in their email address? I don't see any results appear when I search for such a user by email address even though I know the email address matches that of a user in my system. I wonder if this is because the minus sign has a special usage in the search feature.
HiNicholas Hemenway
You need to enclose your search term in double quotes: "*-*" in the search bar finds all users that have a minus in their name or their e-mail address.
Peter HochstrasserThanks for the quick reply. Unfortunately, that doesn't seem to work either. This email address does also include a '+' symbol, so maybe it's failing because of that?
Nicholas you can't use exact string matching on "punctuation". I have an open escalated ticket with Zendesk about this because it's preposterous and a serious limitation of the search function.
Hey Zendesk-ey peoples
Does anyone know how I can search by Templates across Articles in Help Centre?
I've done a mass migration of our User guides into Zendesk (from Confluence on-prem which is EOL) and I have run through them all to freshen them up, standardise them etc. For each Module of our product that the Articles relate to we have applied a Template to them, which I'll get one of our Creatives to make into a nicely styled template with Color, Logos, Legal footers etc.
So can I do a search for Articles by the Template? I want to see what Articles are still using the default Template in case I missed some, which I will have out of the nearly 1000 docs we imported.
is the Template Field searchable?
Thanks all
Mic
Hi Mic,
If the template has a Label (keyword) added to it that is unique to the template, it should apply that label every time the template is used to create an article
Hi all,
我试着搜索数据(从搜索& Zendesk API)亚博our support tickets with a specific keyword most used by our end user but when filtering "data layer" I'm seeing our agent reply to. I want to get only end users' replies or first emails that include these specific keywords.
Is there a way to get only end users' emails and replies from search or Zendesk API?
Is there a way to search by attachment name? This is critical at the moment for us.
As it turns out, we don't have a search criteria that can exclude bot responses.
Hello Support,
How I can filter out cases based out *Severity*?
I tried many ways to filer open tickets with Severity filter / search criteria but I could not.
severity>=critical status:open status:new status:hold
Or
But I still get all records of tickets with High Severity only.
Am I missing something here?
严重性是定制机票字段吗?操作符>, < and = don't work when searching for custom field values. To search for custom field values, you can refer tothistable. Example, if I want to search for tickets with values Low, Moderate or High selected on my custom field, I can use this search query:
Hello! Is it possible to search only though the initial messages in all tickets?
Currently, searching any keyword will scan for the whole message of a ticket. As a workaround, you could try using the double quotes" ".
In a simple keyword search, this is referred to as a phrase search and returns the exact words in the exact order; however, punctuation characters are not included.
I hope this helps. Thank you!
Using double quotes doesn't seem to actually specify my results. I use " UPS " and it still returns things like "follow-ups" and "set up"
Welcome to Zendesk Cat, where the documentation is either missing, just plain wrong or there's some unusual edge case that affects 99% of the users
Why does searching by the domains associated to an organization return no results? We have orgs that have multiple domains for their users. If I search fororganization:domain.comororganization:seconddomain.com- I get nothing.
Based onOrganization property keywords、组织域不是搜索客的一部分ywords.
Is there a list of search connectors or operators that end users can use to search Guide content?
It seems you can find this information here related to what end users can use to search Guide content -https://developer.zendesk.com/documentation/help_center/help-center-templates/search_results_page/#search-results-page
Hope it helps
Still no functionality to search by Followers of tickets? How are other light agents (CSM, SEs, Sales, etc...) able to follow along with their client support requests?
Sorry if I missed this but is there a way to search using an AND condition, to restrict results? Adding multiple terms results in an OR search, but I want to search e.g. keywords 'and' a field value, which I can't seem to do.
Thanks,
Steven.
Hi Steven,
One way to do this is to input a search term together with a tags search for the field value.
In my example below I use
This then returns the tickets containing the word "test" AND the tag "v1".
Though I would highly recommend using theAdvanced Search appinstead since it is in my opinion a more user-friendly free app created by Zendesk. You can learn more about the apphere.
Thanks Nora. When I try that, it returns as an OR search e.g. in your example I would get everything with the word 'test' or everything tagged v1.... But I like the Advanced Search app, thanks for the tip - I will try that out :D
Hi
apologies if this has been already discussed earlier , I am looking for a way to use the query parameter to filter out objects by "updated" field . I am able to perform this using `search.json?query=tickets+updated>2015-09-01T12:00:00-08:00` but I am unable to do this for other objects which includes users , requests , organisations but I get status code 200 OK . Is this parameter only limited to tickets . I am looking for a way to filter all objects that have updated_at greater than a given timestamp . If there is a workaround it would greatly help in building a Zendesk connector .
Navin KarunanithiVery possible. See this endpoint referencing organizations
https://{your domain here}/api/v2/search.json?query=type:organization "zone tech" updated>2020-09-07T19:00:00Z updated<2021-09-07T23:59:59Z
It appears that tickets can be found by using an organization ID, however we can't search for organizations by ID.
Could this oversight be addressed please? I can't imagine it would be too complicated to add support for Org ID.
How can i filter using search API. Below are the filters required
ticket id > X AND order by ticket ID AND sort by desc
Hello Jainendra,
As mentioned above, there isn't a property keyword for the ticket ID, so you can probably use the ticket created date instead to filter the search and sort it:
Pleasesign into leave a comment.