Introduction

Zoho Desk APIs help create tools using which end-users can perform support operations without having to directly access Zoho Desk.

These APIs adhere to RESTful principles and provide predictable URLs, thereby simplifying application development. Also, since the APIs follow HTTP rules, end-users can interact with the APIs through a wide range of HTTP clients.

Help desk resources are exposed as URLs that can be obtained by accessing the corresponding API Root Endpoint. This document lists the APIs related to the help center feature in Zoho Desk.

API Root Endpoint

https://desk.zoho.com/portal/api/

Getting Started

All help center APIs require a mandatory query parameter called portalId. This parameter refers to the unique ID of the help center you want to access. The portalId parameter plays a key role in these APIs because a single organization can have multiple help centers.

Example

$ curl https://desk.zoho.com/portal/api/kbArticles?portalId=50c9bb96b17694d63cd0f03eadbe4ae5

Authentication

The authentication mechanism for these APIs is still under development.

HTTP Methods

The help center APIs use an appropriate HTTP verb for each action.

Method	Description
GET	Retrieving help center resources
POST	Creating help center resources and performing resource actions
PATCH	Updating help center resources
DELETE	Deleting help center resources

Using GET method, you can get the list of resources or details of a particular instance of a resource.
To get a list of articles

$ curl https://desk.zoho.com/portal/api/kbArticles?portalId=ae075dk0de8621f986c07c1fe256e4243

To get the details of a ticket referred to by a specified ticket_id

$ curl https://desk.zoho.com/portal/api/kbArticles/1000020008820?portalId=ae075d0dek8621f986c07c1fe256e4243

Portal Id

In Zoho Desk, businesses are called organizations. If you run multiple businesses, you simply set each business as an individual organization. Each organization is a unique entity in Zoho Desk and can have multiple help centers. As mentioned earlier, each help center has a unique portalId.

You can fetch the portalId of a help center from the response to the GET /portal/api/helpCenters API.

The organization ID (orgId param) of the corresponding Zoho Desk account is mandatory for fetching the portalId of a help center. For instructions on how to fetch the orgID of a Zoho Desk account, refer to this link

Request Example

$ curl https://desk.zoho.com/portal/api/helpCenters?orgId=67653422

Response Example

HTTP/1.1 200 Ok
Content-Type: application/json;charset=UTF-8

{ “data”: [ { “isDefault”: true, “portalId”: “d3298252f23e28b7be3a52f23eb184d80a28f19a153885d2430e0ab612”, “name”: “Test portal”, “id”: “3261240000200099069”, “departmentIds”: [ “3261240000200006907” ], “isActive”: true, “logoUrl”: https://d1ydxa2xvtn0b5.cloudfront.net/app/images/portalLogo.de847024ebc0131731a3.png, “url”: “https://desk.zoho.com/portal/testPortal/” } ] }

Errors

Zoho Desk uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range mean success, 4xx range mean there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Status Code	Description
200	OK
201	Created
204	NO Content Found
400	Bad request
401	Unauthorized (Invalid AuthToken)
403	Forbidden
404	URL Not Found
405	Method Not Allowed (Method you have called is not supported for the invoked API)
500	Internal Error

Request Example

$ curl https://desk.zoho.com/portal/api/kbArticles/700000007942?portalId=ae075d0dek8621f986c07c1sfe256e4243

Response Example

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
{
“message”: “Error while Processing Request.”
}

HelpCenters

Help center refers to the customer-facing online portal through which customers can access your help desk. From the help center, end-users can submit tickets, read help articles stored in your knowledge base, interact with other customers, or chat with your customer support agents.

Example

{ }

List help centers

This API lists the help centers configured in an organization.

GET /portal/api/helpCenters

Request Example

https://desk.zoho.com/portal/api/helpCenters?orgId=759221

Response Example

{
  "data" : [ {
    "isDefault" : "true",
    "portalId" : "5c9470fcc808cc98932703e28221d6c302e105dc4da8b23fafb6719abeecaa48",
    "isEnabled" : "true",
    "name" : "Zoho Corp",
    "id" : "1000000009118",
    "departmentIds" : [ "1000000009123", "1000000009112", "1000000009115", "1000000002328", "1000000005345" ],
    "url" : "https://desk.zoho.com/portal/zohocorp",
    "logoUrl" : "https://desk.zoho.com/portal/api/helpCenters/1000000009118/logo/1000000003456?orgId=234813"
  } ]
}

Get help center details

This API fetches the details of a particular help center.

QueryParams

include

string

Secondary information related to the help center. Values supported are PREFERENCES and CONFIGURATIONS.

GET /portal/api/helpCenters/{id}

Request Example

https://desk.zoho.com/portal/api/helpCenters/1000000009118?orgId=759221&include=PREFERENCES,CONFIGURATIONS

Response Example

{
  "preferences" : {
    "isHelpCenterPublic" : "REGISTEREDUSERS",
    "isAccountTicketViewable" : "false",
    "searchScope" : "category",
    "articleFeedbackFormOnDislike" : "show",
    "communityLandingPage" : "allcategory",
    "isKBEnabled" : "true",
    "tocPosition" : "top",
    "isSignUpEnabled" : "true",
    "isOnHoldEnabled" : "true",
    "isKBEndUsersCommentEnabled" : "true",
    "isCommunityEnabled" : "true",
    "isGamificationEnabled" : "true",
    "isTocEnabled" : "true",
    "isTagsEnabled" : "true"
  },
  "logolinkBackUrl" : "https://www.google.com",
  "configurations" : {
    "googleAnalytics" : {
      "trackerId" : "UA-223321-212",
      "domainName" : "Manage Engine",
      "isEnabled" : "true",
      "AnalyticsType" : "Universal Analytics"
    },
    "seo" : {
      "isEnabled" : "true",
      "metaKeyWord" : "Zoho,Manage Engine",
      "title" : "Manage Engine",
      "metaDescription" : "Power up your IT help desk on cloud."
    }
  },
  "departmentIds" : [ "5000000001243", "5000000002428", "5000000003245" ],
  "activeLocales" : [ {
    "i18nLocaleName" : "Русский",
    "name" : "Zoho Cares",
    "locale" : "ru",
    "type" : "DEFAULT",
    "status" : "ACCESIBLE_IN_HELPCENTER"
  }, {
    "i18nLocaleName" : "Español (España)",
    "name" : "Zoho Corp..,",
    "locale" : "es",
    "type" : "OTHER",
    "status" : "ACCESIBLE_IN_HELPCENTER"
  } ],
  "url" : "https://desk.zoho.com/portal/manageengine",
  "logoUrl" : "https://desk.zoho.com/portal/api/helpCenters/1000000009118/logo/1000000003456?orgId=234813",
  "accountId" : "654728",
  "portalId" : "5c9470fcc808cc98932703e28221d6c302e105dfgthuklq5671fb6719abeecaa48",
  "name" : "Manage Engine",
  "favIconUrl" : "https://desk.zoho.com/portal/api/helpCenters/1000000009118/favIcon/1000000003456?orgId=234813",
  "id" : "1000000009118",
  "primaryLocale" : "ru_RU"
}

Community

Community API's are used to integrate with Zoho discussion

Example

{ }

List all topics

API to get all Topics

QueryParams

categoryId

long

Id of category from which topics are to be retrieved

from

int

Index from which list is retrieved and it starts from 1

limit

int

Number of topics to list.

isSticky

boolean

True retrives sticky posts

type

String

Topic Type – Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION

tagName

String

Name of the Tag

label

String

Topic Label

sortBy

string

Key that sorts topics by a particular attribute: createdTime, modifiedTime, or latestCommentTime

isDescending

boolean

Sort list of topics by Ascending or Descending

GET portal/api/communityTopics

Request Example

https://desk.zoho.com/portal/api/communityTopics?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "latestCommentTime" : "2013-11-04T11:21:07.000Z",
    "subject" : "First Post",
    "likeCount" : "1",
    "label" : "ANSWERED",
    "isVoted" : true,
    "type" : "QUESTION",
    "content" : "First Post",
    "commentCount" : "2",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "lastCommenter" : {
      "name" : "User - 2",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "SUPPORTREP"
    },
    "viewCount" : "1",
    "id" : "3000000000059",
    "permalink" : "first-post",
    "categoryId" : "3000000000017",
    "status" : "PUBLISHED"
  }, {
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "latestCommentTime" : "2013-11-04T11:21:07.000Z",
    "subject" : "Welcome to Community",
    "likeCount" : "0",
    "label" : "NOSTATUS",
    "isVoted" : true,
    "type" : "ANNOUNCEMENT",
    "content" : "<p>The Community hub inside Zoho Desk lets you build a powerful community around your business, while still serving customers via other channels.",
    "commentCount" : "0",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "lastCommenter" : {
      "name" : "User - 2",
      "id" : "4000000008733",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "SUPPORTREP"
    },
    "viewCount" : "1",
    "id" : "3000000000035",
    "permalink" : "welcome-to-community",
    "categoryId" : "3000000000017",
    "status" : "PUBLISHED"
  } ]
}

