{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Label API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Label",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users under a label",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/labels/:labelId/users",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to list. The default value is 50 and the maximum value allowed is 100"
              },
              {
                "name": "searchBy",
                "value": "",
                "type": "query",
                "description": "Search keyword to use for finding a particular user. The keyword must contain at least two characters."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the users must be fetched. The default value is 1. "
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Key that sorts the list of users by a specific attribute: -(@assignedTime@)"
              },
              {
                "name": "labelId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of users under a label, based on the limit defined."
        },
        {
          "info": {
            "name": "List labels",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/labels",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to list. The default value is 50 and the maximum value allowed is 100"
              },
              {
                "name": "searchBy",
                "value": "",
                "type": "query",
                "description": "Search keyword to use for finding a particular user. The keyword must contain at least two characters."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the users must be fetched. The default value is 1. "
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Key that sorts the list of labels by a particular attribute: -(@createdTime@ or @modifiedTime@, or @name@)"
              },
              {
                "name": "helpCenterId",
                "value": "",
                "type": "query",
                "description": "ID of the help center from which the labels must be fetched"
              }
            ]
          },
          "docs": "This API lists a particular number of labels, based on the limit defined. "
        },
        {
          "info": {
            "name": "Create label",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/labels",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a label in your help center."
        },
        {
          "info": {
            "name": "Get details of label",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/labels/:labelId",
            "params": [
              {
                "name": "labelId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches the details of a particular label."
        },
        {
          "info": {
            "name": "Update label",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/labels/:labelId",
            "params": [
              {
                "name": "labelId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps update the details of a label."
        },
        {
          "info": {
            "name": "Delete label",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/labels/:labelId",
            "params": [
              {
                "name": "labelId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API deletes a label from your help center."
        },
        {
          "info": {
            "name": "Assign label to users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/labels/:labelId/users/add",
            "params": [
              {
                "name": "labelId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API assigns a particular label to multiple users."
        },
        {
          "info": {
            "name": "Remove users under a label",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/labels/:labelId/users/remove",
            "params": [
              {
                "name": "labelId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API removes all users under a particular label. "
        }
      ]
    }
  ],
  "bundled": true
}