# cPanel API 2 Functions - Branding::showpkgs

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function lists available branding packages.

div
Note:

cPanel API 2's `Branding` module **only** modifies data for the x3 theme. We removed the x3 theme. For more information, read our cPanel Deprecation Plan documentation.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=showpkgs&onlyshowyours="0"&skipglobal="1"
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List all custom branding packages.
$list_branding_pkgs = $cpanel->api2(
    'Branding', 'showpkgs',
        array(        
            'onlyshowyours'      => '0',
            'skipglobal'         => '1',
    )
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List all custom branding packages.
my $list_branding_pkgs = $cpliveapi->api2(
    'Branding', 'showpkgs',
    {
            'onlyshowyours'      => '0',
            'skipglobal'         => '1',
    }
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Branding showpkgs onlyshowyours=0 skipglobal=1
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** run the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "showpkgs",
    "data": [
      {
        "disabled": 0,
        "types": [
          {
            "downloadlinktext": "Download (Yours)",
            "pkg": "mobile",
            "type": "yours"
          }
        ],
        "pkgname": "mobile",
        "previewsmimg": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mobile/previewsm.jpg",
        "selectopt": "selected",
        "pkgchecked": "checked",
        "previewimg": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mobile/preview.jpg",
        "pkg": "mobile",
        "selected": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}
```

div
Note:

Use cPanel's *API Shell* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
Input
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
onlyshowyours
td
em
Boolean
td
p
Whether to only return the user's branding packages.
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Only return branding packages that the user owns.
li
code
0
 — Return all branding packages.
td
code
0
tr
td
code
showroot
td
em
Boolean
td
p
Whether to only return system branding packages.
p
span
This parameter defaults to 
code
0
.
span
td
ul
li
code
1
 — Only return system branding packages.
li
code
0
 — Return all branding packages.
td
code
0
tr
td
code
skipglobal
td
em
Boolean
td
p
Whether to only return customized branding packages.
p
span
This parameter defaults to 
code
0
.
span
td
ul
li
code
1
 — Only return custom branding packages.
li
code
0
 — Return all branding packages.
td
code
1
tr
td
code
skiphidden
td
em
Boolean
td
p
Whether to only return branding packages that the user does not own.
p
span
This parameter defaults to 
code
0
.
span
td
ul
li
code
1
 — Only return unowned branding packages.
li
code
0
 — Return all branding packages.
td
code
0
## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
disabled
td
em
Boolean
td
Whether the branding package is disabled.
td
ul
li
code
1
 — Disabled.
li
code
0
 — Enabled.
td
code
0
tr
td
code
types
td
em
hash
td
p
A hash of branding package type information.
td
p
This hash includes the 
code
downloadlinktext
, 
code
pkg
, and 
code
type
 returns.
td
br
tr
td
p
code
downloadlinktext
td
em
string
td
p
The branding package's download link text.
p
The function returns this value in the 
code
types
 hash.
td
ul
li
code
Download (Yours)
li
code
Download (System)
td
code
Download (Yours)
tr
td
p
code
pkg
td
em
string
td
p
The branding package name.
p
span
The function returns this value in the 
code
types
span
 hash.
td
p
A string value.
td
code
mobile
tr
td
p
code
type
td
em
string
td
p
span
Whether the branding package is system-owned or user-owned.
p
span
The function returns this value in the 
code
types
span
 hash.
td
ul
li
code
system
li
code
yours
p
br
td
code
yours
tr
td
code
pkgname
td
em
string
td
The branding package name.
td
A string value.
td
code
mobile
tr
td
code
previewsmimg
td
em
string
td
The path to the branding package's preview image.
td
A file path.
td
code
/cPanel_magic_revision_1327526145/frontend/x3/branding/mobile/previewsm.jpg
tr
td
code
selectopt
td
em
string
td
A value that always returns 
code
selected
.
td
code
selected
 is the only possible value.
td
code
selected
tr
td
code
pkgchecked
td
em
string
td
Whether the account currently uses the branding package.
td
ul
li
code
checked
 — The account uses the package.
li
code
unchecked
 — The account does not use the package.
td
code
checked
tr
td
code
previewimg
td
em
string
td
span
The path to the branding package's preview image.
td
span
A file path.
td
code
/cPanel_magic_revision_1327526145/frontend/x3/branding/mobile/previewsm.jpg
tr
td
code
pkg
td
em
string
td
The branding package name.
td
A string value.
td
code
mobile
tr
td
code
selected
td
em
Boolean
td
A Boolean value that is always 
code
1
.
td
code
1
 is the only possible value.
td
code
1
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1