Get Single Topic

Get Single Topic (include=attachements)

QueryParams

include

string

Additional information related to the topics. Values allowed are: @seo@, @featuredImage@ and @attachments@

GET portal/api/communityTopics/{id}

Request Example

https://desk.zoho.com/portal/api/communityTopics/{id}?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "attachments" : [ {
    "size" : "1024",
    "name" : "New Attachment.jpeg",
    "id" : "8651"
  }, {
    "size" : "1024",
    "name" : "Sample Attachment.jpeg",
    "id" : "8661"
  } ],
  "subject" : "First Post",
  "isDraft" : false,
  "likeCount" : "1",
  "type" : "QUESTION",
  "isSticky" : true,
  "content" : "First Post",
  "bestCommentId" : "3000000254017",
  "isLocked" : false,
  "createdTime" : "2013-11-04T11:21:07.000Z",
  "id" : "3000000000059",
  "tag" : [ {
    "name" : "Java EE",
    "permalink" : "java-ee"
  }, {
    "name" : "Python",
    "permalink" : "python"
  } ],
  "viewCount" : "8",
  "seo" : {
    "keywords" : "community, topic",
    "useTitleAsPageTitle" : true,
    "description" : "community topic seo",
    "title" : "community topic seo"
  },
  "creator" : {
    "photoUrl" : null,
    "name" : "User - 1",
    "id" : "4000000008734",
    "label" : {
      "preferences" : {
        "shape" : "RECTANGLE",
        "bgColor" : "#23F123",
        "textColor" : "#2CA123"
      },
      "name" : "Admin",
      "id" : "6000000158001",
      "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
    },
    "type" : "ENDUSER"
  },
  "isFollowing" : false,
  "ticket" : {
    "no" : "103",
    "id" : "300000003"
  },
  "label" : "ANSWERED",
  "isVoted" : false,
  "commentCount" : "2",
  "featuredImage" : {
    "imageId" : "4000000019009"
  },
  "webUrl" : "https://desk.zoho.com/portal/portalname/en/community/topic/first-post",
  "followersCount" : "0",
  "permalink" : "first-post",
  "categoryId" : "3000000000017",
  "notifyMe" : true,
  "status" : "PUBLISHED"
}

List all category

API to get all helpcenter visible categories

GET portal/api/communityCategory

Request Example

