# Return Site Publisher websites' information

This function lists information for the cPanel account's Site Publisher websites.



  To retrieve the list of Site Publisher website information, the function queries the  file in each domain's document root. For more information, read our Guide to Site Publisher Templates documentation.



  When you disable the Web Server role, the system  this function.

Endpoint: GET /SiteTemplates/list_user_settings
Version: 11.134.0.5
Security: BasicAuth

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "list_user_settings"

  - `module` (string)
    The name of the module called.
    Example: "SiteTemplates"

  - `result` (object)

  - `result.data` (array)
    An array of objects containing each domain's site template information.

  - `result.data.documentroot` (string)
    The domain's absolute path to the directory's document root inside of the account's home directory.
    Example: "/home/example/public_html"

  - `result.data.domain` (string)
    The domain name.
    Example: "example.com"

  - `result.data.homedir` (string)
    The absolute path to the cPanel account's home directory.
    Example: "/home/example"

  - `result.data.serveralias` (array)
    A list of the domain's aliases.
    Example: ["www.example.com"]

  - `result.data.template_settings` (object)
    An object containing template settings.



This object also contains the user's website content. The template provider determines these values.
  * For information about the content for cPanel-provided templates, read our [Guide to Site Publisher Templates](https://go.cpanel.net/SitePublisherTemplates) documentation.
  * For more information about other templates, contact the template provider.

  - `result.data.template_settings.is_empty` (integer)
    Whether the domain's  file exists and contains template information.
*  — The  file exists and contains template information.
*  — The  file does not exist, or does not contain template information.
    Enum: 0, 1

  - `result.data.template_settings.path` (string)
    The template directory path.
*  — The  user's templates.
*  — A reseller's templates, where username represents the reseller's .
*  — cPanel-provided templates.
    Enum: "/var/cpanel/customizations/site_templates/", "/home/username/var/cpanel/reseller/site_templates/", "/usr/local/cpanel/3rdparty/share/site_templates/"

  - `result.data.template_settings.template` (string)
    The template's name as it appears in the  file.
    Example: "mytemplate"

  - `result.data.type` (string)
    The domain's type.
*  — The main domain.
*  — A subdomain.
    Enum: "main", "sub"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    *  — Success.
*  — Failed. Check the  field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.