API:Get Clients

From WHMCS Documentation

This command is used to generate an XML list of clients

Attributes

limitstart - Which User ID to start at (default = 0)
limitnum - Limit by number (default = 25)

Example Command

$postfields["action"] = "getclients";

Returned Variables

Always returned in XML

<whmcsapi> 
 <action>getclients</action> 
 <result>success</result> 
 <totalresults>2</totalresults> 
 <startnumber>0</startnumber> 
 <numreturned>2</numreturned> 
 <clients> 
  <client> 
   <id>1</id> 
   <firstname><![CDATA[Test]]></firstname> 
   <lastname><![CDATA[Client]]></lastname> 
   <companyname><![CDATA[]]></companyname> 
   <email>fakeemail@domain.com</email> 
  </client> 
  <client> 
   <id>2</id> 
   <firstname><![CDATA[Test]]></firstname> 
   <lastname><![CDATA[Client2]]></lastname> 
   <companyname><![CDATA[]]></companyname> 
   <email>test@test.com</email> 
  </client> 
 </clients> 
</whmcsapi>