https://desk.zoho.com/portal/api/communityCategory?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "isFollowing" : true,
    "visibility" : "GROUPS",
    "description" : "Get your questions answered here!",
    "commentCount" : "2",
    "photoUrl" : null,
    "permissions" : [ "POST", "RESPOND" ],
    "isLocked" : false,
    "name" : "samsungs7",
    "postCount" : "3",
    "parentCategoryId" : null,
    "id" : "3000000000017",
    "followersCount" : "2",
    "position" : "1",
    "permalink" : "samsungs7",
    "child" : [ {
      "isFollowing" : true,
      "visibility" : "GROUPS",
      "description" : null,
      "commentCount" : "2",
      "photoUrl" : null,
      "permissions" : [ "POST", "RESPOND" ],
      "isLocked" : false,
      "name" : "Subforum1",
      "postCount" : "3",
      "parentCategoryId" : "3000000000017",
      "id" : "3000000000033",
      "followersCount" : "2",
      "position" : "1",
      "permalink" : "subForum1",
      "child" : [ ]
    } ]
  } ]
}

Get a category

API to get a category by Id

GET portal/api/communityCategory/{id}

Request Example

https://desk.zoho.com/portal/api/communityCategory/{id}?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "isFollowing" : false,
    "visibility" : "ALL_USERS",
    "description" : "Get your questions answered here!",
    "commentCount" : "2",
    "photoUrl" : null,
    "permissions" : [ "POST", "RESPOND" ],
    "isLocked" : false,
    "name" : "samsungs7",
    "postCount" : "3",
    "parentCategoryId" : null,
    "id" : "3000000000017",
    "followersCount" : "2",
    "position" : "1",
    "permalink" : "samsungs7",
    "child" : [ {
      "isFollowing" : true,
      "visibility" : "ALL_USERS",
      "description" : null,
      "commentCount" : "2",
      "photoUrl" : null,
      "permissions" : [ "POST", "RESPOND" ],
      "isLocked" : false,
      "name" : "Subforum1",
      "postCount" : "3",
      "parentCategoryId" : "3000000000017",
      "id" : "3000000000033",
      "followersCount" : "2",
      "position" : "1",
      "permalink" : "subForum1"
    } ]
  } ]
}

List all Top Contributors

Get Top Contributors of Community

QueryParams

categoryId

long

Id of category from which topics are to be retrieved

limit

int

Limit of Contributors to be retrieved

GET portal/api/communityTopContributors

Request Example

https://desk.zoho.comportal/api/communityTopContributors?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "photoUrl" : null,
    "name" : "User - 1",
    "id" : "400001",
    "label" : {
      "preferences" : {
        "shape" : "RECTANGLE",
        "bgColor" : "#23F123",
        "textColor" : "#2CA123"
      },
      "name" : "Admin",
      "id" : "6000000158001",
      "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
    },
    "type" : "ENDUSER"
  }, {
    "photoUrl" : null,
    "name" : "User - 2",
    "id" : "400003",
    "label" : {
      "preferences" : {
        "shape" : "RECTANGLE",
        "bgColor" : "#23F123",
        "textColor" : "#2CA123"
      },
      "name" : "Admin",
      "id" : "6000000158001",
      "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
    },
    "type" : "SUPPORTREP"
  } ]
}

List All Comments

API to get comments of a Topic

QueryParams

from

int

Index from which list is retrieved and it starts from 1

limit

int

Limit of comments to retrieve

startTime

date

Start time of user Comments. Start time should be in GMT time zone

endTime

date

end time of user Comments. End time should be in GMT time zone

isDescending

boolean

Sort list of comments by Ascending or Descending

GET portal/api/communityTopics/{id}/comments

Request Example

https://desk.zoho.com/portal/api/communityTopics/{id}/comments?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "modifiedTime" : "2015-09-28T08:23:25.688Z",
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "attachments" : [ {
      "size" : "1024",
      "name" : "New Attachment.jpeg",
      "id" : "8651"
    } ],
    "replies" : [ ],
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "id" : "100001",
    "content" : "Welcome to Zoho",
    "status" : "PUBLISHED"
  }, {
    "modifiedTime" : "2015-09-28T08:23:25.688Z",
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "attachments" : [ {
      "size" : "1024",
      "name" : "New Attachment.jpeg",
      "id" : "8651"
    } ],
    "replies" : [ ],
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "id" : "100002",
    "content" : "Zoho Desk-Put customer service at the heart of your company",
    "status" : "PUBLISHED"
  }, {
    "modifiedTime" : "2015-09-28T08:23:25.688Z",
    "attachments" : [ {
      "size" : "1024",
      "name" : "New Attachment.jpeg",
      "id" : "8651"
    } ],
    "replies" : [ {
      "modifiedTime" : "2015-09-28T08:23:25.688Z",
      "creator" : {
        "photoUrl" : null,
        "name" : "User - 1",
        "id" : "4000000008734",
        "label" : {
          "preferences" : {
            "shape" : "RECTANGLE",
            "bgColor" : "#23F123",
            "textColor" : "#2CA123"
          },
          "name" : "Admin",
          "id" : "6000000158001",
          "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
        },
        "type" : "ENDUSER"
      },
      "attachments" : [ {
        "size" : "1024",
        "name" : "New Attachment.jpeg",
        "id" : "8651"
      } ],
      "createdTime" : "2013-11-04T11:21:07.000Z",
      "id" : "1005",
      "content" : "My first reply",
      "status" : "PUBLISHED"
    } ],
    "creatorId" : "4000006",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "id" : "1004",
    "content" : "This is a new Comment",
    "status" : "PUBLISHED"
  } ]
}

Get Comment

Get a Comment

GET portal/api/communityTopics/{id}/comments/{id}

Request Example

