Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

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:

  • 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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 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

  • No labels