List articles
GET {{baseUrl}}/api/v1/articles
This API fetches a specific number of articles from your knowledge base, based on the limit defined.
OAuth Scope
Desk.articles.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | Index number starting from which the articles must be fetched. | |
limit | string | Number of articles to fetch | |
sortBy | string | Key that sorts the articles based on a specific attribute: <br>createdTime, <br> or <br>modifiedTime <br> | |
permission | string | Access permission for the article. Values allowed are: ALL , REGISTEREDUSERS , and AGENTS | |
authorId | string | ID of article owner | |
categoryId | string | ID of the category to which the article belongs | |
modifiedTimeRange | string | Key that filters articles modified within a specific date and time range. Enter the dates in the ISO date format of 'yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ' | |
expiryTimeRange | string | Key that filters articles which will expire within a specific date and time range. Enter the dates in the ISO date format of 'yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ' | |
status | string | Publishing status of the article. Values allowed are Draft , Published , Review , Expired |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"modifiedTime":"2020-06-24T11:46:43.000Z","creatorId":"4000000000059","dislikeCount":"0","modifierId":"4000000000059","likeCount":"0","locale":"en","ownerId":"4000000000059","title":"Answering your first ticket.","isTrashed":false,"createdTime":"2020-06-24T11:46:43.000Z","modifiedBy":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"id":"4000000019059","viewCount":"0","owner":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"summary":"Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save ...","latestVersionStatus":"Published","author":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"permission":"AGENTS","authorId":"4000000000059","usageCount":"0","commentCount":"0","rootCategoryId":"4000000017276","translationId":"4000000017294","createdBy":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"latestVersion":"1.0","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/4000000019059/en","feedbackCount":"0","portalUrl":"https://desk.zoho.com/portal/zylker/en/kb/articles/answering-your-first-ticket","attachmentCount":"0","latestPublishedVersion":"1.0","category":{"name":"General","id":"4000000017287","locale":"en"},"permalink":"answering-your-first-ticket","categoryId":"4000000017287","status":"Published"}]}