https://desk.zoho.com/portal/api/communityTopics/{id}/comments/{id}?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "modifiedTime" : "2019-03-05T10:50:03.387Z",
  "creator" : {
    "photoUrl" : null,
    "name" : "User - 1",
    "id" : "4000000008734",
    "label" : {
      "preferences" : {
        "shape" : "RECTANGLE",
        "bgColor" : "#23F123",
        "textColor" : "#2CA123"
      },
      "name" : "Admin",
      "id" : "6000000158001",
      "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
    },
    "type" : "ENDUSER"
  },
  "attachments" : [ {
    "size" : "1024",
    "name" : "New Attachment.jpeg",
    "id" : "8651"
  } ],
  "replies" : [ {
    "modifiedTime" : "2019-03-05T10:50:03.387Z",
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "attachments" : [ {
      "size" : "1024",
      "name" : "New Attachment.jpeg",
      "id" : "8651"
    } ],
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "id" : "1005",
    "content" : "My first reply",
    "status" : "PUBLISHED"
  } ],
  "createdTime" : "2013-11-04T11:21:07.000Z",
  "id" : "1004",
  "content" : "This is a new Comment",
  "status" : "PUBLISHED"
}

Most Discussed Topics

Get Most Discussed Topics (type=IDEA|QUESTION|PROBLEM|ANNOUNCEMENT, categoryId = 3000006,from=1,limit=5)

QueryParams

categoryId

long

Id of category from which topics are to be retrieved

from

int

Index from which list is retrieved and it starts from 1

limit

int

Number of topics to list.

type

String

Topic Type – Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION

GET portal/api/mostDiscussedCommunityTopics

Request Example

https://desk.zoho.com/portal/api/mostDiscussedCommunityTopics?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "latestCommentTime" : "2013-11-04T11:21:07.000Z",
    "subject" : "First Post",
    "likeCount" : "1",
    "label" : "ANSWERED",
    "isVoted" : true,
    "type" : "QUESTION",
    "content" : "First Post",
    "commentCount" : "2",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "lastCommenter" : {
      "name" : "User - 2",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "SUPPORTREP"
    },
    "id" : "3000000000059",
    "permalink" : "first-post",
    "categoryId" : "3000000000017",
    "status" : "PUBLISHED"
  }, {
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "latestCommentTime" : "2013-11-04T11:21:07.000Z",
    "subject" : "Welcome to Community",
    "likeCount" : "0",
    "label" : "NOSTATUS",
    "isVoted" : true,
    "type" : "ANNOUNCEMENT",
    "content" : "<p>The Community hub inside Zoho Desk lets you build a powerful community around your business, while still serving customers via other channels.",
    "commentCount" : "0",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "lastCommenter" : {
      "name" : "User - 2",
      "id" : "4000000008733",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "SUPPORTREP"
    },
    "id" : "3000000000035",
    "permalink" : "welcome-to-community",
    "categoryId" : "3000000000017",
    "status" : "PUBLISHED"
  } ]
}

Most Popular Topics

Get Most Popular Topics (type=IDEA|QUESTION|PROBLEM|ANNOUNCEMENT, categoryId = 3000006,from=1,limit=5)

QueryParams

categoryId

long

Id of category from which topics are to be retrieved

from

int

Index from which list is retrieved and it starts from 1

limit

int

Number of topics to list.

type

String

Topic Type – Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION

GET portal/api/mostPopularCommunityTopics

Request Example

https://desk.zoho.com/portal/api/mostPopularCommunityTopics?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "latestCommentTime" : "2013-11-04T11:21:07.000Z",
    "subject" : "First Post",
    "likeCount" : "1",
    "label" : "ANSWERED",
    "isVoted" : true,
    "type" : "QUESTION",
    "content" : "First Post",
    "commentCount" : "2",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "lastCommenter" : {
      "name" : "User - 2",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "SUPPORTREP"
    },
    "id" : "3000000000059",
    "permalink" : "first-post",
    "categoryId" : "3000000000017",
    "status" : "PUBLISHED"
  }, {
    "creator" : {
      "photoUrl" : null,
      "name" : "User - 1",
      "id" : "4000000008734",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "latestCommentTime" : "2013-11-04T11:21:07.000Z",
    "subject" : "Welcome to Community",
    "likeCount" : "0",
    "label" : "NOSTATUS",
    "isVoted" : true,
    "type" : "ANNOUNCEMENT",
    "content" : "<p>The Community hub inside Zoho Desk lets you build a powerful community around your business, while still serving customers via other channels.",
    "commentCount" : "0",
    "createdTime" : "2013-11-04T11:21:07.000Z",
    "lastCommenter" : {
      "name" : "User - 2",
      "id" : "4000000008733",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "SUPPORTREP"
    },
    "id" : "3000000000035",
    "permalink" : "welcome-to-community",
    "categoryId" : "3000000000017",
    "status" : "PUBLISHED"
  } ]
}

Topic search

API to search community topics

QueryParams

searchStr

string

The String to be searched

from

int

from limit from which records to be fetched

limit

int

Number of records to be fetched

type

String

topic Type

categoryId

long

category in which topic is to be searched

sortBy

String

SortBy can be: @relevance@, @createdTime@

isDescending

boolean

Sort list of search results by Ascending or Descending

GET portal/api/communityTopics/search

Request Example

https://desk.zoho.com/portal/api/communityTopics/search?portalId=ae075d0de8621f986c07c1fe256e4243&searchStr=test

Response Example

