---
title: "Return current user's cPanel application details"
method: GET
path: "/Branding/get_available_applications"
tags: ["Branding", "Application Information"]
---

# Return current user's cPanel application details

`GET /Branding/get_available_applications`

This function retrieves information about the groups and applications in the authenticated user's cPanel interface.

## Query parameters

- `nvarglist` string

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `default_group_order` object — An object that defines the default order of applications in cPanel.
      - `grouporder` string[] — A list of group IDs, in the order in which the groups appear.
      - `groups` object[] — Information about each group in the cPanel interface.
        - `desc` string — The group's description.
        - `group` string — The group's ID.
        - `items` object[] — The groups and their application details.
          - `acontent` string — The content of a tag in the application's link.
          - `base64_png_image` string, base64 image — The application's icon in Base64 format.
          - `feature` string — A feature name. The icon **only** displays if the cPanel user can access this feature.
          - `file` string — The application's icon's filename.
          - `group` string — The item's group.
          - `height` string — The application icon height, in pixels.
          - `if` string — An expression containing cPanel variables that determine whether to display the item. The function **only** returns this value if any variables exist. For example, `$isreseller` indicates that the item **only** displays for reseller accounts. For more information, read our [Guide to cPanel Variables documentation](https://go.cpanel.net/guidetovariables).
          - `imgtype` 'icon' — The item's image type. `icon` is the only possible value.
          - `implements` string — The `implements` name of the application. WHM API 1's `create_user_session` and `get_users_links` functions use this value.
          - `itemdesc` string — The application's display name.
          - `itemorder` string — The application's order in the `dynamicui.conf` file. This value represents the application's display order in cPanel's *Home* interface.
          - `module` string — The Perl module that the application requires.
          - `onclick` string — JavaScript function that the browser calls before or instead of URL navigation.
          - `searchtext` string — One or more space-separated search terms. The icon will display when users enter these search terms in the *Quick Find* text box in the cPanel interface.
          - `subtype` 'img' — The item's subtype. `img` is the only possible value.
          - `target` string — The target of the application's link.
          - `touch` string — Conditional arguments that determine whether to display the item, if a specified touch file exists.
          - `type` 'image' — The application's type. `image` is the only possible value.
          - `url` string, url-path — The path to which the application's icon links.
          - `width` string — The application's icon's width, in pixels.
      - `implements` object — An object mapping the `implements` names to Appkey values for applications in cPanel. For example, use this mapping to determine that the `implements` value `SSL_TLS_Status` maps to the Appkey value `tls_status`. **Note:** * The Appkey for an application can be found in the `key` attribute elsewhere in the API response. * The `implements` for an application can be found in the `implements` attribute elsewhere in the API response. * For more information about Appkey values, read our [Guide to cPanel Interface Customization - Appkeys](https://go.cpanel.net/paper-lantern-theme-guide-to-cpanel-interface-customization-appkeys) documentation.
      - `index` object — The applications and the order in which they appear in the cPanel interface.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/versions/632e2f8e6d04/schema)