Article Search API

GET {{baseUrl}}/api/v1/articles/search

This API searches for help articles in your help desk. The values can be given comma separated, which denotes the search on the field is done using either of the values given.
Zoho Desk APIs support two types of search:exact match and wildcard match.
exact match returns resources only if the value passed exactly matches with a resource in the help desk.
wildcard match returns resources even if the value passed partially matches with a resource in the help desk.
To perform wildcard match, append an asterisk (*) after the value to search.

OAuth Scope

  • Desk.search.READ
  • Desk.articles.READ

Request Params

KeyDatatypeRequiredDescription
fromstringFrom index, starts from 0
limitstringNo. of entities to fetch
departmentIdstringID of the department from which the entity must be fetched. if not passed then searches in permitted departments <br>exact match<br>
idstringID of the articles <br>exact match<br>
titlestringtitle of the help article <br>wildcard search<br>
categoryNamestringName of the Category <br>wildcard search<br>
categoryIdstringID of the Category
tagstringTag in the articles <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
_allstringKey that includes all article details for the search <br>wildcard search<br>
createdTimeRangestringKey that filters articles created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z
modifiedTimeRangestringKey that filters articles modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z
sortBystringSortBy can be: <br>relevance,<br> <br>modifiedTime,<br> <br>createdTime<br>

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;summary&quot;:&quot;Help articles are vital resources in user education. They are the first building blocks of an effective self-service setup.&quot;,&quot;modifiedTime&quot;:&quot;2018-07-16T06:48:08.000Z&quot;,&quot;latestVersionStatus&quot;:&quot;Published&quot;,&quot;author&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;HIll&quot;,&quot;id&quot;:&quot;5000000015935&quot;},&quot;creatorId&quot;:&quot;4000000012931&quot;,&quot;modifierId&quot;:&quot;4000000012931&quot;,&quot;dislikeCount&quot;:&quot;1&quot;,&quot;permission&quot;:&quot;AGENTS&quot;,&quot;likeCount&quot;:&quot;2&quot;,&quot;title&quot;:&quot;Importance of a Knowledge Base&quot;,&quot;authorId&quot;:&quot;4000000012931&quot;,&quot;usageCount&quot;:&quot;3&quot;,&quot;latestVersion&quot;:&quot;1.0&quot;,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/22372000000281023&quot;,&quot;portalUrl&quot;:&quot;https://desk.zoho.com/portal/zylker/kb/articles/importance-of-knowledge-base&quot;,&quot;feedbackCount&quot;:&quot;1&quot;,&quot;createdTime&quot;:&quot;2018-07-16T06:48:08.000Z&quot;,&quot;latestPublishedVersion&quot;:&quot;1.0&quot;,&quot;viewCount&quot;:&quot;3&quot;,&quot;id&quot;:&quot;22372000000281023&quot;,&quot;permalink&quot;:&quot;importance-of-a-knowledge-base&quot;,&quot;category&quot;:{&quot;name&quot;:&quot;General&quot;,&quot;id&quot;:&quot;5000000017008&quot;},&quot;categoryId&quot;:&quot;4000000013240&quot;,&quot;status&quot;:&quot;Published&quot;}],&quot;count&quot;:379}