{
  "data" : [ {
    "creator" : {
      "photoUrl" : "https://desk.zoho.com/portal/api/user/1310000000033001/photo",
      "name" : "User - 1",
      "id" : "1310000000033001",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#23F123",
          "textColor" : "#2CA123"
        },
        "name" : "Admin",
        "id" : "6000000158001",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
      },
      "type" : "ENDUSER"
    },
    "isFollowing" : false,
    "ticket" : {
      "number" : "665",
      "id" : "1310000001519003"
    },
    "subject" : "test123",
    "module" : "Community",
    "isDraft" : false,
    "likeCount" : "2",
    "label" : "NOSTATUS",
    "isVoted" : false,
    "type" : "QUESTION",
    "isSticky" : false,
    "content" : "testttttt",
    "commentCount" : "1",
    "isLocked" : false,
    "createdTime" : "2017-10-20T10:06:26.000Z",
    "tag" : [ ],
    "id" : "1226000000363014",
    "viewCount" : "2",
    "followersCount" : "0",
    "permalink" : "test123",
    "categoryId" : "1226000000121007",
    "status" : "PUBLISHED",
    "notifyMe" : true
  } ]
}

Knowledge Base

Knowledge base refers to the repository of help articles in your help desk. Help articles act as the first means of support and deliver self-service capabilities to your customers.

Example

{ }

List articles

This API lists a particular number of help articles, based on the limit specified.

QueryParams

categoryId

long

ID of the category to which the articles must belong

sortBy

string

Key that sorts articles by a particular attribute: createdTime, modifiedTime, likeCount, viewCount, or unlikeCount

from

int

Number of articles to list. Default value is 1.

limit

int

Number of articles to list

tag

string

Key that filters articles, based on tags

GET /portal/api/kbArticles

Request Example

https://desk.zoho.com/portal/api/kbArticles?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "summary" : "If you're looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories. Here's a list of Zylker showrooms - https://www.zylker.com/storefinder ",
    "modifiedTime" : "2019-11-04T05:10:46.000Z",
    "translationId" : "292101000000122001",
    "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
    "createdTime" : "2018-07-02T05:04:31.000Z",
    "id" : "292101000001113047",
    "category" : {
      "name" : "1",
      "id" : "292101000000216021",
      "locale" : "en"
    },
    "title" : "Buying a detachable keyboard",
    "permalink" : "buying-a-detachable-keyboard",
    "locale" : "en",
    "categoryId" : "292101000000216021",
    "rootCategoryId" : "292101000000088379"
  }, {
    "summary" : "While the device has been designed for a great battery life of 10 hours of use on a full charge, we would recommend using these following tips for saving battery life. 1. Turn off WiFi when you're not using it. 2. Turn off 3G in case you're on WiFi. 3. Turn ",
    "modifiedTime" : "2019-11-04T05:10:46.000Z",
    "translationId" : "292101000000200029",
    "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/tips-to-save-zpad-battery-life",
    "createdTime" : "2018-09-08T06:52:36.000Z",
    "id" : "292101000001113049",
    "category" : {
      "name" : "1",
      "id" : "292101000000216021",
      "locale" : "en"
    },
    "title" : "Tips to save zPad battery life",
    "permalink" : "tips-to-save-zpad-battery-life",
    "locale" : "en",
    "categoryId" : "292101000000216021",
    "rootCategoryId" : "292101000000088379"
  } ]
}

Get article

This API fetches a single help article from the knowledge base.

QueryParams

GET /portal/api/kbArticles/{articles_id}

Request Example

https://desk.zoho.com/portal/api/kbArticles/292101000001113049?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "summary" : "Looking for a detachable keyboard for your zPad",
  "modifiedTime" : "2019-11-04T05:10:46.000Z",
  "myVote" : null,
  "author" : {
    "photoURL" : "https://desk.zoho.com/api/v1/agents/292101000000088033/photo?orgId=669661594",
    "name" : "Yod Agbaria",
    "id" : "292101000000088033",
    "status" : "ACTIVE",
    "zuid" : "32435"
  },
  "departmentId" : "292101000000006907",
  "dislikeCount" : "2",
  "likeCount" : "110",
  "title" : "Buying a detachable keyboard",
  "locale" : "en",
  "tags" : [ "detachable keyboard", "zpad", "zboard", "accessory" ],
  "rootCategoryId" : "292101000000088379",
  "locales" : [ {
    "apiUrl" : "https://desk.zoho.com/portal/api/kbArticles/292101000001113049/locale/en?portalId=ae075d0de8621f986c07c1fe256e4243",
    "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
    "permalink" : "buying-a-detachable-keyboard",
    "locale" : "en"
  } ],
  "answer" : "If you're looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories.<br /><br />Here&#39;s a list of Zylker showrooms - https://www.zylker.com/storefinder<br /><br />You can drop in any time between 10:00 AM and 10:00 PM, any day, to pick out a zBoard.<br />",
  "translationId" : "292101000000200029",
  "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
  "createdTime" : "2018-09-08T06:52:36.000Z",
  "id" : "292101000001113049",
  "category" : {
    "name" : "1",
    "id" : "292101000000216021",
    "locale" : "en"
  },
  "permalink" : "buying-a-detachable-keyboard",
  "seo" : {
    "keywords" : "zPad, detachable keyboard, accessory, zBoard",
    "isEnabled" : true,
    "description" : "Follow these steps for buying a detachable keyboard.",
    "title" : "Buying a detachable keyboard"
  },
  "categoryId" : "292101000000216021"
}

Get article translation

This API fetches a single help article from the knowledge base based on locale.

QueryParams

GET /portal/api/kbArticles/{articles_id}/locale/{locale}

Request Example

https://desk.zoho.com/portal/api/kbArticles/292101000001113049/locale/en?portalId=edbsn9f6fab66f372a985f9c6787692a0b53dda6a5e6aa52db4477786bb56a42f1775f5f6e

Response Example

