Log in Talk to an expert

getclients

area clientsaction getclientsGETread

This api returns a list of clients under the account. Also returns api key of client to allow to run API calls on their account

Arguments

ArgumentTypeRequiredDescription
startintegerNoStarting position in the query
limitintegerNoMax number of records that can be returned. Max value is 1000

Example request

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

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>

Need a call that isn't here?

Custom integration work is quoted on scope, and support is a person on weekdays, 9am to 5pm CST.

Talk to usBack to the API list