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

KeyDatatypeRequiredDescription
fromstringIndex number starting from which the articles must be fetched.
limitstringNumber of articles to fetch
sortBystringKey that sorts the articles based on a specific attribute: <br>createdTime,<br> or <br>modifiedTime<br>
permissionstringAccess permission for the article. Values allowed are: ALL, REGISTEREDUSERS, and AGENTS
authorIdstringID of article owner
categoryIdstringID of the category to which the article belongs
modifiedTimeRangestringKey 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'
expiryTimeRangestringKey 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'
statusstringPublishing status of the article. Values allowed are Draft, Published, Review, Expired

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;modifiedTime&quot;:&quot;2020-06-24T11:46:43.000Z&quot;,&quot;creatorId&quot;:&quot;4000000000059&quot;,&quot;dislikeCount&quot;:&quot;0&quot;,&quot;modifierId&quot;:&quot;4000000000059&quot;,&quot;likeCount&quot;:&quot;0&quot;,&quot;locale&quot;:&quot;en&quot;,&quot;ownerId&quot;:&quot;4000000000059&quot;,&quot;title&quot;:&quot;Answering your first ticket.&quot;,&quot;isTrashed&quot;:false,&quot;createdTime&quot;:&quot;2020-06-24T11:46:43.000Z&quot;,&quot;modifiedBy&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Hill&quot;,&quot;id&quot;:&quot;4000000000059&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;234543&quot;},&quot;id&quot;:&quot;4000000019059&quot;,&quot;viewCount&quot;:&quot;0&quot;,&quot;owner&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Hill&quot;,&quot;id&quot;:&quot;4000000000059&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;234543&quot;},&quot;summary&quot;:&quot;Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you&#39;ve already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket&#39;s content—so you can save ...&quot;,&quot;latestVersionStatus&quot;:&quot;Published&quot;,&quot;author&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Hill&quot;,&quot;id&quot;:&quot;4000000000059&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;234543&quot;},&quot;permission&quot;:&quot;AGENTS&quot;,&quot;authorId&quot;:&quot;4000000000059&quot;,&quot;usageCount&quot;:&quot;0&quot;,&quot;commentCount&quot;:&quot;0&quot;,&quot;rootCategoryId&quot;:&quot;4000000017276&quot;,&quot;translationId&quot;:&quot;4000000017294&quot;,&quot;createdBy&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Hill&quot;,&quot;id&quot;:&quot;4000000000059&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;234543&quot;},&quot;latestVersion&quot;:&quot;1.0&quot;,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/4000000019059/en&quot;,&quot;feedbackCount&quot;:&quot;0&quot;,&quot;portalUrl&quot;:&quot;https://desk.zoho.com/portal/zylker/en/kb/articles/answering-your-first-ticket&quot;,&quot;attachmentCount&quot;:&quot;0&quot;,&quot;latestPublishedVersion&quot;:&quot;1.0&quot;,&quot;category&quot;:{&quot;name&quot;:&quot;General&quot;,&quot;id&quot;:&quot;4000000017287&quot;,&quot;locale&quot;:&quot;en&quot;},&quot;permalink&quot;:&quot;answering-your-first-ticket&quot;,&quot;categoryId&quot;:&quot;4000000017287&quot;,&quot;status&quot;:&quot;Published&quot;}]}