{
  "summary" : "If you're looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories. Here's a list of Zylker showrooms - https://www.zylker.com/storefinder ",
  "modifiedTime" : "2019-11-04T05:10:46.000Z",
  "myVote" : null,
  "author" : {
    "photoURL" : "https://desk.zoho.com/api/v1/agents/292101000000088033/photo?orgId=669661594",
    "name" : "Yod Agbaria",
    "id" : "292101000000088033",
    "status" : "ACTIVE",
    "zuid" : "32435"
  },
  "departmentId" : "292101000000006907",
  "dislikeCount" : "2",
  "likeCount" : "110",
  "title" : "Buying a detachable keyboard",
  "locale" : "en",
  "tags" : [ "detachable keyboard", "zpad", "zboard", "accessory" ],
  "rootCategoryId" : "292101000000088379",
  "locales" : [ {
    "apiUrl" : "https://desk.zoho.com/portal/api/kbArticles/292101000001113049/locale/en?portalId=edbsn9f6fab66f372a985f9c6787692a0b53dda6a5e6aa52db4477786bb56a42f1775f5f6e",
    "webUrl" : "https://desk.zoho.com/portal/zylker/en/kb/articles/buying-a-detachable-keyboard",
    "permalink" : "buying-a-detachable-keyboard",
    "locale" : "en"
  } ],
  "answer" : "If you&#39;re looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories.<br /><br />Here&#39;s a list of Zylker showrooms - https://www.zylker.com/storefinder<br /><br />You can drop in any time between 10:00 AM and 10:00 PM, any day, to pick out a zBoard.<br />",
  "translationId" : "292101000000200029",
  "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
  "createdTime" : "2018-09-08T06:52:36.000Z",
  "id" : "292101000001113049",
  "category" : {
    "name" : "1",
    "id" : "292101000000216021",
    "locale" : "en"
  },
  "permalink" : "buying-a-detachable-keyboard",
  "seo" : {
    "keywords" : "zPad, detachable keyboard, accessory, zBoard",
    "isEnabled" : true,
    "description" : "Follow these steps for buying a detachable keyboard.",
    "title" : "Buying a detachable keyboard"
  },
  "categoryId" : "292101000000216021"
}

Like article

This API records a like (positive reaction) on an article.

POST /portal/api/kbArticles/{articles_id}/locale/{locale}/like

Request Example

https://desk.zoho.com/portal/api/kbArticles/124611000000081039/locale/en/like?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

Dislike article

This API records an unlike (negative reaction) on an article.

POST /portal/api/kbArticles/{articles_id}/locale/{locale}/dislike

Request Example

https://desk.zoho.com/portal/api/kbArticles/124611000000081039/locale/en/dislike?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

Create article feedback

This API adds a feedback to an article.

Attributes

string

Optional

Email ID in the feedback

feedback

string

Required

Content of the feedback

POST /portal/api/kbArticles/{articles_id}/locale/{locale}/feedbacks

Request Example

https://desk.zoho.com/portal/api/kbArticles/124611000000081039/locale/en/feedbacks?portalId=ae075d0de8621f986c07c1fe256e4243

{
  "feedback" : "The Article is considering these constraints 1. 2. 3 . 4 ",
  "email" : "example@zylker.com"
}

Response Example

List article attachments

This API lists the files attached to help articles in the knowledge base.

GET /portal/api/kbArticles/{articles_id}/locale/{locale}/attachments

Request Example

https://desk.zoho.com/portal/api/kbArticles/180757000000724067/locale/en/attachments?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "contentUrl" : "https://desk.zoho.com/portal/api/kbArticles/180757000000724067/attachments/798cydff5ee6cad9600a9/content?portalId=ae075d0de8621f986c07c1fe256e4243",
    "size" : "733983",
    "name" : "DemoImage.png",
    "createdTime" : "2018-06-06T09:10:05.288Z",
    "inlineUrl" : "https://desk.zoho.com/portal/api/kbArticles/180757000000724067/attachments/798cydff5ee6cad9600a9/content?portalId=ae075d0de8621f986c07c1fe256e4243&inline=true",
    "id" : "798cydff5ee6cad9600a9"
  } ]
}

Search articles

This API searches for articles in the knowledge base.

QueryParams

categoryId

long

ID of the category to which the articles must belong

from

int

Index number, starting from which the articles must be fetched. Default value is 1.

limit

int

Number of articles to list in the search result

searchStr

string

Keyword to use for the search

GET /portal/api/kbArticles/search

Request Example

https://desk.zoho.com/portal/api/kbArticles/search?portalId=ae075d0de8621f986c07c1fe256e4243&searchStr=first ticket

Response Example

{
  "data" : [ {
    "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 time on frequently asked questions.<br><br>Every action that you can perform with respect to a ticket has a corresponding keyboard shortcut.",
    "modifiedTime" : "2019-11-04T05:10:46.000Z",
    "translationId" : "292101000000332013",
    "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/articles/answering-your-first-ticket",
    "createdTime" : "2018-12-27T06:58:26.000Z",
    "id" : "292101000001113069",
    "category" : {
      "name" : "1",
      "id" : "292101000000216021",
      "locale" : "en"
    },
    "title" : "Answering your first ticket.",
    "permalink" : "answering-your-first-ticket",
    "locale" : "en",
    "categoryId" : "292101000000216021",
    "rootCategoryId" : "292101000000088379"
  } ]
}

List article comments

This API lists the comments recorded in an article.

QueryParams

from

integer

Index number, starting from which the comments must be listed. Default value is 1.

limit

integer

Number of comments to list

sortBy

string

Key that sorts comments by the @commentedTime@ attribute. The default sorting order is ascending. @-commentedTime@ denotes a descending order of sorting.

GET /portal/api/kbArticles/([0-9]+)/locale/{locale}/comments

Request Example

