Return available themes

This function lists available themes.

Note:

The /usr/local/cpanel/scripts/modify_accounts script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation.

Authorizations:
query Parameters
show_mail_themes
integer
Default: 0

Whether to list the account's mail themes.

  • 1 — List mail themes.
  • 0 — Do not list mail themes.
Enum: 0 1
Example: show_mail_themes=1

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Themes list

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list",
  • "module": "Themes",
  • "result": {
    • "data": [
      • "paper_lantern"
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}