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.READDesk.articles.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | From index, starts from 0 | |
limit | string | No. of entities to fetch | |
departmentId | string | ID of the department from which the entity must be fetched. if not passed then searches in permitted departments <br>exact match<br> | |
id | string | ID of the articles <br>exact match<br> | |
title | string | title of the help article <br>wildcard search<br> | |
categoryName | string | Name of the Category <br>wildcard search<br> | |
categoryId | string | ID of the Category | |
tag | string | Tag in the articles <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
_all | string | Key that includes all article details for the search <br>wildcard search<br> | |
createdTimeRange | string | Key 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 | |
modifiedTimeRange | string | Key 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 | |
sortBy | string | SortBy can be: <br>relevance,<br> <br>modifiedTime,<br> <br>createdTime<br> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"summary":"Help articles are vital resources in user education. They are the first building blocks of an effective self-service setup.","modifiedTime":"2018-07-16T06:48:08.000Z","latestVersionStatus":"Published","author":{"photoURL":null,"name":"HIll","id":"5000000015935"},"creatorId":"4000000012931","modifierId":"4000000012931","dislikeCount":"1","permission":"AGENTS","likeCount":"2","title":"Importance of a Knowledge Base","authorId":"4000000012931","usageCount":"3","latestVersion":"1.0","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/22372000000281023","portalUrl":"https://desk.zoho.com/portal/zylker/kb/articles/importance-of-knowledge-base","feedbackCount":"1","createdTime":"2018-07-16T06:48:08.000Z","latestPublishedVersion":"1.0","viewCount":"3","id":"22372000000281023","permalink":"importance-of-a-knowledge-base","category":{"name":"General","id":"5000000017008"},"categoryId":"4000000013240","status":"Published"}],"count":379}