https://desk.zoho.com/portal/api/kbArticles/17883000000493017/locale/en/comments?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "data" : [ {
    "modifiedTime" : "2023-01-04T10:12:14.000Z",
    "attachments" : [ {
      "previewurl" : "https://desk.zoho.com/api/v1/articles/46582000006958052/translations/en/attachments/nmhny14ce774984eb4b15891e1cbe274e612c/content?orgId=57044830",
      "size" : "201878",
      "name" : "Screenshot 2023-04-19 at 7.20.36 PM.png",
      "id" : "24073000008264012",
      "href" : "https://downloadserver.zoho.com/webdownload?x-service=deskplus1&event-id=3cb824d012e17e4e21e086e01cadf03f5d9b8d4bbdb1a4ee2c4ee2708e8a7e56158909640682800e7b245567a25150e3733b5af31c2a760c2cfe37f94db91cdf&x-cli-msg={\"s\":1,\"portalname\":\"portalusers\"}"
    } ],
    "hashtags" : [ {
      "offSet" : "291",
      "length" : "38",
      "headerValue" : "links",
      "headerId" : "links"
    } ],
    "commentedTime" : "2023-01-04T10:12:14.000Z",
    "mentions" : {
      "groups" : [ {
        "offSet" : "453",
        "name" : "Uyiraeeee",
        "length" : "28",
        "id" : "5000000113013",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n9"
      } ],
      "users" : [ {
        "photoURL" : "https://desk.zoho.com/api/v1/portalUser/5000000040367/photo?orgId=15921207",
        "offSet" : "39",
        "webUrl" : "https://desk.zoho.com/portal/zohocorp/en/community/user/5000000040367",
        "name" : "John",
        "length" : "27",
        "id" : "5000000040367",
        "label" : {
          "preferences" : {
            "shape" : "RECTANGLE",
            "bgColor" : "#5C6368",
            "textColor" : "#FFFFFF"
          },
          "name" : "MVP",
          "id" : "5000000081007",
          "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n9"
        },
        "type" : "END_USER",
        "zuid" : "1026185340",
        "kbRole" : "REVIEWER"
      } ]
    },
    "id" : "5000000130005",
    "contentType" : "html",
    "content" : "<div>Hello zsu[@enduser:1026185340]zsu,<br></div><div><br></div><div><br></div><div>zsh[#link:links]zsh<br></div><div><br></div><div><br></div><div>Thanks &; Regards,<br></div><div>zsu[@group:5000000113013]zsu<br></div><div><br></div><div>Tried on 03/01/23 1:30PM<br></div><div><br></div>",
    "commenter" : {
      "photoURL" : "https://desk.zoho.com/api/v1/agents/5000000000347/photo?orgId=15921207",
      "webUrl" : "https://portalusers.helpcenter.zohodesk.com/portal/ta/community/user/24073000007484023",
      "name" : "Zylker",
      "id" : "5000000000347",
      "label" : {
        "preferences" : {
          "shape" : "RECTANGLE",
          "bgColor" : "#5C6368",
          "textColor" : "#FFFFFF"
        },
        "name" : "MVP",
        "id" : "5000000081009",
        "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n9"
      },
      "type" : "AGENT",
      "kbRole" : "REVIEWER"
    }
  } ]
}

Search articles by tag

This API searches for articles with a particular tag.

QueryParams

categoryId

long

ID of the category to which the articles must belong

from

int

Index number, starting from which the articles must be fetched. Default value is 1

limit

int

Number of articles to list in the search result

tag

string

Key that filters articles, based on tags

GET /portal/api/kbArticles/searchByTag

Request Example

https://desk.zoho.com/portal/api/kbArticles/searchByTag?portalId=3baf28131e9f8df2ce65d95ccc7819577594b0b7b4bb480af57d9b02e22471ff&tag=asdasdasd

Response Example

{
  "data" : [ {
    "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 time on ",
    "webUrl" : "https://desk.zoho.com/portal/yahya1608/kb/articles/answering-your-first-tickets",
    "id" : "180757000000069120",
    "title" : "Answering your first ticket.",
    "permalink" : "answering-your-first-tickets",
    "categoryId" : "180757000000604004"
  } ]
}

List all root categories of the helpcenter

List all root categories (UnAuthenticated URL)

QueryParams

from

integer

The from index. from starts with 1, not 0.

limit

integer

the limit index

sortBy

String

Sort order of the categories. Allowed values : name, order

searchValue

string

Search value

visibility

string

Search value to be searched in name

departmentId

Long

Department Id

hasArticles

boolean

This flag when set to true fetches only categories with articles

include

String

Include allowed values are allArticleCount or sectionsCount

GET /portal/api/kbRootCategories

Request Example

/portal/api/kbRootCategories?portalId=ae075d0de8621f986c07c1fe256e4243&limit=10

Response Example

{
  "data" : [ {
    "visibility" : "ALL_USERS",
    "articleViewType" : "LISTVIEW",
    "description" : "Engineering zone",
    "sectionsCount" : "1",
    "translatedName" : "Engineering zone",
    "locale" : "en",
    "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
    "associatedDepartmentIds" : [ "5000000063895" ],
    "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/engineering-zone",
    "name" : "Engineering zone",
    "id" : "5000000066427",
    "articlesCount" : "2",
    "permalink" : "engineering-zone"
  } ]
}

Get root category tree

To get complete category tree

QueryParams

sortBy

String

Sort order of the categories. Allowed values : name, order

include

String

Allowed values are allArticleCount, sectionsCount

hasArticles

boolean

This flag when set to true fetches only categories with articles

GET /portal/api/kbRootCategories/{rootCategoryId}/categoryTree

Request Example

