{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter HelpcenterGroups API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "HelpcenterGroups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users in a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/groups/:groupId/users",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of users in a group, based on the limit defined."
        },
        {
          "info": {
            "name": "Get details of group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches the details of a particular user group."
        },
        {
          "info": {
            "name": "Update group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps update the details of a user group."
        },
        {
          "info": {
            "name": "Delete helpcenter user group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API deletes a user group from your help center."
        },
        {
          "info": {
            "name": "Remove users from group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/groups/:groupId/users/remove",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API removes particular users from a group. "
        },
        {
          "info": {
            "name": "List helpcenter groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/groups",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of groups to list. The default value and the maximum value allowed is 50."
              },
              {
                "name": "searchBy",
                "value": "",
                "type": "query",
                "description": "Search keyword to use for finding a particular group The keyword must contain at least two characters.        Three types of search are supported: @keyword*@ (search for values that start with the keyword, @*keyword*@ (search for values that contain the keyword),          and @keyword@ (search for values that are exact matches of the keyword)."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the groups must be fetched. The default value is 1. "
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Key that sorts the list of groups by a particular attribute: -(@createdTime@, @modifiedTime@, @name@, or @count@)"
              },
              {
                "name": "helpCenterId",
                "value": "",
                "type": "query",
                "description": "ID of the help center from which the resource must be fetched"
              }
            ]
          },
          "docs": "This API lists a particular number of groups, based on the limit defined."
        },
        {
          "info": {
            "name": "Create user groups",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a user group in your help center."
        },
        {
          "info": {
            "name": "Add users to group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/groups/:groupId/users/add",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds users to a particular group."
        }
      ]
    }
  ],
  "bundled": true
}