{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter CommunityCategory API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "CommunityCategory",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Disable community category or forum",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityCategory/:categoryId/disable",
            "params": [
              {
                "name": "categoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API disables a community category or forum and restricts posting access to users."
        },
        {
          "info": {
            "name": "Enable community category or forum",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityCategory/:categoryId/enable",
            "params": [
              {
                "name": "categoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API enables a community category or forum and provides posting access to users."
        },
        {
          "info": {
            "name": "List community categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityCategory",
            "params": [
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department for which the categories to be filtered."
              }
            ]
          },
          "docs": "This API lists a particular number of community categories."
        },
        {
          "info": {
            "name": "Follow a community category or forum",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityCategory/:categoryId/follow",
            "params": [
              {
                "name": "categoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API helps users to follow a community category or forum. "
        },
        {
          "info": {
            "name": "Unfollow a community category or forum",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityCategory/:categoryId/unfollow",
            "params": [
              {
                "name": "categoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API helps end-users unfollow a community category or forum."
        },
        {
          "info": {
            "name": "List followers of community category or forum",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityCategory/:categoryId/followers",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the users must be listed"
              },
              {
                "name": "userType",
                "value": "",
                "type": "query",
                "description": "to filter agent and end user"
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of users who follow a community category or forum, based on the limit defined."
        },
        {
          "info": {
            "name": "Get category or forum by permalink",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityCategoryByPermalink",
            "params": [
              {
                "name": "permalink",
                "value": "",
                "type": "query",
                "description": "Permalink of the category or forum to fetch"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional information related to the category or forum. Values allowed are: @postCount@, @followersCount@, and @commentCount@."
              }
            ]
          },
          "docs": "This API fetches the details of a community category or forum, based on the permalink in the API request. "
        },
        {
          "info": {
            "name": "Get community categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityCategory/:categoryId",
            "params": [
              {
                "name": "categoryId",
                "value": "",
                "type": "path"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional information related to the category or forum. Values allowed are: @postCount@, @followersCount@, and @commentCount@."
              }
            ]
          },
          "docs": "This API get a community categories details."
        }
      ]
    }
  ],
  "bundled": true
}