/portal/api/kbRootCategories/5000000066427/categoryTree?include=allArticleCount&portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "visibility" : "ALL_USERS",
  "articleViewType" : "LISTVIEW",
  "level" : "1",
  "description" : "Engineering zone",
  "translatedDescription" : "Engineering zone",
  "translatedName" : "Engineering zone",
  "locale" : "en",
  "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
  "associatedDepartmentIds" : [ "59210100006907" ],
  "rootCategoryId" : "5000000066427",
  "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/engineering-zone",
  "name" : "Engineering zone",
  "parentCategoryId" : null,
  "id" : "5000000066427",
  "articlesCount" : "0",
  "permalink" : "engineering-zone",
  "child" : [ {
    "visibility" : "ALL_USERS",
    "level" : "2",
    "description" : "Design pattern analysis",
    "translatedDescription" : "Design pattern analysis",
    "translatedName" : "Design pattern analysis",
    "locale" : "en",
    "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
    "rootCategoryId" : "5000000066427",
    "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/engineering-zone/design-patterns",
    "name" : "Design pattern analysis",
    "parentCategoryId" : "5000000066427",
    "id" : "5000000215001",
    "articlesCount" : "2",
    "permalink" : "design-patterns",
    "child" : [ ]
  }, {
    "visibility" : "ALL_USERS",
    "level" : "2",
    "description" : "Design pattern analysis",
    "translatedDescription" : "Design pattern analysis",
    "translatedName" : "General",
    "locale" : "en",
    "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
    "rootCategoryId" : "5000000066427",
    "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/engineering-zone/general",
    "name" : "General",
    "parentCategoryId" : "5000000066427",
    "id" : "5000000016204",
    "articlesCount" : "0",
    "permalink" : "general",
    "child" : [ ]
  }, {
    "visibility" : "ALL_USERS",
    "level" : "2",
    "description" : "Design pattern analysis",
    "translatedDescription" : "Design pattern analysis",
    "translatedName" : "Review methodology",
    "locale" : "en",
    "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
    "rootCategoryId" : "5000000066427",
    "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/engineering-zone/reviews",
    "name" : "Review methodology",
    "parentCategoryId" : "5000000066427",
    "id" : "5000000340014",
    "articlesCount" : "0",
    "permalink" : "reviews",
    "child" : [ {
      "visibility" : "ALL_USERS",
      "level" : "3",
      "description" : "Design pattern analysis",
      "translatedDescription" : "Design pattern analysis",
      "translatedName" : "Waterfall",
      "locale" : "en",
      "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
      "rootCategoryId" : "5000000066427",
      "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/engineering-zone/reviews/waterfall",
      "name" : "Waterfall",
      "parentCategoryId" : "5000000340014",
      "id" : "5000000341001",
      "articlesCount" : "0",
      "permalink" : "waterfall",
      "child" : [ ]
    } ]
  } ]
}

Gamification

Gamification APIs

Example

{ }

Get user gamification info

Get particular user's gamification Data

GET portal/api/users/{id}/gameAchievements

Request Example

https://desk.zoho.com/portal/api/users/123/gameAchievements?portalId=ae075d0de8621f986c07c1fe256e4243

Response Example

{
  "level" : {
    "name" : "level2",
    "id" : "2"
  },
  "nextLevel" : {
    "pointsToReach" : "200",
    "name" : "Level3"
  },
  "badgeCount" : "2",
  "points" : "100"
}

Get all badges

Get list of badges that user obtained

QueryParams

from

int

Index from which the list is to be retrieved and it should start from 1

limit

int

No. of records

sortBy

string

Sort by the @createdTime@ attribute. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.

startTime

date

Start time should be in GMT time zone

endTime

date

End time should be in GMT time zone

GET /portal/api/users/([0-9]+)/badges

Request Example

https://desk.zoho.com/portal/api/users/([0-9]+)/badges

Response Example

{
  "data" : [ {
    "name" : "Cs Tiger",
    "description" : "Cs Tiger",
    "id" : "1",
    "iconUrl" : null
  }, {
    "name" : "Tenkasi Terrors",
    "description" : "Tenkasi Terrors",
    "id" : "2",
    "iconUrl" : null
  } ]
}

Get user ScoreBoard

Get user's actionwise points

GET /portal/api/users/([0-9]+)/scoreBoard

Request Example

https://desk.zoho.com/portal/api/users/([0-9]+)/scoreBoard

Response Example

{
  "data" : [ {
    "pointsEarned" : "3560",
    "name" : "Add Question",
    "description" : "Points will be given when a user post a Question"
  }, {
    "pointsEarned" : "230",
    "name" : "Add Idea",
    "description" : "Points will be given when a user post an Idea"
  }, {
    "pointsEarned" : "500",
    "name" : "Add Problem",
    "description" : "Points will be given when a user post an Problem"
  }, {
    "pointsEarned" : "600",
    "name" : "Add Reply",
    "description" : "Points will be given when a user reply to the post"
  }, {
    "pointsEarned" : "100",
    "name" : "Follow Topic",
    "description" : "Points will be given when a user Follow a topic"
  }, {
    "pointsEarned" : "100",
    "name" : "Profile Info Update",
    "description" : "Points will be given when a user update his profie info"
  }, {
    "pointsEarned" : "100",
    "name" : "Profile Photo Update",
    "description" : "Points will be given when a user update his profie photo"
  }, {
    "pointsEarned" : "100",
    "name" : "User Follower",
    "description" : "Points will be given when a user has been followed by another user"
  } ]
}

Get all Custom Credits

Get list of Custom Credits that user obtained

QueryParams

from

int

Index from which the list is to be retrieved and it should start from 1

limit

int

No. of records

sortBy

string

Sort by the @createdTime@ attribute. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.

startTime

date

Start time should be in GMT time zone

endTime

date

End time should be in GMT time zone

GET /portal/api/users/([0-9]+)/customCredits

Request Example

https://desk.zoho.com/portal/api/users/([0-9]+)/customCredits

Response Example

{
  "data" : [ {
    "name" : "Custom Credit1",
    "description" : "Custom Credit1",
    "points" : "100"
  }, {
    "name" : "Custom Credit2",
    "description" : "Custom Credit2",
    "points" : "150"
  } ]
}

Extension

Error While Displaying Documentation null