Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - get_public_contact - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - get_public_contact
Skip to end of metadata
Go to start of metadata

Description

This function retrieves an account's public contact information.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_public_contact?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_public_contact?api.version=1
 Command Line
whmapi1 get_public_contact


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "name":"Bob's Hosting",
	"url":"https://bobshosting.com"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_public_contact"
  }
}
 Output (XML)
<result>
    <data>
	    <name>Bob's Hosting</name>
		<url>https://bobshosting.com</url>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_public_contact</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
namestring

The public contact name of the reseller.

The name of the reseller.

Bob's Hosting

url

sting

The public contact URL.

The URL of the reseller.

https://bobshosting.net