clients - getclients

API Call Information

area: clients

action: getclients

API Arguments

Argument	Data Type	Required	Description
`start`	integer	No	Starting position in the query
`limit`	integer	No	Max number of records that can be returned. Max value is 1000

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=clients&action=getclients&start=0&limit=10

API Response

XML Response

<response>

	<records>1</records>

	<client>

		<id>7027</id>

		<company>Demo Account</company>

		<autorenew>Yes</autorenew>

		<allowoverage>1</allowoverage>

		<enabled>1</enabled>

		<datecreated>March 13, 2019,  2:30 pm</datecreated>

		<reportingaccount>0</reportingaccount>

		<packagesize>1000</packagesize>

		<emailsentbillingperiod>0</emailsentbillingperiod>

		<apikey>myapikey</apikey>

		<primaryuserid>39</primaryuserid>

		<primaryuserusername>demologin</primaryuserusername>

		<primaryuserfirstname>System</primaryuserfirstname>

		<primaryuserlastname>Core</primaryuserlastname>

		<primaryuseremail>test@test.com</primaryuseremail>

		<perm_emailmarketing>1</perm_emailmarketing>

		<perm_listverify>1</perm_listverify>

		<perm_clients>1</perm_clients>

		<perm_leads>0</perm_leads>

		<perm_support>1</perm_support>

		<perm_smspeer/>

		<perm_api>1</perm_api>

	</client>

</response>

JSON Response

{
    "records": "1",
    "client": {
        "id": "7027",
        "company": "Demo Account",
        "autorenew": "Yes",
        "allowoverage": "1",
        "enabled": "1",
        "datecreated": "March 13, 2019,  2:30 pm",
        "reportingaccount": "0",
        "packagesize": "1000",
        "emailsentbillingperiod": "0",
        "apikey": "myapikey",
        "primaryuserid": "39",
        "primaryuserusername": "demologin",
        "primaryuserfirstname": "System",
        "primaryuserlastname": "Core",
        "primaryuseremail": "test@test.com",
        "perm_emailmarketing": "1",
        "perm_listverify": "1",
        "perm_clients": "1",
        "perm_leads": "0",
        "perm_support": "1",
        "perm_smspeer": "",
        "perm_api": "1"
    }
}