{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Profile API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Profile",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get my profile details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/myProfile"
          },
          "docs": "This API fetches the configuration details and permissions defined for the profile of the currently logged in user."
        },
        {
          "info": {
            "name": "Get profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/profiles/:profileId",
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches the details of a particular profile."
        },
        {
          "info": {
            "name": "Update profile",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/profiles/:profileId",
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates the details of an existing profile."
        },
        {
          "info": {
            "name": "Get profile count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/profiles/count",
            "params": [
              {
                "name": "default",
                "value": "",
                "type": "query",
                "description": " Key that denotes whether the profiles must be default profiles or custom profiles"
              },
              {
                "name": "visible",
                "value": "",
                "type": "query",
                "description": "Key that filters profiles according to their visibility in the UI"
              }
            ]
          },
          "docs": "This API fetches the number of profiles configured in your help desk."
        },
        {
          "info": {
            "name": "Get light agent profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/lightAgentProfile"
          },
          "docs": "This API fetches the different permissions configured for the light agent profile."
        },
        {
          "info": {
            "name": "Clone profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/profiles/:profileId/clone",
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API replicates an existing profile."
        },
        {
          "info": {
            "name": "Delete profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/profiles/:profileId/delete",
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API deletes a profile from your help desk."
        },
        {
          "info": {
            "name": "List profiles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/profiles",
            "params": [
              {
                "name": "default",
                "value": "",
                "type": "query",
                "description": " Key that denotes whether the profiles must be default profiles or custom profiles"
              },
              {
                "name": "visible",
                "value": "",
                "type": "query",
                "description": "Key that filters profiles according to their visibility in the UI"
              },
              {
                "name": "searchStr",
                "value": "",
                "type": "query",
                "description": "String to search for profile by name or description. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for profiles whose name or description start with the string, 2) *string* - Searches for profiles whose name or description contain the string, 3) string -  Searches for profiles whose name or description is an exact match for the string"
              }
            ]
          },
          "docs": "This API lists a particular number of user profiles, based on the limit specified."
        },
        {
          "info": {
            "name": "Get my profile permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/myProfilePermissions"
          },
          "docs": "This API fetches the permissions associated with the profile of the currently logged in user."
        },
        {
          "info": {
            "name": "List agents by profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/profiles/:profileId/agents",
            "params": [
              {
                "name": "active",
                "value": "",
                "type": "query",
                "description": "Activation status of the agents to list"
              },
              {
                "name": "confirmed",
                "value": "",
                "type": "query",
                "description": "Confirmation status of the agents to list"
              },
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists agents mapped to a particular profile."
        }
      ]
    }
  ],
  "bundled": true
}